Package software.amazon.awscdk.services.pipes
package software.amazon.awscdk.services.pipes
AWS::Pipes Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.pipes.*;
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.)
-
ClassDescriptionSpecifies a pipe.This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.A builder for
CfnPipe.AwsVpcConfigurationPropertyAn implementation forCfnPipe.AwsVpcConfigurationPropertyThe array properties for the submitted job, such as the size of the array.A builder forCfnPipe.BatchArrayPropertiesPropertyAn implementation forCfnPipe.BatchArrayPropertiesPropertyThe overrides that are sent to a container.A builder forCfnPipe.BatchContainerOverridesPropertyAn implementation forCfnPipe.BatchContainerOverridesPropertyThe environment variables to send to the container.A builder forCfnPipe.BatchEnvironmentVariablePropertyAn implementation forCfnPipe.BatchEnvironmentVariablePropertyAn object that represents an AWS Batch job dependency.A builder forCfnPipe.BatchJobDependencyPropertyAn implementation forCfnPipe.BatchJobDependencyPropertyThe type and amount of a resource to assign to a container.A builder forCfnPipe.BatchResourceRequirementPropertyAn implementation forCfnPipe.BatchResourceRequirementPropertyThe retry strategy that's associated with a job.A builder forCfnPipe.BatchRetryStrategyPropertyAn implementation forCfnPipe.BatchRetryStrategyPropertyA fluent builder forCfnPipe.The details of a capacity provider strategy.A builder forCfnPipe.CapacityProviderStrategyItemPropertyAn implementation forCfnPipe.CapacityProviderStrategyItemPropertyRepresents the Amazon CloudWatch Logs logging configuration settings for the pipe.A builder forCfnPipe.CloudwatchLogsLogDestinationPropertyAn implementation forCfnPipe.CloudwatchLogsLogDestinationPropertyADeadLetterConfigobject that contains information about a dead-letter queue configuration.A builder forCfnPipe.DeadLetterConfigPropertyAn implementation forCfnPipe.DeadLetterConfigPropertyMaps source data to a dimension in the target Timestream for LiveAnalytics table.A builder forCfnPipe.DimensionMappingPropertyAn implementation forCfnPipe.DimensionMappingPropertyThe overrides that are sent to a container.A builder forCfnPipe.EcsContainerOverridePropertyAn implementation forCfnPipe.EcsContainerOverridePropertyA list of files containing the environment variables to pass to a container.A builder forCfnPipe.EcsEnvironmentFilePropertyAn implementation forCfnPipe.EcsEnvironmentFilePropertyThe environment variables to send to the container.A builder forCfnPipe.EcsEnvironmentVariablePropertyAn implementation forCfnPipe.EcsEnvironmentVariablePropertyThe amount of ephemeral storage to allocate for the task.A builder forCfnPipe.EcsEphemeralStoragePropertyAn implementation forCfnPipe.EcsEphemeralStoragePropertyDetails on an Elastic Inference accelerator task override.A builder forCfnPipe.EcsInferenceAcceleratorOverridePropertyAn implementation forCfnPipe.EcsInferenceAcceleratorOverridePropertyThe type and amount of a resource to assign to a container.A builder forCfnPipe.EcsResourceRequirementPropertyAn implementation forCfnPipe.EcsResourceRequirementPropertyThe overrides that are associated with a task.A builder forCfnPipe.EcsTaskOverridePropertyAn implementation forCfnPipe.EcsTaskOverridePropertyThe collection of event patterns used to filter events.A builder forCfnPipe.FilterCriteriaPropertyAn implementation forCfnPipe.FilterCriteriaPropertyFilter events using an event pattern.A builder forCfnPipe.FilterPropertyAn implementation forCfnPipe.FilterPropertyRepresents the Amazon Data Firehose logging configuration settings for the pipe.A builder forCfnPipe.FirehoseLogDestinationPropertyAn implementation forCfnPipe.FirehoseLogDestinationPropertyThe AWS Secrets Manager secret that stores your broker credentials.A builder forCfnPipe.MQBrokerAccessCredentialsPropertyAn implementation forCfnPipe.MQBrokerAccessCredentialsPropertyThe AWS Secrets Manager secret that stores your stream credentials.A builder forCfnPipe.MSKAccessCredentialsPropertyAn implementation forCfnPipe.MSKAccessCredentialsPropertyA mapping of a source event data field to a measure in a Timestream for LiveAnalytics record.A builder forCfnPipe.MultiMeasureAttributeMappingPropertyAn implementation forCfnPipe.MultiMeasureAttributeMappingPropertyMaps multiple measures from the source event to the same Timestream for LiveAnalytics record.A builder forCfnPipe.MultiMeasureMappingPropertyAn implementation forCfnPipe.MultiMeasureMappingPropertyThis structure specifies the network configuration for an Amazon ECS task.A builder forCfnPipe.NetworkConfigurationPropertyAn implementation forCfnPipe.NetworkConfigurationPropertyThese are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.A builder forCfnPipe.PipeEnrichmentHttpParametersPropertyAn implementation forCfnPipe.PipeEnrichmentHttpParametersPropertyThe parameters required to set up enrichment on your pipe.A builder forCfnPipe.PipeEnrichmentParametersPropertyAn implementation forCfnPipe.PipeEnrichmentParametersPropertyRepresents the configuration settings for the logs to which this pipe should report events.A builder forCfnPipe.PipeLogConfigurationPropertyAn implementation forCfnPipe.PipeLogConfigurationPropertyThe parameters for using an Active MQ broker as a source.A builder forCfnPipe.PipeSourceActiveMQBrokerParametersPropertyAn implementation forCfnPipe.PipeSourceActiveMQBrokerParametersPropertyThe parameters for using a DynamoDB stream as a source.A builder forCfnPipe.PipeSourceDynamoDBStreamParametersPropertyAn implementation forCfnPipe.PipeSourceDynamoDBStreamParametersPropertyThe parameters for using a Kinesis stream as a source.A builder forCfnPipe.PipeSourceKinesisStreamParametersPropertyAn implementation forCfnPipe.PipeSourceKinesisStreamParametersPropertyThe parameters for using an MSK stream as a source.An implementation forCfnPipe.PipeSourceManagedStreamingKafkaParametersPropertyThe parameters required to set up a source for your pipe.A builder forCfnPipe.PipeSourceParametersPropertyAn implementation forCfnPipe.PipeSourceParametersPropertyThe parameters for using a Rabbit MQ broker as a source.A builder forCfnPipe.PipeSourceRabbitMQBrokerParametersPropertyAn implementation forCfnPipe.PipeSourceRabbitMQBrokerParametersPropertyThe parameters for using a self-managed Apache Kafka stream as a source.A builder forCfnPipe.PipeSourceSelfManagedKafkaParametersPropertyAn implementation forCfnPipe.PipeSourceSelfManagedKafkaParametersPropertyThe parameters for using a Amazon SQS stream as a source.A builder forCfnPipe.PipeSourceSqsQueueParametersPropertyAn implementation forCfnPipe.PipeSourceSqsQueueParametersPropertyThe parameters for using an AWS Batch job as a target.A builder forCfnPipe.PipeTargetBatchJobParametersPropertyAn implementation forCfnPipe.PipeTargetBatchJobParametersPropertyThe parameters for using an CloudWatch Logs log stream as a target.A builder forCfnPipe.PipeTargetCloudWatchLogsParametersPropertyAn implementation forCfnPipe.PipeTargetCloudWatchLogsParametersPropertyThe parameters for using an Amazon ECS task as a target.A builder forCfnPipe.PipeTargetEcsTaskParametersPropertyAn implementation forCfnPipe.PipeTargetEcsTaskParametersPropertyThe parameters for using an EventBridge event bus as a target.A builder forCfnPipe.PipeTargetEventBridgeEventBusParametersPropertyAn implementation forCfnPipe.PipeTargetEventBridgeEventBusParametersPropertyThese are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.A builder forCfnPipe.PipeTargetHttpParametersPropertyAn implementation forCfnPipe.PipeTargetHttpParametersPropertyThe parameters for using a Kinesis stream as a target.A builder forCfnPipe.PipeTargetKinesisStreamParametersPropertyAn implementation forCfnPipe.PipeTargetKinesisStreamParametersPropertyThe parameters for using a Lambda function as a target.A builder forCfnPipe.PipeTargetLambdaFunctionParametersPropertyAn implementation forCfnPipe.PipeTargetLambdaFunctionParametersPropertyThe parameters required to set up a target for your pipe.A builder forCfnPipe.PipeTargetParametersPropertyAn implementation forCfnPipe.PipeTargetParametersPropertyThese are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.A builder forCfnPipe.PipeTargetRedshiftDataParametersPropertyAn implementation forCfnPipe.PipeTargetRedshiftDataParametersPropertyThe parameters for using a SageMaker AI pipeline as a target.A builder forCfnPipe.PipeTargetSageMakerPipelineParametersPropertyAn implementation forCfnPipe.PipeTargetSageMakerPipelineParametersPropertyThe parameters for using a Amazon SQS stream as a target.A builder forCfnPipe.PipeTargetSqsQueueParametersPropertyAn implementation forCfnPipe.PipeTargetSqsQueueParametersPropertyThe parameters for using a Step Functions state machine as a target.A builder forCfnPipe.PipeTargetStateMachineParametersPropertyAn implementation forCfnPipe.PipeTargetStateMachineParametersPropertyThe parameters for using a Timestream for LiveAnalytics table as a target.A builder forCfnPipe.PipeTargetTimestreamParametersPropertyAn implementation forCfnPipe.PipeTargetTimestreamParametersPropertyAn object representing a constraint on task placement.A builder forCfnPipe.PlacementConstraintPropertyAn implementation forCfnPipe.PlacementConstraintPropertyThe task placement strategy for a task or service.A builder forCfnPipe.PlacementStrategyPropertyAn implementation forCfnPipe.PlacementStrategyPropertyRepresents the Amazon S3 logging configuration settings for the pipe.A builder forCfnPipe.S3LogDestinationPropertyAn implementation forCfnPipe.S3LogDestinationPropertyName/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline.A builder forCfnPipe.SageMakerPipelineParameterPropertyAn implementation forCfnPipe.SageMakerPipelineParameterPropertyThe AWS Secrets Manager secret that stores your stream credentials.An implementation forCfnPipe.SelfManagedKafkaAccessConfigurationCredentialsPropertyThis structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.A builder forCfnPipe.SelfManagedKafkaAccessConfigurationVpcPropertyAn implementation forCfnPipe.SelfManagedKafkaAccessConfigurationVpcPropertyMaps a single source data field to a single record in the specified Timestream for LiveAnalytics table.A builder forCfnPipe.SingleMeasureMappingPropertyAn implementation forCfnPipe.SingleMeasureMappingPropertyProperties for defining aCfnPipe.A builder forCfnPipePropsAn implementation forCfnPipeProps(experimental) Indicates that this resource can be referenced as a Pipe.Internal default implementation forIPipeRef.A proxy class which represents a concrete javascript instance of this type.A reference to a Pipe resource.A builder forPipeReferenceAn implementation forPipeReference