1. Packages
  2. AWS Native
  3. API Docs
  4. pipes
  5. Pipe

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.pipes.Pipe

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Definition of AWS::Pipes::Pipe Resource Type

    Example Usage

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var testPipe = new AwsNative.Pipes.Pipe("testPipe", new()
        {
            Name = "PipeCfnExample",
            RoleArn = "arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role",
            Source = "arn:aws:sqs:us-east-1:123456789123:pipeDemoSource",
            Enrichment = "arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets",
            Target = "arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/pipes"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := pipes.NewPipe(ctx, "testPipe", &pipes.PipeArgs{
    			Name:       pulumi.String("PipeCfnExample"),
    			RoleArn:    pulumi.String("arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role"),
    			Source:     pulumi.String("arn:aws:sqs:us-east-1:123456789123:pipeDemoSource"),
    			Enrichment: pulumi.String("arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets"),
    			Target:     pulumi.String("arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    test_pipe = aws_native.pipes.Pipe("testPipe",
        name="PipeCfnExample",
        role_arn="arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role",
        source="arn:aws:sqs:us-east-1:123456789123:pipeDemoSource",
        enrichment="arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets",
        target="arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const testPipe = new aws_native.pipes.Pipe("testPipe", {
        name: "PipeCfnExample",
        roleArn: "arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role",
        source: "arn:aws:sqs:us-east-1:123456789123:pipeDemoSource",
        enrichment: "arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets",
        target: "arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine",
    });
    

    Coming soon!

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var testPipe = new AwsNative.Pipes.Pipe("testPipe", new()
        {
            Name = "PipeCfnExample",
            RoleArn = "arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role",
            Source = "arn:aws:sqs:us-east-1:123456789123:pipeDemoSource",
            Enrichment = "arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets",
            Target = "arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/pipes"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := pipes.NewPipe(ctx, "testPipe", &pipes.PipeArgs{
    			Name:       pulumi.String("PipeCfnExample"),
    			RoleArn:    pulumi.String("arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role"),
    			Source:     pulumi.String("arn:aws:sqs:us-east-1:123456789123:pipeDemoSource"),
    			Enrichment: pulumi.String("arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets"),
    			Target:     pulumi.String("arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    test_pipe = aws_native.pipes.Pipe("testPipe",
        name="PipeCfnExample",
        role_arn="arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role",
        source="arn:aws:sqs:us-east-1:123456789123:pipeDemoSource",
        enrichment="arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets",
        target="arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const testPipe = new aws_native.pipes.Pipe("testPipe", {
        name: "PipeCfnExample",
        roleArn: "arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role",
        source: "arn:aws:sqs:us-east-1:123456789123:pipeDemoSource",
        enrichment: "arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets",
        target: "arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine",
    });
    

    Coming soon!

    Create Pipe Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Pipe(name: string, args: PipeArgs, opts?: CustomResourceOptions);
    @overload
    def Pipe(resource_name: str,
             args: PipeArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Pipe(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             role_arn: Optional[str] = None,
             source: Optional[str] = None,
             target: Optional[str] = None,
             description: Optional[str] = None,
             desired_state: Optional[PipeRequestedPipeState] = None,
             enrichment: Optional[str] = None,
             enrichment_parameters: Optional[PipeEnrichmentParametersArgs] = None,
             log_configuration: Optional[PipeLogConfigurationArgs] = None,
             name: Optional[str] = None,
             source_parameters: Optional[PipeSourceParametersArgs] = None,
             tags: Optional[Mapping[str, str]] = None,
             target_parameters: Optional[PipeTargetParametersArgs] = None)
    func NewPipe(ctx *Context, name string, args PipeArgs, opts ...ResourceOption) (*Pipe, error)
    public Pipe(string name, PipeArgs args, CustomResourceOptions? opts = null)
    public Pipe(String name, PipeArgs args)
    public Pipe(String name, PipeArgs args, CustomResourceOptions options)
    
    type: aws-native:pipes:Pipe
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PipeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PipeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PipeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const pipeResource = new aws_native.pipes.Pipe("pipeResource", {
        roleArn: "string",
        source: "string",
        target: "string",
        description: "string",
        desiredState: aws_native.pipes.PipeRequestedPipeState.Running,
        enrichment: "string",
        enrichmentParameters: {
            httpParameters: {
                headerParameters: {
                    string: "string",
                },
                pathParameterValues: ["string"],
                queryStringParameters: {
                    string: "string",
                },
            },
            inputTemplate: "string",
        },
        logConfiguration: {
            cloudwatchLogsLogDestination: {
                logGroupArn: "string",
            },
            firehoseLogDestination: {
                deliveryStreamArn: "string",
            },
            includeExecutionData: [aws_native.pipes.PipeIncludeExecutionDataOption.All],
            level: aws_native.pipes.PipeLogLevel.Off,
            s3LogDestination: {
                bucketName: "string",
                bucketOwner: "string",
                outputFormat: aws_native.pipes.PipeS3OutputFormat.Json,
                prefix: "string",
            },
        },
        name: "string",
        sourceParameters: {
            activeMqBrokerParameters: {
                credentials: {
                    basicAuth: "string",
                },
                queueName: "string",
                batchSize: 0,
                maximumBatchingWindowInSeconds: 0,
            },
            dynamoDbStreamParameters: {
                startingPosition: aws_native.pipes.PipeDynamoDbStreamStartPosition.TrimHorizon,
                batchSize: 0,
                deadLetterConfig: {
                    arn: "string",
                },
                maximumBatchingWindowInSeconds: 0,
                maximumRecordAgeInSeconds: 0,
                maximumRetryAttempts: 0,
                onPartialBatchItemFailure: aws_native.pipes.PipeOnPartialBatchItemFailureStreams.AutomaticBisect,
                parallelizationFactor: 0,
            },
            filterCriteria: {
                filters: [{
                    pattern: "string",
                }],
            },
            kinesisStreamParameters: {
                startingPosition: aws_native.pipes.PipeKinesisStreamStartPosition.TrimHorizon,
                batchSize: 0,
                deadLetterConfig: {
                    arn: "string",
                },
                maximumBatchingWindowInSeconds: 0,
                maximumRecordAgeInSeconds: 0,
                maximumRetryAttempts: 0,
                onPartialBatchItemFailure: aws_native.pipes.PipeOnPartialBatchItemFailureStreams.AutomaticBisect,
                parallelizationFactor: 0,
                startingPositionTimestamp: "string",
            },
            managedStreamingKafkaParameters: {
                topicName: "string",
                batchSize: 0,
                consumerGroupId: "string",
                credentials: {
                    saslScram512Auth: "string",
                },
                maximumBatchingWindowInSeconds: 0,
                startingPosition: aws_native.pipes.PipeMskStartPosition.TrimHorizon,
            },
            rabbitMqBrokerParameters: {
                credentials: {
                    basicAuth: "string",
                },
                queueName: "string",
                batchSize: 0,
                maximumBatchingWindowInSeconds: 0,
                virtualHost: "string",
            },
            selfManagedKafkaParameters: {
                topicName: "string",
                additionalBootstrapServers: ["string"],
                batchSize: 0,
                consumerGroupId: "string",
                credentials: {
                    basicAuth: "string",
                },
                maximumBatchingWindowInSeconds: 0,
                serverRootCaCertificate: "string",
                startingPosition: aws_native.pipes.PipeSelfManagedKafkaStartPosition.TrimHorizon,
                vpc: {
                    securityGroup: ["string"],
                    subnets: ["string"],
                },
            },
            sqsQueueParameters: {
                batchSize: 0,
                maximumBatchingWindowInSeconds: 0,
            },
        },
        tags: {
            string: "string",
        },
        targetParameters: {
            batchJobParameters: {
                jobDefinition: "string",
                jobName: "string",
                arrayProperties: {
                    size: 0,
                },
                containerOverrides: {
                    command: ["string"],
                    environment: [{
                        name: "string",
                        value: "string",
                    }],
                    instanceType: "string",
                    resourceRequirements: [{
                        type: aws_native.pipes.PipeBatchResourceRequirementType.Gpu,
                        value: "string",
                    }],
                },
                dependsOn: [{
                    jobId: "string",
                    type: aws_native.pipes.PipeBatchJobDependencyType.NToN,
                }],
                parameters: {
                    string: "string",
                },
                retryStrategy: {
                    attempts: 0,
                },
            },
            cloudWatchLogsParameters: {
                logStreamName: "string",
                timestamp: "string",
            },
            ecsTaskParameters: {
                taskDefinitionArn: "string",
                overrides: {
                    containerOverrides: [{
                        command: ["string"],
                        cpu: 0,
                        environment: [{
                            name: "string",
                            value: "string",
                        }],
                        environmentFiles: [{
                            type: aws_native.pipes.PipeEcsEnvironmentFileType.S3,
                            value: "string",
                        }],
                        memory: 0,
                        memoryReservation: 0,
                        name: "string",
                        resourceRequirements: [{
                            type: aws_native.pipes.PipeEcsResourceRequirementType.Gpu,
                            value: "string",
                        }],
                    }],
                    cpu: "string",
                    ephemeralStorage: {
                        sizeInGiB: 0,
                    },
                    executionRoleArn: "string",
                    inferenceAcceleratorOverrides: [{
                        deviceName: "string",
                        deviceType: "string",
                    }],
                    memory: "string",
                    taskRoleArn: "string",
                },
                placementStrategy: [{
                    field: "string",
                    type: aws_native.pipes.PipePlacementStrategyType.Random,
                }],
                group: "string",
                launchType: aws_native.pipes.PipeLaunchType.Ec2,
                networkConfiguration: {
                    awsvpcConfiguration: {
                        subnets: ["string"],
                        assignPublicIp: aws_native.pipes.PipeAssignPublicIp.Enabled,
                        securityGroups: ["string"],
                    },
                },
                capacityProviderStrategy: [{
                    capacityProvider: "string",
                    base: 0,
                    weight: 0,
                }],
                placementConstraints: [{
                    expression: "string",
                    type: aws_native.pipes.PipePlacementConstraintType.DistinctInstance,
                }],
                enableExecuteCommand: false,
                platformVersion: "string",
                propagateTags: aws_native.pipes.PipePropagateTags.TaskDefinition,
                referenceId: "string",
                tags: [{
                    key: "string",
                    value: "string",
                }],
                taskCount: 0,
                enableEcsManagedTags: false,
            },
            eventBridgeEventBusParameters: {
                detailType: "string",
                endpointId: "string",
                resources: ["string"],
                source: "string",
                time: "string",
            },
            httpParameters: {
                headerParameters: {
                    string: "string",
                },
                pathParameterValues: ["string"],
                queryStringParameters: {
                    string: "string",
                },
            },
            inputTemplate: "string",
            kinesisStreamParameters: {
                partitionKey: "string",
            },
            lambdaFunctionParameters: {
                invocationType: aws_native.pipes.PipeTargetInvocationType.RequestResponse,
            },
            redshiftDataParameters: {
                database: "string",
                sqls: ["string"],
                dbUser: "string",
                secretManagerArn: "string",
                statementName: "string",
                withEvent: false,
            },
            sageMakerPipelineParameters: {
                pipelineParameterList: [{
                    name: "string",
                    value: "string",
                }],
            },
            sqsQueueParameters: {
                messageDeduplicationId: "string",
                messageGroupId: "string",
            },
            stepFunctionStateMachineParameters: {
                invocationType: aws_native.pipes.PipeTargetInvocationType.RequestResponse,
            },
        },
    });
    
    Coming soon!
    

    Pipe Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Pipe resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Pipe resource produces the following output properties:

    Arn string
    CreationTime string
    CurrentState Pulumi.AwsNative.Pipes.PipeState
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    StateReason string
    Arn string
    CreationTime string
    CurrentState PipeStateEnum
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    StateReason string
    arn String
    creationTime String
    currentState PipeState
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    stateReason String
    arn string
    creationTime string
    currentState PipeState
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    stateReason string
    arn str
    creation_time str
    current_state PipeState
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_time str
    state_reason str

    Supporting Types

    PipeAssignPublicIp, PipeAssignPublicIpArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    PipeAssignPublicIpEnabled
    ENABLED
    PipeAssignPublicIpDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    PipeAwsVpcConfiguration, PipeAwsVpcConfigurationArgs

    PipeBatchArrayProperties, PipeBatchArrayPropertiesArgs

    Size int
    Size int
    size Integer
    size number
    size int
    size Number

    PipeBatchContainerOverrides, PipeBatchContainerOverridesArgs

    PipeBatchEnvironmentVariable, PipeBatchEnvironmentVariableArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    PipeBatchJobDependency, PipeBatchJobDependencyArgs

    PipeBatchJobDependencyType, PipeBatchJobDependencyTypeArgs

    NToN
    N_TO_N
    Sequential
    SEQUENTIAL
    PipeBatchJobDependencyTypeNToN
    N_TO_N
    PipeBatchJobDependencyTypeSequential
    SEQUENTIAL
    NToN
    N_TO_N
    Sequential
    SEQUENTIAL
    NToN
    N_TO_N
    Sequential
    SEQUENTIAL
    N_TO_N
    N_TO_N
    SEQUENTIAL
    SEQUENTIAL
    "N_TO_N"
    N_TO_N
    "SEQUENTIAL"
    SEQUENTIAL

    PipeBatchResourceRequirement, PipeBatchResourceRequirementArgs

    PipeBatchResourceRequirementType, PipeBatchResourceRequirementTypeArgs

    Gpu
    GPU
    Memory
    MEMORY
    Vcpu
    VCPU
    PipeBatchResourceRequirementTypeGpu
    GPU
    PipeBatchResourceRequirementTypeMemory
    MEMORY
    PipeBatchResourceRequirementTypeVcpu
    VCPU
    Gpu
    GPU
    Memory
    MEMORY
    Vcpu
    VCPU
    Gpu
    GPU
    Memory
    MEMORY
    Vcpu
    VCPU
    GPU
    GPU
    MEMORY
    MEMORY
    VCPU
    VCPU
    "GPU"
    GPU
    "MEMORY"
    MEMORY
    "VCPU"
    VCPU

    PipeBatchRetryStrategy, PipeBatchRetryStrategyArgs

    attempts Integer
    attempts number
    attempts Number

    PipeCapacityProviderStrategyItem, PipeCapacityProviderStrategyItemArgs

    capacityProvider String
    base Integer
    weight Integer
    capacityProvider string
    base number
    weight number
    capacityProvider String
    base Number
    weight Number

    PipeCloudwatchLogsLogDestination, PipeCloudwatchLogsLogDestinationArgs

    PipeDeadLetterConfig, PipeDeadLetterConfigArgs

    Arn string
    Arn string
    arn String
    arn string
    arn str
    arn String

    PipeDynamoDbStreamStartPosition, PipeDynamoDbStreamStartPositionArgs

    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    PipeDynamoDbStreamStartPositionTrimHorizon
    TRIM_HORIZON
    PipeDynamoDbStreamStartPositionLatest
    LATEST
    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    TRIM_HORIZON
    TRIM_HORIZON
    LATEST
    LATEST
    "TRIM_HORIZON"
    TRIM_HORIZON
    "LATEST"
    LATEST

    PipeEcsContainerOverride, PipeEcsContainerOverrideArgs

    PipeEcsEnvironmentFile, PipeEcsEnvironmentFileArgs

    PipeEcsEnvironmentFileType, PipeEcsEnvironmentFileTypeArgs

    S3
    s3
    PipeEcsEnvironmentFileTypeS3
    s3
    S3
    s3
    S3
    s3
    S3
    s3
    "s3"
    s3

    PipeEcsEnvironmentVariable, PipeEcsEnvironmentVariableArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    PipeEcsEphemeralStorage, PipeEcsEphemeralStorageArgs

    sizeInGiB Integer
    sizeInGiB number
    sizeInGiB Number

    PipeEcsInferenceAcceleratorOverride, PipeEcsInferenceAcceleratorOverrideArgs

    DeviceName string
    DeviceType string
    DeviceName string
    DeviceType string
    deviceName String
    deviceType String
    deviceName string
    deviceType string
    deviceName String
    deviceType String

    PipeEcsResourceRequirement, PipeEcsResourceRequirementArgs

    PipeEcsResourceRequirementType, PipeEcsResourceRequirementTypeArgs

    Gpu
    GPU
    InferenceAccelerator
    InferenceAccelerator
    PipeEcsResourceRequirementTypeGpu
    GPU
    PipeEcsResourceRequirementTypeInferenceAccelerator
    InferenceAccelerator
    Gpu
    GPU
    InferenceAccelerator
    InferenceAccelerator
    Gpu
    GPU
    InferenceAccelerator
    InferenceAccelerator
    GPU
    GPU
    INFERENCE_ACCELERATOR
    InferenceAccelerator
    "GPU"
    GPU
    "InferenceAccelerator"
    InferenceAccelerator

    PipeEcsTaskOverride, PipeEcsTaskOverrideArgs

    PipeEnrichmentHttpParameters, PipeEnrichmentHttpParametersArgs

    HeaderParameters Dictionary<string, string>
    PathParameterValues List<string>
    QueryStringParameters Dictionary<string, string>
    HeaderParameters map[string]string
    PathParameterValues []string
    QueryStringParameters map[string]string
    headerParameters Map<String,String>
    pathParameterValues List<String>
    queryStringParameters Map<String,String>
    headerParameters {[key: string]: string}
    pathParameterValues string[]
    queryStringParameters {[key: string]: string}
    header_parameters Mapping[str, str]
    path_parameter_values Sequence[str]
    query_string_parameters Mapping[str, str]

    PipeEnrichmentParameters, PipeEnrichmentParametersArgs

    PipeFilter, PipeFilterArgs

    Pattern string
    Pattern string
    pattern String
    pattern string
    pattern String

    PipeFilterCriteria, PipeFilterCriteriaArgs

    PipeFirehoseLogDestination, PipeFirehoseLogDestinationArgs

    PipeIncludeExecutionDataOption, PipeIncludeExecutionDataOptionArgs

    All
    ALL
    PipeIncludeExecutionDataOptionAll
    ALL
    All
    ALL
    All
    ALL
    ALL
    ALL
    "ALL"
    ALL

    PipeKinesisStreamStartPosition, PipeKinesisStreamStartPositionArgs

    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    AtTimestamp
    AT_TIMESTAMP
    PipeKinesisStreamStartPositionTrimHorizon
    TRIM_HORIZON
    PipeKinesisStreamStartPositionLatest
    LATEST
    PipeKinesisStreamStartPositionAtTimestamp
    AT_TIMESTAMP
    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    AtTimestamp
    AT_TIMESTAMP
    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    AtTimestamp
    AT_TIMESTAMP
    TRIM_HORIZON
    TRIM_HORIZON
    LATEST
    LATEST
    AT_TIMESTAMP
    AT_TIMESTAMP
    "TRIM_HORIZON"
    TRIM_HORIZON
    "LATEST"
    LATEST
    "AT_TIMESTAMP"
    AT_TIMESTAMP

    PipeLaunchType, PipeLaunchTypeArgs

    Ec2
    EC2
    Fargate
    FARGATE
    External
    EXTERNAL
    PipeLaunchTypeEc2
    EC2
    PipeLaunchTypeFargate
    FARGATE
    PipeLaunchTypeExternal
    EXTERNAL
    Ec2
    EC2
    Fargate
    FARGATE
    External
    EXTERNAL
    Ec2
    EC2
    Fargate
    FARGATE
    External
    EXTERNAL
    EC2
    EC2
    FARGATE
    FARGATE
    EXTERNAL
    EXTERNAL
    "EC2"
    EC2
    "FARGATE"
    FARGATE
    "EXTERNAL"
    EXTERNAL

    PipeLogConfiguration, PipeLogConfigurationArgs

    PipeLogLevel, PipeLogLevelArgs

    Off
    OFF
    Error
    ERROR
    Info
    INFO
    Trace
    TRACE
    PipeLogLevelOff
    OFF
    PipeLogLevelError
    ERROR
    PipeLogLevelInfo
    INFO
    PipeLogLevelTrace
    TRACE
    Off
    OFF
    Error
    ERROR
    Info
    INFO
    Trace
    TRACE
    Off
    OFF
    Error
    ERROR
    Info
    INFO
    Trace
    TRACE
    OFF
    OFF
    ERROR
    ERROR
    INFO
    INFO
    TRACE
    TRACE
    "OFF"
    OFF
    "ERROR"
    ERROR
    "INFO"
    INFO
    "TRACE"
    TRACE

    PipeMqBrokerAccessCredentialsProperties, PipeMqBrokerAccessCredentialsPropertiesArgs

    BasicAuth string
    Optional SecretManager ARN which stores the database credentials
    BasicAuth string
    Optional SecretManager ARN which stores the database credentials
    basicAuth String
    Optional SecretManager ARN which stores the database credentials
    basicAuth string
    Optional SecretManager ARN which stores the database credentials
    basic_auth str
    Optional SecretManager ARN which stores the database credentials
    basicAuth String
    Optional SecretManager ARN which stores the database credentials

    PipeMskAccessCredentials0Properties, PipeMskAccessCredentials0PropertiesArgs

    SaslScram512Auth string
    Optional SecretManager ARN which stores the database credentials
    SaslScram512Auth string
    Optional SecretManager ARN which stores the database credentials
    saslScram512Auth String
    Optional SecretManager ARN which stores the database credentials
    saslScram512Auth string
    Optional SecretManager ARN which stores the database credentials
    sasl_scram512_auth str
    Optional SecretManager ARN which stores the database credentials
    saslScram512Auth String
    Optional SecretManager ARN which stores the database credentials

    PipeMskAccessCredentials1Properties, PipeMskAccessCredentials1PropertiesArgs

    ClientCertificateTlsAuth string
    Optional SecretManager ARN which stores the database credentials
    ClientCertificateTlsAuth string
    Optional SecretManager ARN which stores the database credentials
    clientCertificateTlsAuth String
    Optional SecretManager ARN which stores the database credentials
    clientCertificateTlsAuth string
    Optional SecretManager ARN which stores the database credentials
    client_certificate_tls_auth str
    Optional SecretManager ARN which stores the database credentials
    clientCertificateTlsAuth String
    Optional SecretManager ARN which stores the database credentials

    PipeMskStartPosition, PipeMskStartPositionArgs

    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    PipeMskStartPositionTrimHorizon
    TRIM_HORIZON
    PipeMskStartPositionLatest
    LATEST
    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    TRIM_HORIZON
    TRIM_HORIZON
    LATEST
    LATEST
    "TRIM_HORIZON"
    TRIM_HORIZON
    "LATEST"
    LATEST

    PipeNetworkConfiguration, PipeNetworkConfigurationArgs

    PipeOnPartialBatchItemFailureStreams, PipeOnPartialBatchItemFailureStreamsArgs

    AutomaticBisect
    AUTOMATIC_BISECT
    PipeOnPartialBatchItemFailureStreamsAutomaticBisect
    AUTOMATIC_BISECT
    AutomaticBisect
    AUTOMATIC_BISECT
    AutomaticBisect
    AUTOMATIC_BISECT
    AUTOMATIC_BISECT
    AUTOMATIC_BISECT
    "AUTOMATIC_BISECT"
    AUTOMATIC_BISECT

    PipePlacementConstraint, PipePlacementConstraintArgs

    PipePlacementConstraintType, PipePlacementConstraintTypeArgs

    DistinctInstance
    distinctInstance
    MemberOf
    memberOf
    PipePlacementConstraintTypeDistinctInstance
    distinctInstance
    PipePlacementConstraintTypeMemberOf
    memberOf
    DistinctInstance
    distinctInstance
    MemberOf
    memberOf
    DistinctInstance
    distinctInstance
    MemberOf
    memberOf
    DISTINCT_INSTANCE
    distinctInstance
    MEMBER_OF
    memberOf
    "distinctInstance"
    distinctInstance
    "memberOf"
    memberOf

    PipePlacementStrategy, PipePlacementStrategyArgs

    PipePlacementStrategyType, PipePlacementStrategyTypeArgs

    Random
    random
    Spread
    spread
    Binpack
    binpack
    PipePlacementStrategyTypeRandom
    random
    PipePlacementStrategyTypeSpread
    spread
    PipePlacementStrategyTypeBinpack
    binpack
    Random
    random
    Spread
    spread
    Binpack
    binpack
    Random
    random
    Spread
    spread
    Binpack
    binpack
    RANDOM
    random
    SPREAD
    spread
    BINPACK
    binpack
    "random"
    random
    "spread"
    spread
    "binpack"
    binpack

    PipePropagateTags, PipePropagateTagsArgs

    TaskDefinition
    TASK_DEFINITION
    PipePropagateTagsTaskDefinition
    TASK_DEFINITION
    TaskDefinition
    TASK_DEFINITION
    TaskDefinition
    TASK_DEFINITION
    TASK_DEFINITION
    TASK_DEFINITION
    "TASK_DEFINITION"
    TASK_DEFINITION

    PipeRequestedPipeState, PipeRequestedPipeStateArgs

    Running
    RUNNING
    Stopped
    STOPPED
    PipeRequestedPipeStateRunning
    RUNNING
    PipeRequestedPipeStateStopped
    STOPPED
    Running
    RUNNING
    Stopped
    STOPPED
    Running
    RUNNING
    Stopped
    STOPPED
    RUNNING
    RUNNING
    STOPPED
    STOPPED
    "RUNNING"
    RUNNING
    "STOPPED"
    STOPPED

    PipeS3LogDestination, PipeS3LogDestinationArgs

    PipeS3OutputFormat, PipeS3OutputFormatArgs

    Json
    json
    Plain
    plain
    W3c
    w3c
    PipeS3OutputFormatJson
    json
    PipeS3OutputFormatPlain
    plain
    PipeS3OutputFormatW3c
    w3c
    Json
    json
    Plain
    plain
    W3c
    w3c
    Json
    json
    Plain
    plain
    W3c
    w3c
    JSON
    json
    PLAIN
    plain
    W3C
    w3c
    "json"
    json
    "plain"
    plain
    "w3c"
    w3c

    PipeSageMakerPipelineParameter, PipeSageMakerPipelineParameterArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    PipeSelfManagedKafkaAccessConfigurationCredentials0Properties, PipeSelfManagedKafkaAccessConfigurationCredentials0PropertiesArgs

    BasicAuth string
    Optional SecretManager ARN which stores the database credentials
    BasicAuth string
    Optional SecretManager ARN which stores the database credentials
    basicAuth String
    Optional SecretManager ARN which stores the database credentials
    basicAuth string
    Optional SecretManager ARN which stores the database credentials
    basic_auth str
    Optional SecretManager ARN which stores the database credentials
    basicAuth String
    Optional SecretManager ARN which stores the database credentials

    PipeSelfManagedKafkaAccessConfigurationCredentials1Properties, PipeSelfManagedKafkaAccessConfigurationCredentials1PropertiesArgs

    SaslScram512Auth string
    Optional SecretManager ARN which stores the database credentials
    SaslScram512Auth string
    Optional SecretManager ARN which stores the database credentials
    saslScram512Auth String
    Optional SecretManager ARN which stores the database credentials
    saslScram512Auth string
    Optional SecretManager ARN which stores the database credentials
    sasl_scram512_auth str
    Optional SecretManager ARN which stores the database credentials
    saslScram512Auth String
    Optional SecretManager ARN which stores the database credentials

    PipeSelfManagedKafkaAccessConfigurationCredentials2Properties, PipeSelfManagedKafkaAccessConfigurationCredentials2PropertiesArgs

    SaslScram256Auth string
    Optional SecretManager ARN which stores the database credentials
    SaslScram256Auth string
    Optional SecretManager ARN which stores the database credentials
    saslScram256Auth String
    Optional SecretManager ARN which stores the database credentials
    saslScram256Auth string
    Optional SecretManager ARN which stores the database credentials
    sasl_scram256_auth str
    Optional SecretManager ARN which stores the database credentials
    saslScram256Auth String
    Optional SecretManager ARN which stores the database credentials

    PipeSelfManagedKafkaAccessConfigurationCredentials3Properties, PipeSelfManagedKafkaAccessConfigurationCredentials3PropertiesArgs

    ClientCertificateTlsAuth string
    Optional SecretManager ARN which stores the database credentials
    ClientCertificateTlsAuth string
    Optional SecretManager ARN which stores the database credentials
    clientCertificateTlsAuth String
    Optional SecretManager ARN which stores the database credentials
    clientCertificateTlsAuth string
    Optional SecretManager ARN which stores the database credentials
    client_certificate_tls_auth str
    Optional SecretManager ARN which stores the database credentials
    clientCertificateTlsAuth String
    Optional SecretManager ARN which stores the database credentials

    PipeSelfManagedKafkaAccessConfigurationVpc, PipeSelfManagedKafkaAccessConfigurationVpcArgs

    SecurityGroup List<string>
    List of SecurityGroupId.
    Subnets List<string>
    List of SubnetId.
    SecurityGroup []string
    List of SecurityGroupId.
    Subnets []string
    List of SubnetId.
    securityGroup List<String>
    List of SecurityGroupId.
    subnets List<String>
    List of SubnetId.
    securityGroup string[]
    List of SecurityGroupId.
    subnets string[]
    List of SubnetId.
    security_group Sequence[str]
    List of SecurityGroupId.
    subnets Sequence[str]
    List of SubnetId.
    securityGroup List<String>
    List of SecurityGroupId.
    subnets List<String>
    List of SubnetId.

    PipeSelfManagedKafkaStartPosition, PipeSelfManagedKafkaStartPositionArgs

    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    PipeSelfManagedKafkaStartPositionTrimHorizon
    TRIM_HORIZON
    PipeSelfManagedKafkaStartPositionLatest
    LATEST
    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    TrimHorizon
    TRIM_HORIZON
    Latest
    LATEST
    TRIM_HORIZON
    TRIM_HORIZON
    LATEST
    LATEST
    "TRIM_HORIZON"
    TRIM_HORIZON
    "LATEST"
    LATEST

    PipeSourceActiveMqBrokerParameters, PipeSourceActiveMqBrokerParametersArgs

    PipeSourceDynamoDbStreamParameters, PipeSourceDynamoDbStreamParametersArgs

    PipeSourceKinesisStreamParameters, PipeSourceKinesisStreamParametersArgs

    PipeSourceManagedStreamingKafkaParameters, PipeSourceManagedStreamingKafkaParametersArgs

    PipeSourceParameters, PipeSourceParametersArgs

    PipeSourceRabbitMqBrokerParameters, PipeSourceRabbitMqBrokerParametersArgs

    PipeSourceSelfManagedKafkaParameters, PipeSourceSelfManagedKafkaParametersArgs

    PipeSourceSqsQueueParameters, PipeSourceSqsQueueParametersArgs

    PipeState, PipeStateArgs

    Running
    RUNNING
    Stopped
    STOPPED
    Creating
    CREATING
    Updating
    UPDATING
    Deleting
    DELETING
    Starting
    STARTING
    Stopping
    STOPPING
    CreateFailed
    CREATE_FAILED
    UpdateFailed
    UPDATE_FAILED
    StartFailed
    START_FAILED
    StopFailed
    STOP_FAILED
    DeleteFailed
    DELETE_FAILED
    CreateRollbackFailed
    CREATE_ROLLBACK_FAILED
    DeleteRollbackFailed
    DELETE_ROLLBACK_FAILED
    UpdateRollbackFailed
    UPDATE_ROLLBACK_FAILED
    PipeStateRunning
    RUNNING
    PipeStateStopped
    STOPPED
    PipeStateCreating
    CREATING
    PipeStateUpdating
    UPDATING
    PipeStateDeleting
    DELETING
    PipeStateStarting
    STARTING
    PipeStateStopping
    STOPPING
    PipeStateCreateFailed
    CREATE_FAILED
    PipeStateUpdateFailed
    UPDATE_FAILED
    PipeStateStartFailed
    START_FAILED
    PipeStateStopFailed
    STOP_FAILED
    PipeStateDeleteFailed
    DELETE_FAILED
    PipeStateCreateRollbackFailed
    CREATE_ROLLBACK_FAILED
    PipeStateDeleteRollbackFailed
    DELETE_ROLLBACK_FAILED
    PipeStateUpdateRollbackFailed
    UPDATE_ROLLBACK_FAILED
    Running
    RUNNING
    Stopped
    STOPPED
    Creating
    CREATING
    Updating
    UPDATING
    Deleting
    DELETING
    Starting
    STARTING
    Stopping
    STOPPING
    CreateFailed
    CREATE_FAILED
    UpdateFailed
    UPDATE_FAILED
    StartFailed
    START_FAILED
    StopFailed
    STOP_FAILED
    DeleteFailed
    DELETE_FAILED
    CreateRollbackFailed
    CREATE_ROLLBACK_FAILED
    DeleteRollbackFailed
    DELETE_ROLLBACK_FAILED
    UpdateRollbackFailed
    UPDATE_ROLLBACK_FAILED
    Running
    RUNNING
    Stopped
    STOPPED
    Creating
    CREATING
    Updating
    UPDATING
    Deleting
    DELETING
    Starting
    STARTING
    Stopping
    STOPPING
    CreateFailed
    CREATE_FAILED
    UpdateFailed
    UPDATE_FAILED
    StartFailed
    START_FAILED
    StopFailed
    STOP_FAILED
    DeleteFailed
    DELETE_FAILED
    CreateRollbackFailed
    CREATE_ROLLBACK_FAILED
    DeleteRollbackFailed
    DELETE_ROLLBACK_FAILED
    UpdateRollbackFailed
    UPDATE_ROLLBACK_FAILED
    RUNNING
    RUNNING
    STOPPED
    STOPPED
    CREATING
    CREATING
    UPDATING
    UPDATING
    DELETING
    DELETING
    STARTING
    STARTING
    STOPPING
    STOPPING
    CREATE_FAILED
    CREATE_FAILED
    UPDATE_FAILED
    UPDATE_FAILED
    START_FAILED
    START_FAILED
    STOP_FAILED
    STOP_FAILED
    DELETE_FAILED
    DELETE_FAILED
    CREATE_ROLLBACK_FAILED
    CREATE_ROLLBACK_FAILED
    DELETE_ROLLBACK_FAILED
    DELETE_ROLLBACK_FAILED
    UPDATE_ROLLBACK_FAILED
    UPDATE_ROLLBACK_FAILED
    "RUNNING"
    RUNNING
    "STOPPED"
    STOPPED
    "CREATING"
    CREATING
    "UPDATING"
    UPDATING
    "DELETING"
    DELETING
    "STARTING"
    STARTING
    "STOPPING"
    STOPPING
    "CREATE_FAILED"
    CREATE_FAILED
    "UPDATE_FAILED"
    UPDATE_FAILED
    "START_FAILED"
    START_FAILED
    "STOP_FAILED"
    STOP_FAILED
    "DELETE_FAILED"
    DELETE_FAILED
    "CREATE_ROLLBACK_FAILED"
    CREATE_ROLLBACK_FAILED
    "DELETE_ROLLBACK_FAILED"
    DELETE_ROLLBACK_FAILED
    "UPDATE_ROLLBACK_FAILED"
    UPDATE_ROLLBACK_FAILED

    PipeTag, PipeTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    PipeTargetBatchJobParameters, PipeTargetBatchJobParametersArgs

    PipeTargetCloudWatchLogsParameters, PipeTargetCloudWatchLogsParametersArgs

    PipeTargetEcsTaskParameters, PipeTargetEcsTaskParametersArgs

    PipeTargetEventBridgeEventBusParameters, PipeTargetEventBridgeEventBusParametersArgs

    DetailType string
    EndpointId string
    Resources List<string>
    Source string
    Time string
    DetailType string
    EndpointId string
    Resources []string
    Source string
    Time string
    detailType String
    endpointId String
    resources List<String>
    source String
    time String
    detailType string
    endpointId string
    resources string[]
    source string
    time string
    detail_type str
    endpoint_id str
    resources Sequence[str]
    source str
    time str
    detailType String
    endpointId String
    resources List<String>
    source String
    time String

    PipeTargetHttpParameters, PipeTargetHttpParametersArgs

    HeaderParameters Dictionary<string, string>
    PathParameterValues List<string>
    QueryStringParameters Dictionary<string, string>
    HeaderParameters map[string]string
    PathParameterValues []string
    QueryStringParameters map[string]string
    headerParameters Map<String,String>
    pathParameterValues List<String>
    queryStringParameters Map<String,String>
    headerParameters {[key: string]: string}
    pathParameterValues string[]
    queryStringParameters {[key: string]: string}
    header_parameters Mapping[str, str]
    path_parameter_values Sequence[str]
    query_string_parameters Mapping[str, str]

    PipeTargetInvocationType, PipeTargetInvocationTypeArgs

    RequestResponse
    REQUEST_RESPONSE
    FireAndForget
    FIRE_AND_FORGET
    PipeTargetInvocationTypeRequestResponse
    REQUEST_RESPONSE
    PipeTargetInvocationTypeFireAndForget
    FIRE_AND_FORGET
    RequestResponse
    REQUEST_RESPONSE
    FireAndForget
    FIRE_AND_FORGET
    RequestResponse
    REQUEST_RESPONSE
    FireAndForget
    FIRE_AND_FORGET
    REQUEST_RESPONSE
    REQUEST_RESPONSE
    FIRE_AND_FORGET
    FIRE_AND_FORGET
    "REQUEST_RESPONSE"
    REQUEST_RESPONSE
    "FIRE_AND_FORGET"
    FIRE_AND_FORGET

    PipeTargetKinesisStreamParameters, PipeTargetKinesisStreamParametersArgs

    PipeTargetLambdaFunctionParameters, PipeTargetLambdaFunctionParametersArgs

    PipeTargetParameters, PipeTargetParametersArgs

    BatchJobParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetBatchJobParameters
    CloudWatchLogsParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetCloudWatchLogsParameters
    EcsTaskParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetEcsTaskParameters
    EventBridgeEventBusParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetEventBridgeEventBusParameters
    HttpParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetHttpParameters
    InputTemplate string
    KinesisStreamParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetKinesisStreamParameters
    LambdaFunctionParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetLambdaFunctionParameters
    RedshiftDataParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetRedshiftDataParameters
    SageMakerPipelineParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetSageMakerPipelineParameters
    SqsQueueParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetSqsQueueParameters
    StepFunctionStateMachineParameters Pulumi.AwsNative.Pipes.Inputs.PipeTargetStateMachineParameters

    PipeTargetRedshiftDataParameters, PipeTargetRedshiftDataParametersArgs

    Database string
    Redshift Database
    Sqls List<string>
    A list of SQLs.
    DbUser string
    Database user name
    SecretManagerArn string
    Optional SecretManager ARN which stores the database credentials
    StatementName string
    A name for Redshift DataAPI statement which can be used as filter of ListStatement.
    WithEvent bool
    Database string
    Redshift Database
    Sqls []string
    A list of SQLs.
    DbUser string
    Database user name
    SecretManagerArn string
    Optional SecretManager ARN which stores the database credentials
    StatementName string
    A name for Redshift DataAPI statement which can be used as filter of ListStatement.
    WithEvent bool
    database String
    Redshift Database
    sqls List<String>
    A list of SQLs.
    dbUser String
    Database user name
    secretManagerArn String
    Optional SecretManager ARN which stores the database credentials
    statementName String
    A name for Redshift DataAPI statement which can be used as filter of ListStatement.
    withEvent Boolean
    database string
    Redshift Database
    sqls string[]
    A list of SQLs.
    dbUser string
    Database user name
    secretManagerArn string
    Optional SecretManager ARN which stores the database credentials
    statementName string
    A name for Redshift DataAPI statement which can be used as filter of ListStatement.
    withEvent boolean
    database str
    Redshift Database
    sqls Sequence[str]
    A list of SQLs.
    db_user str
    Database user name
    secret_manager_arn str
    Optional SecretManager ARN which stores the database credentials
    statement_name str
    A name for Redshift DataAPI statement which can be used as filter of ListStatement.
    with_event bool
    database String
    Redshift Database
    sqls List<String>
    A list of SQLs.
    dbUser String
    Database user name
    secretManagerArn String
    Optional SecretManager ARN which stores the database credentials
    statementName String
    A name for Redshift DataAPI statement which can be used as filter of ListStatement.
    withEvent Boolean

    PipeTargetSageMakerPipelineParameters, PipeTargetSageMakerPipelineParametersArgs

    PipeTargetSqsQueueParameters, PipeTargetSqsQueueParametersArgs

    PipeTargetStateMachineParameters, PipeTargetStateMachineParametersArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi