GradientEdge CDK Utils
    Preparing search index...

    Interface SqsToSfnPipeProps

    interface SqsToSfnPipeProps {
        description?: string;
        desiredState?: string;
        enrichment?: string | IFunctionRef;
        enrichmentParameters?: IResolvable | PipeEnrichmentParametersProperty;
        kmsKeyIdentifier?: string;
        logConfiguration?: IResolvable | PipeLogConfigurationProperty;
        name?: string;
        pipeFilterPattern?: any;
        roleArn: string | IRoleRef;
        sfnInputTemplate?: string;
        sfnInvocationType?: string;
        source: string | IQueueRef | IStreamRef;
        sourceParameters?: IResolvable | PipeSourceParametersProperty;
        sqsBatchSize?: number;
        sqsMaximumBatchingWindowInSeconds?: number;
        tags?: Record<string, string>;
        target:
            | string
            | IFunctionRef
            | ILogGroupRef
            | IQueueRef
            | ITopicRef
            | IEventBusRef
            | IStateMachineRef;
        targetParameters?: IResolvable
        | PipeTargetParametersProperty;
    }

    Hierarchy

    • CfnPipeProps
      • SqsToSfnPipeProps
    Index

    Properties

    description? desiredState? enrichment? enrichmentParameters? kmsKeyIdentifier? logConfiguration? name? pipeFilterPattern? roleArn sfnInputTemplate? sfnInvocationType? source sourceParameters? sqsBatchSize? sqsMaximumBatchingWindowInSeconds? tags? target targetParameters?

    Properties

    description?: string

    A description of the pipe.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-description

    desiredState?: string

    The state the pipe should be in.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-desiredstate

    enrichment?: string | IFunctionRef

    The ARN of the enrichment resource.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-enrichment

    enrichmentParameters?: IResolvable | PipeEnrichmentParametersProperty

    The parameters required to set up enrichment on your pipe.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-enrichmentparameters

    kmsKeyIdentifier?: string

    The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.

    The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

    To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.

    To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string.

    For more information, see Managing keys in the AWS Key Management Service Developer Guide .

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-kmskeyidentifier

    logConfiguration?: IResolvable | PipeLogConfigurationProperty

    The logging configuration settings for the pipe.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-logconfiguration

    name?: string

    The name of the pipe.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-name

    pipeFilterPattern?: any
    roleArn: string | IRoleRef

    The ARN of the role that allows the pipe to send data to the target.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-rolearn

    sfnInputTemplate?: string
    sfnInvocationType?: string
    source: string | IQueueRef | IStreamRef

    The ARN of the source resource.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-source

    sourceParameters?: IResolvable | PipeSourceParametersProperty

    The parameters required to set up a source for your pipe.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-sourceparameters

    sqsBatchSize?: number
    sqsMaximumBatchingWindowInSeconds?: number
    tags?: Record<string, string>

    The list of key-value pairs to associate with the pipe.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-tags

    target:
        | string
        | IFunctionRef
        | ILogGroupRef
        | IQueueRef
        | ITopicRef
        | IEventBusRef
        | IStateMachineRef

    The ARN of the target resource.

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-target

    targetParameters?: IResolvable | PipeTargetParametersProperty

    The parameters required to set up a target for your pipe.

    For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-targetparameters

    Settings

    Member Visibility

    On This Page

    Properties