AWS CDK Reference

Appearance

v2.274.0

Experimental

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

PipeProps Struct ​

Properties for a pipe.

Stability
Experimental
Source
lib/pipe.ts

Example ​

ts
declare const sourceQueue: sqs.Queue;
declare const dest: events.ApiDestination;

const apiTarget = new targets.ApiDestinationTarget(dest, {
  inputTransformation: pipes.InputTransformation.fromObject({ body: "👀" }),
});

const pipe = new pipes.Pipe(this, 'Pipe', {
    source: new SqsSource(sourceQueue),
    target: apiTarget,
});

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the pipe displayed in the AWS console.

Default: no description

desiredStateoptionalDesiredStatedesired_stateoptionalDesiredStatedesiredStateoptionalDesiredStateDesiredStateoptionalDesiredStateDesiredStateoptionalDesiredState= DesiredState.RUNNING#
The desired state of the pipe.

If the state is set to STOPPED, the pipe will not process events.

enrichmentoptionalIEnrichmentenrichmentoptionalIEnrichmentenrichmentoptionalIEnrichmentEnrichmentoptionalIEnrichmentEnrichmentoptionalIEnrichment#
Enrichment step to enhance the data from the source before sending it to the target.

Default: no enrichment

filteroptionalIFilterfilteroptionalIFilterfilteroptionalIFilterFilteroptionalIFilterFilteroptionalIFilter#
The filter pattern for the pipe source.

Default: no filter

kmsKeyoptionalIKeykms_keyoptionalIKeykmsKeyoptionalIKeyKmsKeyoptionalIKeyKmsKeyoptionalIKey#
The AWS KMS customer managed key to encrypt pipe data.

Default: undefined - AWS managed key is used

logDestinationsoptionalILogDestination[]log_destinationsoptionaltyping.List[ILogDestination]logDestinationsoptionalList<ILogDestination>LogDestinationsoptionalILogDestination[]LogDestinationsoptional*[]ILogDestination#
Destinations for the logs.

Default: no logs

logIncludeExecutionDataoptionalIncludeExecutionData[]log_include_execution_dataoptionaltyping.List[IncludeExecutionData]logIncludeExecutionDataoptionalList<IncludeExecutionData>LogIncludeExecutionDataoptionalIncludeExecutionData[]LogIncludeExecutionDataoptional*[]IncludeExecutionData= none#
Whether the execution data (specifically, the `payload` , `awsRequest` , and `awsResponse` fields) is included in the log messages for this pipe.
notes

This applies to all log destinations for the pipe.

For more information, see Including execution data in logs and the message schema in the Amazon EventBridge User Guide .

logLeveloptionalLogLevellog_leveloptionalLogLevellogLeveloptionalLogLevelLogLeveloptionalLogLevelLogLeveloptionalLogLevel= LogLevel.ERROR#
The level of logging detail to include.

This applies to all log destinations for the pipe.

pipeNameoptionalstringpipe_nameoptionalstrpipeNameoptionalStringPipeNameoptionalstringPipeNameoptional*string#
Name of the pipe in the AWS console.

Default: automatically generated name

roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#
The role used by the pipe which has permissions to read from the source and write to the target.

Default: a new role will be created.

If an enriched target is used, the role also have permissions to call the enriched target. If no role is provided, a role will be created.

sourceISourcesourceISourcesourceISourceSourceISourceSourceISourcerequired#
The source of the pipe.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
The list of key-value pairs to associate with the pipe.

Default: no tags

targetITargettargetITargettargetITargetTargetITargetTargetITargetrequired#
The target of the pipe.