interface CfnPipeProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pipes.CfnPipeProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipeProps |
![]() | software.amazon.awscdk.services.pipes.CfnPipeProps |
![]() | aws_cdk.aws_pipes.CfnPipeProps |
![]() | aws-cdk-lib » aws_pipes » CfnPipeProps |
Properties for defining a CfnPipe
.
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 { aws_pipes as pipes } from 'aws-cdk-lib';
const cfnPipeProps: pipes.CfnPipeProps = {
roleArn: 'roleArn',
source: 'source',
target: 'target',
// the properties below are optional
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',
sourceParameters: {
activeMqBrokerParameters: {
credentials: {
basicAuth: 'basicAuth',
},
queueName: 'queueName',
// the properties below are optional
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
},
dynamoDbStreamParameters: {
startingPosition: 'startingPosition',
// the properties below are optional
batchSize: 123,
deadLetterConfig: {
arn: 'arn',
},
maximumBatchingWindowInSeconds: 123,
maximumRecordAgeInSeconds: 123,
maximumRetryAttempts: 123,
onPartialBatchItemFailure: 'onPartialBatchItemFailure',
parallelizationFactor: 123,
},
filterCriteria: {
filters: [{
pattern: 'pattern',
}],
},
kinesisStreamParameters: {
startingPosition: 'startingPosition',
// the properties below are optional
batchSize: 123,
deadLetterConfig: {
arn: 'arn',
},
maximumBatchingWindowInSeconds: 123,
maximumRecordAgeInSeconds: 123,
maximumRetryAttempts: 123,
onPartialBatchItemFailure: 'onPartialBatchItemFailure',
parallelizationFactor: 123,
startingPositionTimestamp: 'startingPositionTimestamp',
},
managedStreamingKafkaParameters: {
topicName: 'topicName',
// the properties below are optional
batchSize: 123,
consumerGroupId: 'consumerGroupId',
credentials: {
clientCertificateTlsAuth: 'clientCertificateTlsAuth',
saslScram512Auth: 'saslScram512Auth',
},
maximumBatchingWindowInSeconds: 123,
startingPosition: 'startingPosition',
},
rabbitMqBrokerParameters: {
credentials: {
basicAuth: 'basicAuth',
},
queueName: 'queueName',
// the properties below are optional
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
virtualHost: 'virtualHost',
},
selfManagedKafkaParameters: {
topicName: 'topicName',
// the properties below are optional
additionalBootstrapServers: ['additionalBootstrapServers'],
batchSize: 123,
consumerGroupId: 'consumerGroupId',
credentials: {
basicAuth: 'basicAuth',
clientCertificateTlsAuth: 'clientCertificateTlsAuth',
saslScram256Auth: 'saslScram256Auth',
saslScram512Auth: 'saslScram512Auth',
},
maximumBatchingWindowInSeconds: 123,
serverRootCaCertificate: 'serverRootCaCertificate',
startingPosition: 'startingPosition',
vpc: {
securityGroup: ['securityGroup'],
subnets: ['subnets'],
},
},
sqsQueueParameters: {
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
},
},
tags: {
tagsKey: 'tags',
},
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
Name | Type | Description |
---|---|---|
role | string | The ARN of the role that allows the pipe to send data to the target. |
source | string | The ARN of the source resource. |
target | string | The ARN of the target resource. |
description? | string | A description of the pipe. |
desired | string | The state the pipe should be in. |
enrichment? | string | The ARN of the enrichment resource. |
enrichment | IResolvable | Pipe | The parameters required to set up enrichment on your pipe. |
kms | string | The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. |
log | IResolvable | Pipe | The logging configuration settings for the pipe. |
name? | string | The name of the pipe. |
source | IResolvable | Pipe | The parameters required to set up a source for your pipe. |
tags? | { [string]: string } | The list of key-value pairs to associate with the pipe. |
target | IResolvable | Pipe | The parameters required to set up a target for your pipe. |
roleArn
Type:
string
The ARN of the role that allows the pipe to send data to the target.
source
Type:
string
The ARN of the source resource.
target
Type:
string
The ARN of the target resource.
description?
Type:
string
(optional)
A description of the pipe.
desiredState?
Type:
string
(optional)
The state the pipe should be in.
enrichment?
Type:
string
(optional)
The ARN of the enrichment resource.
enrichmentParameters?
Type:
IResolvable
|
Pipe
(optional)
The parameters required to set up enrichment on your pipe.
kmsKeyIdentifier?
Type:
string
(optional)
The identifier of the AWS KMS 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 .
logConfiguration?
Type:
IResolvable
|
Pipe
(optional)
The logging configuration settings for the pipe.
name?
Type:
string
(optional)
The name of the pipe.
sourceParameters?
Type:
IResolvable
|
Pipe
(optional)
The parameters required to set up a source for your pipe.
tags?
Type:
{ [string]: string }
(optional)
The list of key-value pairs to associate with the pipe.
targetParameters?
Type:
IResolvable
|
Pipe
(optional)
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 .