@aws-cdk/aws-pipes-alpha.TargetConfig

Experimental

@aws-cdk/aws-pipes-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

TargetConfig Struct

Target config properties.

Stability

Experimental

Source

lib/target.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes_alpha from '@aws-cdk/aws-pipes-alpha';
const targetConfig: pipes_alpha.TargetConfig = {
  targetParameters: {
    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',
    },
    timestreamParameters: {
      dimensionMappings: [{
        dimensionName: 'dimensionName',
        dimensionValue: 'dimensionValue',
        dimensionValueType: 'dimensionValueType',
      }],
      timeValue: 'timeValue',
      versionValue: 'versionValue',

      // the properties below are optional
      epochTimeUnit: 'epochTimeUnit',
      multiMeasureMappings: [{
        multiMeasureAttributeMappings: [{
          measureValue: 'measureValue',
          measureValueType: 'measureValueType',
          multiMeasureAttributeName: 'multiMeasureAttributeName',
        }],
        multiMeasureName: 'multiMeasureName',
      }],
      singleMeasureMappings: [{
        measureName: 'measureName',
        measureValue: 'measureValue',
        measureValueType: 'measureValueType',
      }],
      timeFieldType: 'timeFieldType',
      timestampFormat: 'timestampFormat',
    },
  },
};

Properties

targetParametersCfnPipe.PipeTargetParametersPropertytarget_parametersPipeTargetParametersPropertytargetParametersPipeTargetParametersPropertyTargetParametersPipeTargetParametersPropertyTargetParametersPipeTargetParametersPropertyrequired#

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