class CfnPipePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Pipes.Mixins.CfnPipePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspipes/mixins#CfnPipePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.pipes.mixins.CfnPipePropsMixin
Python	aws_cdk.mixins_preview.aws_pipes.mixins.CfnPipePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_pipes » mixins » CfnPipePropsMixin

Implements IMixin

Extends Mixin

Specifies a pipe.

Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see Generate an CloudFormation template from EventBridge Pipes in the Amazon EventBridge User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as pipes_mixins } from '@aws-cdk/mixins-preview/aws-pipes';
const cfnPipePropsMixin = new pipes_mixins.CfnPipePropsMixin({
  description: 'description',
  desiredState: 'desiredState',
  enrichment: 'enrichment',
  enrichmentParameters: {
    httpParameters: {
      headerParameters: {
        headerParametersKey: 'headerParameters',
      },
      pathParameterValues: ['pathParameterValues'],
      queryStringParameters: {
        queryStringParametersKey: 'queryStringParameters',
      },
    },
    inputTemplate: 'inputTemplate',
  },
  kmsKeyIdentifier: 'kmsKeyIdentifier',
  logConfiguration: {
    cloudwatchLogsLogDestination: {
      logGroupArn: 'logGroupArn',
    },
    firehoseLogDestination: {
      deliveryStreamArn: 'deliveryStreamArn',
    },
    includeExecutionData: ['includeExecutionData'],
    level: 'level',
    s3LogDestination: {
      bucketName: 'bucketName',
      bucketOwner: 'bucketOwner',
      outputFormat: 'outputFormat',
      prefix: 'prefix',
    },
  },
  name: 'name',
  roleArn: 'roleArn',
  source: 'source',
  sourceParameters: {
    activeMqBrokerParameters: {
      batchSize: 123,
      credentials: {
        basicAuth: 'basicAuth',
      },
      maximumBatchingWindowInSeconds: 123,
      queueName: 'queueName',
    },
    dynamoDbStreamParameters: {
      batchSize: 123,
      deadLetterConfig: {
        arn: 'arn',
      },
      maximumBatchingWindowInSeconds: 123,
      maximumRecordAgeInSeconds: 123,
      maximumRetryAttempts: 123,
      onPartialBatchItemFailure: 'onPartialBatchItemFailure',
      parallelizationFactor: 123,
      startingPosition: 'startingPosition',
    },
    filterCriteria: {
      filters: [{
        pattern: 'pattern',
      }],
    },
    kinesisStreamParameters: {
      batchSize: 123,
      deadLetterConfig: {
        arn: 'arn',
      },
      maximumBatchingWindowInSeconds: 123,
      maximumRecordAgeInSeconds: 123,
      maximumRetryAttempts: 123,
      onPartialBatchItemFailure: 'onPartialBatchItemFailure',
      parallelizationFactor: 123,
      startingPosition: 'startingPosition',
      startingPositionTimestamp: 'startingPositionTimestamp',
    },
    managedStreamingKafkaParameters: {
      batchSize: 123,
      consumerGroupId: 'consumerGroupId',
      credentials: {
        clientCertificateTlsAuth: 'clientCertificateTlsAuth',
        saslScram512Auth: 'saslScram512Auth',
      },
      maximumBatchingWindowInSeconds: 123,
      startingPosition: 'startingPosition',
      topicName: 'topicName',
    },
    rabbitMqBrokerParameters: {
      batchSize: 123,
      credentials: {
        basicAuth: 'basicAuth',
      },
      maximumBatchingWindowInSeconds: 123,
      queueName: 'queueName',
      virtualHost: 'virtualHost',
    },
    selfManagedKafkaParameters: {
      additionalBootstrapServers: ['additionalBootstrapServers'],
      batchSize: 123,
      consumerGroupId: 'consumerGroupId',
      credentials: {
        basicAuth: 'basicAuth',
        clientCertificateTlsAuth: 'clientCertificateTlsAuth',
        saslScram256Auth: 'saslScram256Auth',
        saslScram512Auth: 'saslScram512Auth',
      },
      maximumBatchingWindowInSeconds: 123,
      serverRootCaCertificate: 'serverRootCaCertificate',
      startingPosition: 'startingPosition',
      topicName: 'topicName',
      vpc: {
        securityGroup: ['securityGroup'],
        subnets: ['subnets'],
      },
    },
    sqsQueueParameters: {
      batchSize: 123,
      maximumBatchingWindowInSeconds: 123,
    },
  },
  tags: {
    tagsKey: 'tags',
  },
  target: 'target',
  targetParameters: {
    batchJobParameters: {
      arrayProperties: {
        size: 123,
      },
      containerOverrides: {
        command: ['command'],
        environment: [{
          name: 'name',
          value: 'value',
        }],
        instanceType: 'instanceType',
        resourceRequirements: [{
          type: 'type',
          value: 'value',
        }],
      },
      dependsOn: [{
        jobId: 'jobId',
        type: 'type',
      }],
      jobDefinition: 'jobDefinition',
      jobName: 'jobName',
      parameters: {
        parametersKey: 'parameters',
      },
      retryStrategy: {
        attempts: 123,
      },
    },
    cloudWatchLogsParameters: {
      logStreamName: 'logStreamName',
      timestamp: 'timestamp',
    },
    ecsTaskParameters: {
      capacityProviderStrategy: [{
        base: 123,
        capacityProvider: 'capacityProvider',
        weight: 123,
      }],
      enableEcsManagedTags: false,
      enableExecuteCommand: false,
      group: 'group',
      launchType: 'launchType',
      networkConfiguration: {
        awsvpcConfiguration: {
          assignPublicIp: 'assignPublicIp',
          securityGroups: ['securityGroups'],
          subnets: ['subnets'],
        },
      },
      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,
      taskDefinitionArn: 'taskDefinitionArn',
    },
    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',
      dbUser: 'dbUser',
      secretManagerArn: 'secretManagerArn',
      sqls: ['sqls'],
      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',
      }],
      epochTimeUnit: 'epochTimeUnit',
      multiMeasureMappings: [{
        multiMeasureAttributeMappings: [{
          measureValue: 'measureValue',
          measureValueType: 'measureValueType',
          multiMeasureAttributeName: 'multiMeasureAttributeName',
        }],
        multiMeasureName: 'multiMeasureName',
      }],
      singleMeasureMappings: [{
        measureName: 'measureName',
        measureValue: 'measureValue',
        measureValueType: 'measureValueType',
      }],
      timeFieldType: 'timeFieldType',
      timestampFormat: 'timestampFormat',
      timeValue: 'timeValue',
      versionValue: 'versionValue',
    },
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnPipePropsMixin(props: CfnPipeMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnPipeMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Pipes::Pipe.

Properties

Name	Type	Description
props	CfnPipeMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnPipeMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.