aws-cdk-lib.aws_pipes.CfnPipe.PipeTargetParametersProperty

interface PipeTargetParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.Pipes.CfnPipe.PipeTargetParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeTargetParametersProperty
Javasoftware.amazon.awscdk.services.pipes.CfnPipe.PipeTargetParametersProperty
Pythonaws_cdk.aws_pipes.CfnPipe.PipeTargetParametersProperty
TypeScript aws-cdk-lib » aws_pipes » CfnPipe » 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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeTargetParametersProperty: pipes.CfnPipe.PipeTargetParametersProperty = {
  batchJobParameters: {
    jobDefinition: 'jobDefinition',
    jobName: 'jobName',

    // the properties below are optional
    arrayProperties: {
      size: 123,
    },
    containerOverrides: {
      command: ['command'],
      environment: [{
        name: 'name',
        value: 'value',
      }],
      instanceType: 'instanceType',
      resourceRequirements: [{
        type: 'type',
        value: 'value',
      }],
    },
    dependsOn: [{
      jobId: 'jobId',
      type: 'type',
    }],
    parameters: {
      parametersKey: 'parameters',
    },
    retryStrategy: {
      attempts: 123,
    },
  },
  cloudWatchLogsParameters: {
    logStreamName: 'logStreamName',
    timestamp: 'timestamp',
  },
  ecsTaskParameters: {
    taskDefinitionArn: 'taskDefinitionArn',

    // the properties below are optional
    capacityProviderStrategy: [{
      capacityProvider: 'capacityProvider',

      // the properties below are optional
      base: 123,
      weight: 123,
    }],
    enableEcsManagedTags: false,
    enableExecuteCommand: false,
    group: 'group',
    launchType: 'launchType',
    networkConfiguration: {
      awsvpcConfiguration: {
        subnets: ['subnets'],

        // the properties below are optional
        assignPublicIp: 'assignPublicIp',
        securityGroups: ['securityGroups'],
      },
    },
    overrides: {
      containerOverrides: [{
        command: ['command'],
        cpu: 123,
        environment: [{
          name: 'name',
          value: 'value',
        }],
        environmentFiles: [{
          type: 'type',
          value: 'value',
        }],
        memory: 123,
        memoryReservation: 123,
        name: 'name',
        resourceRequirements: [{
          type: 'type',
          value: 'value',
        }],
      }],
      cpu: 'cpu',
      ephemeralStorage: {
        sizeInGiB: 123,
      },
      executionRoleArn: 'executionRoleArn',
      inferenceAcceleratorOverrides: [{
        deviceName: 'deviceName',
        deviceType: 'deviceType',
      }],
      memory: 'memory',
      taskRoleArn: 'taskRoleArn',
    },
    placementConstraints: [{
      expression: 'expression',
      type: 'type',
    }],
    placementStrategy: [{
      field: 'field',
      type: 'type',
    }],
    platformVersion: 'platformVersion',
    propagateTags: 'propagateTags',
    referenceId: 'referenceId',
    tags: [{
      key: 'key',
      value: 'value',
    }],
    taskCount: 123,
  },
  eventBridgeEventBusParameters: {
    detailType: 'detailType',
    endpointId: 'endpointId',
    resources: ['resources'],
    source: 'source',
    time: 'time',
  },
  httpParameters: {
    headerParameters: {
      headerParametersKey: 'headerParameters',
    },
    pathParameterValues: ['pathParameterValues'],
    queryStringParameters: {
      queryStringParametersKey: 'queryStringParameters',
    },
  },
  inputTemplate: 'inputTemplate',
  kinesisStreamParameters: {
    partitionKey: 'partitionKey',
  },
  lambdaFunctionParameters: {
    invocationType: 'invocationType',
  },
  redshiftDataParameters: {
    database: 'database',
    sqls: ['sqls'],

    // the properties below are optional
    dbUser: 'dbUser',
    secretManagerArn: 'secretManagerArn',
    statementName: 'statementName',
    withEvent: false,
  },
  sageMakerPipelineParameters: {
    pipelineParameterList: [{
      name: 'name',
      value: 'value',
    }],
  },
  sqsQueueParameters: {
    messageDeduplicationId: 'messageDeduplicationId',
    messageGroupId: 'messageGroupId',
  },
  stepFunctionStateMachineParameters: {
    invocationType: 'invocationType',
  },
};

