aws-cdk-lib.aws_pipes

AWS::Pipes Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as pipes from 'aws-cdk-lib/aws-pipes';

import aws_cdk.aws_pipes as pipes

import software.amazon.awscdk.services.pipes.*;

using Amazon.CDK.AWS.Pipes;

import pipes "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for Pipes construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Pipes resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Pipes.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
CfnPipe	Construct (L1)	Specifies a pipe.
CfnPipe.AwsVpcConfigurationProperty	Struct	This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.
CfnPipe.BatchArrayPropertiesProperty	Struct	The array properties for the submitted job, such as the size of the array.
CfnPipe.BatchContainerOverridesProperty	Struct	The overrides that are sent to a container.
CfnPipe.BatchEnvironmentVariableProperty	Struct	The environment variables to send to the container.
CfnPipe.BatchJobDependencyProperty	Struct	An object that represents an AWS Batch job dependency.
CfnPipe.BatchResourceRequirementProperty	Struct	The type and amount of a resource to assign to a container.
CfnPipe.BatchRetryStrategyProperty	Struct	The retry strategy that's associated with a job.
CfnPipe.CapacityProviderStrategyItemProperty	Struct	The details of a capacity provider strategy.
CfnPipe.CloudwatchLogsLogDestinationProperty	Struct	Represents the Amazon CloudWatch Logs logging configuration settings for the pipe.
CfnPipe.DeadLetterConfigProperty	Struct	A DeadLetterConfig object that contains information about a dead-letter queue configuration.
CfnPipe.DimensionMappingProperty	Struct	Maps source data to a dimension in the target Timestream for LiveAnalytics table.
CfnPipe.EcsContainerOverrideProperty	Struct	The overrides that are sent to a container.
CfnPipe.EcsEnvironmentFileProperty	Struct	A list of files containing the environment variables to pass to a container.
CfnPipe.EcsEnvironmentVariableProperty	Struct	The environment variables to send to the container.
CfnPipe.EcsEphemeralStorageProperty	Struct	The amount of ephemeral storage to allocate for the task.
CfnPipe.EcsInferenceAcceleratorOverrideProperty	Struct	Details on an Elastic Inference accelerator task override.
CfnPipe.EcsResourceRequirementProperty	Struct	The type and amount of a resource to assign to a container.
CfnPipe.EcsTaskOverrideProperty	Struct	The overrides that are associated with a task.
CfnPipe.FilterCriteriaProperty	Struct	The collection of event patterns used to filter events.
CfnPipe.FilterProperty	Struct	Filter events using an event pattern.
CfnPipe.FirehoseLogDestinationProperty	Struct	Represents the Amazon Data Firehose logging configuration settings for the pipe.
CfnPipe.MQBrokerAccessCredentialsProperty	Struct	The AWS Secrets Manager secret that stores your broker credentials.
CfnPipe.MSKAccessCredentialsProperty	Struct	The AWS Secrets Manager secret that stores your stream credentials.
CfnPipe.MultiMeasureAttributeMappingProperty	Struct	A mapping of a source event data field to a measure in a Timestream for LiveAnalytics record.
CfnPipe.MultiMeasureMappingProperty	Struct	Maps multiple measures from the source event to the same Timestream for LiveAnalytics record.
CfnPipe.NetworkConfigurationProperty	Struct	This structure specifies the network configuration for an Amazon ECS task.
CfnPipe.PipeEnrichmentHttpParametersProperty	Struct	These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
CfnPipe.PipeEnrichmentParametersProperty	Struct	The parameters required to set up enrichment on your pipe.
CfnPipe.PipeLogConfigurationProperty	Struct	Represents the configuration settings for the logs to which this pipe should report events.
CfnPipe.PipeSourceActiveMQBrokerParametersProperty	Struct	The parameters for using an Active MQ broker as a source.
CfnPipe.PipeSourceDynamoDBStreamParametersProperty	Struct	The parameters for using a DynamoDB stream as a source.
CfnPipe.PipeSourceKinesisStreamParametersProperty	Struct	The parameters for using a Kinesis stream as a source.
CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty	Struct	The parameters for using an MSK stream as a source.
CfnPipe.PipeSourceParametersProperty	Struct	The parameters required to set up a source for your pipe.
CfnPipe.PipeSourceRabbitMQBrokerParametersProperty	Struct	The parameters for using a Rabbit MQ broker as a source.
CfnPipe.PipeSourceSelfManagedKafkaParametersProperty	Struct	The parameters for using a self-managed Apache Kafka stream as a source.
CfnPipe.PipeSourceSqsQueueParametersProperty	Struct	The parameters for using a Amazon SQS stream as a source.
CfnPipe.PipeTargetBatchJobParametersProperty	Struct	The parameters for using an AWS Batch job as a target.
CfnPipe.PipeTargetCloudWatchLogsParametersProperty	Struct	The parameters for using an CloudWatch Logs log stream as a target.
CfnPipe.PipeTargetEcsTaskParametersProperty	Struct	The parameters for using an Amazon ECS task as a target.
CfnPipe.PipeTargetEventBridgeEventBusParametersProperty	Struct	The parameters for using an EventBridge event bus as a target.
CfnPipe.PipeTargetHttpParametersProperty	Struct	These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
CfnPipe.PipeTargetKinesisStreamParametersProperty	Struct	The parameters for using a Kinesis stream as a target.
CfnPipe.PipeTargetLambdaFunctionParametersProperty	Struct	The parameters for using a Lambda function as a target.
CfnPipe.PipeTargetParametersProperty	Struct	The parameters required to set up a target for your pipe.
CfnPipe.PipeTargetRedshiftDataParametersProperty	Struct	These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
CfnPipe.PipeTargetSageMakerPipelineParametersProperty	Struct	The parameters for using a SageMaker AI pipeline as a target.
CfnPipe.PipeTargetSqsQueueParametersProperty	Struct	The parameters for using a Amazon SQS stream as a target.
CfnPipe.PipeTargetStateMachineParametersProperty	Struct	The parameters for using a Step Functions state machine as a target.
CfnPipe.PipeTargetTimestreamParametersProperty	Struct	The parameters for using a Timestream for LiveAnalytics table as a target.
CfnPipe.PlacementConstraintProperty	Struct	An object representing a constraint on task placement.
CfnPipe.PlacementStrategyProperty	Struct	The task placement strategy for a task or service.
CfnPipe.S3LogDestinationProperty	Struct	Represents the Amazon S3 logging configuration settings for the pipe.
CfnPipe.SageMakerPipelineParameterProperty	Struct	Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline.
CfnPipe.SelfManagedKafkaAccessConfigurationCredentialsProperty	Struct	The AWS Secrets Manager secret that stores your stream credentials.
CfnPipe.SelfManagedKafkaAccessConfigurationVpcProperty	Struct	This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
CfnPipe.SingleMeasureMappingProperty	Struct	Maps a single source data field to a single record in the specified Timestream for LiveAnalytics table.
CfnPipeProps	Struct	Properties for defining a CfnPipe.