Properties

NameTypeDescription
batchJobParameters?IResolvable | PipeTargetBatchJobParametersPropertyThe parameters for using an AWS Batch job as a target.
cloudWatchLogsParameters?IResolvable | PipeTargetCloudWatchLogsParametersPropertyThe parameters for using an CloudWatch Logs log stream as a target.
ecsTaskParameters?IResolvable | PipeTargetEcsTaskParametersPropertyThe parameters for using an Amazon ECS task as a target.
eventBridgeEventBusParameters?IResolvable | PipeTargetEventBridgeEventBusParametersPropertyThe parameters for using an EventBridge event bus as a target.
httpParameters?IResolvable | PipeTargetHttpParametersPropertyThese are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
inputTemplate?stringValid JSON text passed to the target.
kinesisStreamParameters?IResolvable | PipeTargetKinesisStreamParametersPropertyThe parameters for using a Kinesis stream as a target.
lambdaFunctionParameters?IResolvable | PipeTargetLambdaFunctionParametersPropertyThe parameters for using a Lambda function as a target.
redshiftDataParameters?IResolvable | PipeTargetRedshiftDataParametersPropertyThese are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
sageMakerPipelineParameters?IResolvable | PipeTargetSageMakerPipelineParametersPropertyThe parameters for using a SageMaker pipeline as a target.
sqsQueueParameters?IResolvable | PipeTargetSqsQueueParametersPropertyThe parameters for using a Amazon SQS stream as a target.
stepFunctionStateMachineParameters?IResolvable | PipeTargetStateMachineParametersPropertyThe parameters for using a Step Functions state machine as a target.

batchJobParameters?

Type: IResolvable | PipeTargetBatchJobParametersProperty (optional)

The parameters for using an AWS Batch job as a target.


cloudWatchLogsParameters?

Type: IResolvable | PipeTargetCloudWatchLogsParametersProperty (optional)

The parameters for using an CloudWatch Logs log stream as a target.


ecsTaskParameters?

Type: IResolvable | PipeTargetEcsTaskParametersProperty (optional)

The parameters for using an Amazon ECS task as a target.


eventBridgeEventBusParameters?

Type: IResolvable | PipeTargetEventBridgeEventBusParametersProperty (optional)

The parameters for using an EventBridge event bus as a target.


httpParameters?

Type: IResolvable | PipeTargetHttpParametersProperty (optional)

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.


inputTemplate?

Type: string (optional)

Valid JSON text passed to the target.

In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .

To remove an input template, specify an empty string.


kinesisStreamParameters?

Type: IResolvable | PipeTargetKinesisStreamParametersProperty (optional)

The parameters for using a Kinesis stream as a target.


lambdaFunctionParameters?

Type: IResolvable | PipeTargetLambdaFunctionParametersProperty (optional)

The parameters for using a Lambda function as a target.


redshiftDataParameters?

Type: IResolvable | PipeTargetRedshiftDataParametersProperty (optional)

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.


sageMakerPipelineParameters?

Type: IResolvable | PipeTargetSageMakerPipelineParametersProperty (optional)

The parameters for using a SageMaker pipeline as a target.


sqsQueueParameters?

Type: IResolvable | PipeTargetSqsQueueParametersProperty (optional)

The parameters for using a Amazon SQS stream as a target.


stepFunctionStateMachineParameters?

Type: IResolvable | PipeTargetStateMachineParametersProperty (optional)

The parameters for using a Step Functions state machine as a target.