Class CfnPipePropsMixin
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.mixins.preview.core.Mixin
software.amazon.awscdk.mixins.preview.services.pipes.mixins.CfnPipePropsMixin
- All Implemented Interfaces:
IMixin,software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
date="2025-12-18T18:20:29.169Z")
@Stability(Stable)
public class CfnPipePropsMixin
extends Mixin
implements IMixin
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 .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.mixins.preview.mixins.*;
import software.amazon.awscdk.mixins.preview.services.pipes.mixins.*;
CfnPipePropsMixin cfnPipePropsMixin = CfnPipePropsMixin.Builder.create(CfnPipeMixinProps.builder()
.description("description")
.desiredState("desiredState")
.enrichment("enrichment")
.enrichmentParameters(PipeEnrichmentParametersProperty.builder()
.httpParameters(PipeEnrichmentHttpParametersProperty.builder()
.headerParameters(Map.of(
"headerParametersKey", "headerParameters"))
.pathParameterValues(List.of("pathParameterValues"))
.queryStringParameters(Map.of(
"queryStringParametersKey", "queryStringParameters"))
.build())
.inputTemplate("inputTemplate")
.build())
.kmsKeyIdentifier("kmsKeyIdentifier")
.logConfiguration(PipeLogConfigurationProperty.builder()
.cloudwatchLogsLogDestination(CloudwatchLogsLogDestinationProperty.builder()
.logGroupArn("logGroupArn")
.build())
.firehoseLogDestination(FirehoseLogDestinationProperty.builder()
.deliveryStreamArn("deliveryStreamArn")
.build())
.includeExecutionData(List.of("includeExecutionData"))
.level("level")
.s3LogDestination(S3LogDestinationProperty.builder()
.bucketName("bucketName")
.bucketOwner("bucketOwner")
.outputFormat("outputFormat")
.prefix("prefix")
.build())
.build())
.name("name")
.roleArn("roleArn")
.source("source")
.sourceParameters(PipeSourceParametersProperty.builder()
.activeMqBrokerParameters(PipeSourceActiveMQBrokerParametersProperty.builder()
.batchSize(123)
.credentials(MQBrokerAccessCredentialsProperty.builder()
.basicAuth("basicAuth")
.build())
.maximumBatchingWindowInSeconds(123)
.queueName("queueName")
.build())
.dynamoDbStreamParameters(PipeSourceDynamoDBStreamParametersProperty.builder()
.batchSize(123)
.deadLetterConfig(DeadLetterConfigProperty.builder()
.arn("arn")
.build())
.maximumBatchingWindowInSeconds(123)
.maximumRecordAgeInSeconds(123)
.maximumRetryAttempts(123)
.onPartialBatchItemFailure("onPartialBatchItemFailure")
.parallelizationFactor(123)
.startingPosition("startingPosition")
.build())
.filterCriteria(FilterCriteriaProperty.builder()
.filters(List.of(FilterProperty.builder()
.pattern("pattern")
.build()))
.build())
.kinesisStreamParameters(PipeSourceKinesisStreamParametersProperty.builder()
.batchSize(123)
.deadLetterConfig(DeadLetterConfigProperty.builder()
.arn("arn")
.build())
.maximumBatchingWindowInSeconds(123)
.maximumRecordAgeInSeconds(123)
.maximumRetryAttempts(123)
.onPartialBatchItemFailure("onPartialBatchItemFailure")
.parallelizationFactor(123)
.startingPosition("startingPosition")
.startingPositionTimestamp("startingPositionTimestamp")
.build())
.managedStreamingKafkaParameters(PipeSourceManagedStreamingKafkaParametersProperty.builder()
.batchSize(123)
.consumerGroupId("consumerGroupId")
.credentials(MSKAccessCredentialsProperty.builder()
.clientCertificateTlsAuth("clientCertificateTlsAuth")
.saslScram512Auth("saslScram512Auth")
.build())
.maximumBatchingWindowInSeconds(123)
.startingPosition("startingPosition")
.topicName("topicName")
.build())
.rabbitMqBrokerParameters(PipeSourceRabbitMQBrokerParametersProperty.builder()
.batchSize(123)
.credentials(MQBrokerAccessCredentialsProperty.builder()
.basicAuth("basicAuth")
.build())
.maximumBatchingWindowInSeconds(123)
.queueName("queueName")
.virtualHost("virtualHost")
.build())
.selfManagedKafkaParameters(PipeSourceSelfManagedKafkaParametersProperty.builder()
.additionalBootstrapServers(List.of("additionalBootstrapServers"))
.batchSize(123)
.consumerGroupId("consumerGroupId")
.credentials(SelfManagedKafkaAccessConfigurationCredentialsProperty.builder()
.basicAuth("basicAuth")
.clientCertificateTlsAuth("clientCertificateTlsAuth")
.saslScram256Auth("saslScram256Auth")
.saslScram512Auth("saslScram512Auth")
.build())
.maximumBatchingWindowInSeconds(123)
.serverRootCaCertificate("serverRootCaCertificate")
.startingPosition("startingPosition")
.topicName("topicName")
.vpc(SelfManagedKafkaAccessConfigurationVpcProperty.builder()
.securityGroup(List.of("securityGroup"))
.subnets(List.of("subnets"))
.build())
.build())
.sqsQueueParameters(PipeSourceSqsQueueParametersProperty.builder()
.batchSize(123)
.maximumBatchingWindowInSeconds(123)
.build())
.build())
.tags(Map.of(
"tagsKey", "tags"))
.target("target")
.targetParameters(PipeTargetParametersProperty.builder()
.batchJobParameters(PipeTargetBatchJobParametersProperty.builder()
.arrayProperties(BatchArrayPropertiesProperty.builder()
.size(123)
.build())
.containerOverrides(BatchContainerOverridesProperty.builder()
.command(List.of("command"))
.environment(List.of(BatchEnvironmentVariableProperty.builder()
.name("name")
.value("value")
.build()))
.instanceType("instanceType")
.resourceRequirements(List.of(BatchResourceRequirementProperty.builder()
.type("type")
.value("value")
.build()))
.build())
.dependsOn(List.of(BatchJobDependencyProperty.builder()
.jobId("jobId")
.type("type")
.build()))
.jobDefinition("jobDefinition")
.jobName("jobName")
.parameters(Map.of(
"parametersKey", "parameters"))
.retryStrategy(BatchRetryStrategyProperty.builder()
.attempts(123)
.build())
.build())
.cloudWatchLogsParameters(PipeTargetCloudWatchLogsParametersProperty.builder()
.logStreamName("logStreamName")
.timestamp("timestamp")
.build())
.ecsTaskParameters(PipeTargetEcsTaskParametersProperty.builder()
.capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
.base(123)
.capacityProvider("capacityProvider")
.weight(123)
.build()))
.enableEcsManagedTags(false)
.enableExecuteCommand(false)
.group("group")
.launchType("launchType")
.networkConfiguration(NetworkConfigurationProperty.builder()
.awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
.assignPublicIp("assignPublicIp")
.securityGroups(List.of("securityGroups"))
.subnets(List.of("subnets"))
.build())
.build())
.overrides(EcsTaskOverrideProperty.builder()
.containerOverrides(List.of(EcsContainerOverrideProperty.builder()
.command(List.of("command"))
.cpu(123)
.environment(List.of(EcsEnvironmentVariableProperty.builder()
.name("name")
.value("value")
.build()))
.environmentFiles(List.of(EcsEnvironmentFileProperty.builder()
.type("type")
.value("value")
.build()))
.memory(123)
.memoryReservation(123)
.name("name")
.resourceRequirements(List.of(EcsResourceRequirementProperty.builder()
.type("type")
.value("value")
.build()))
.build()))
.cpu("cpu")
.ephemeralStorage(EcsEphemeralStorageProperty.builder()
.sizeInGiB(123)
.build())
.executionRoleArn("executionRoleArn")
.inferenceAcceleratorOverrides(List.of(EcsInferenceAcceleratorOverrideProperty.builder()
.deviceName("deviceName")
.deviceType("deviceType")
.build()))
.memory("memory")
.taskRoleArn("taskRoleArn")
.build())
.placementConstraints(List.of(PlacementConstraintProperty.builder()
.expression("expression")
.type("type")
.build()))
.placementStrategy(List.of(PlacementStrategyProperty.builder()
.field("field")
.type("type")
.build()))
.platformVersion("platformVersion")
.propagateTags("propagateTags")
.referenceId("referenceId")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.taskCount(123)
.taskDefinitionArn("taskDefinitionArn")
.build())
.eventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParametersProperty.builder()
.detailType("detailType")
.endpointId("endpointId")
.resources(List.of("resources"))
.source("source")
.time("time")
.build())
.httpParameters(PipeTargetHttpParametersProperty.builder()
.headerParameters(Map.of(
"headerParametersKey", "headerParameters"))
.pathParameterValues(List.of("pathParameterValues"))
.queryStringParameters(Map.of(
"queryStringParametersKey", "queryStringParameters"))
.build())
.inputTemplate("inputTemplate")
.kinesisStreamParameters(PipeTargetKinesisStreamParametersProperty.builder()
.partitionKey("partitionKey")
.build())
.lambdaFunctionParameters(PipeTargetLambdaFunctionParametersProperty.builder()
.invocationType("invocationType")
.build())
.redshiftDataParameters(PipeTargetRedshiftDataParametersProperty.builder()
.database("database")
.dbUser("dbUser")
.secretManagerArn("secretManagerArn")
.sqls(List.of("sqls"))
.statementName("statementName")
.withEvent(false)
.build())
.sageMakerPipelineParameters(PipeTargetSageMakerPipelineParametersProperty.builder()
.pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
.name("name")
.value("value")
.build()))
.build())
.sqsQueueParameters(PipeTargetSqsQueueParametersProperty.builder()
.messageDeduplicationId("messageDeduplicationId")
.messageGroupId("messageGroupId")
.build())
.stepFunctionStateMachineParameters(PipeTargetStateMachineParametersProperty.builder()
.invocationType("invocationType")
.build())
.timestreamParameters(PipeTargetTimestreamParametersProperty.builder()
.dimensionMappings(List.of(DimensionMappingProperty.builder()
.dimensionName("dimensionName")
.dimensionValue("dimensionValue")
.dimensionValueType("dimensionValueType")
.build()))
.epochTimeUnit("epochTimeUnit")
.multiMeasureMappings(List.of(MultiMeasureMappingProperty.builder()
.multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
.measureValue("measureValue")
.measureValueType("measureValueType")
.multiMeasureAttributeName("multiMeasureAttributeName")
.build()))
.multiMeasureName("multiMeasureName")
.build()))
.singleMeasureMappings(List.of(SingleMeasureMappingProperty.builder()
.measureName("measureName")
.measureValue("measureValue")
.measureValueType("measureValueType")
.build()))
.timeFieldType("timeFieldType")
.timestampFormat("timestampFormat")
.timeValue("timeValue")
.versionValue("versionValue")
.build())
.build())
.build())
.strategy(PropertyMergeStrategy.OVERRIDE)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceThis structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.static interfaceThe array properties for the submitted job, such as the size of the array.static interfaceThe overrides that are sent to a container.static interfaceThe environment variables to send to the container.static interfaceAn object that represents an AWS Batch job dependency.static interfaceThe type and amount of a resource to assign to a container.static interfaceThe retry strategy that's associated with a job.static final classA fluent builder forCfnPipePropsMixin.static interfaceThe details of a capacity provider strategy.static interfaceRepresents the Amazon CloudWatch Logs logging configuration settings for the pipe.static interfaceADeadLetterConfigobject that contains information about a dead-letter queue configuration.static interfaceMaps source data to a dimension in the target Timestream for LiveAnalytics table.static interfaceThe overrides that are sent to a container.static interfaceA list of files containing the environment variables to pass to a container.static interfaceThe environment variables to send to the container.static interfaceThe amount of ephemeral storage to allocate for the task.static interfaceDetails on an Elastic Inference accelerator task override.static interfaceThe type and amount of a resource to assign to a container.static interfaceThe overrides that are associated with a task.static interfaceThe collection of event patterns used to filter events.static interfaceFilter events using an event pattern.static interfaceRepresents the Amazon Data Firehose logging configuration settings for the pipe.static interfaceThe AWS Secrets Manager secret that stores your broker credentials.static interfaceThe AWS Secrets Manager secret that stores your stream credentials.static interfaceA mapping of a source event data field to a measure in a Timestream for LiveAnalytics record.static interfaceMaps multiple measures from the source event to the same Timestream for LiveAnalytics record.static interfaceThis structure specifies the network configuration for an Amazon ECS task.static interfaceThese are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.static interfaceThe parameters required to set up enrichment on your pipe.static interfaceRepresents the configuration settings for the logs to which this pipe should report events.static interfaceThe parameters for using an Active MQ broker as a source.static interfaceThe parameters for using a DynamoDB stream as a source.static interfaceThe parameters for using a Kinesis stream as a source.static interfaceThe parameters for using an MSK stream as a source.static interfaceThe parameters required to set up a source for your pipe.static interfaceThe parameters for using a Rabbit MQ broker as a source.static interfaceThe parameters for using a self-managed Apache Kafka stream as a source.static interfaceThe parameters for using a Amazon SQS stream as a source.static interfaceThe parameters for using an AWS Batch job as a target.static interfaceThe parameters for using an CloudWatch Logs log stream as a target.static interfaceThe parameters for using an Amazon ECS task as a target.static interfaceThe parameters for using an EventBridge event bus as a target.static interfaceThese are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.static interfaceThe parameters for using a Kinesis stream as a target.static interfaceThe parameters for using a Lambda function as a target.static interfaceThe parameters required to set up a target for your pipe.static interfaceThese are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.static interfaceThe parameters for using a SageMaker AI pipeline as a target.static interfaceThe parameters for using a Amazon SQS stream as a target.static interfaceThe parameters for using a Step Functions state machine as a target.static interfaceThe parameters for using a Timestream for LiveAnalytics table as a target.static interfaceAn object representing a constraint on task placement.static interfaceThe task placement strategy for a task or service.static interfaceRepresents the Amazon S3 logging configuration settings for the pipe.static interfaceName/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline.static interfaceThe AWS Secrets Manager secret that stores your stream credentials.static interfaceThis structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.static interfaceMaps a single source data field to a single record in the specified Timestream for LiveAnalytics table.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.core.IMixin
IMixin.Jsii$Default, IMixin.Jsii$Proxy -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate a mixin to apply properties toAWS::Pipes::Pipe.CfnPipePropsMixin(CfnPipeMixinProps props, CfnPropertyMixinOptions options) Create a mixin to apply properties toAWS::Pipes::Pipe.protectedCfnPipePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnPipePropsMixin(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionsoftware.constructs.IConstructapplyTo(software.constructs.IConstruct construct) Apply the mixin properties to the construct.protected CfnPipeMixinPropsgetProps()protected PropertyMergeStrategysupports(software.constructs.IConstruct construct) Check if this mixin supports the given construct.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_PROPERTY_KEYS
-
-
Constructor Details
-
CfnPipePropsMixin
protected CfnPipePropsMixin(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPipePropsMixin
protected CfnPipePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPipePropsMixin
@Stability(Stable) public CfnPipePropsMixin(@NotNull CfnPipeMixinProps props, @Nullable CfnPropertyMixinOptions options) Create a mixin to apply properties toAWS::Pipes::Pipe.- Parameters:
props- L1 properties to apply. This parameter is required.options- Mixin options.
-
CfnPipePropsMixin
Create a mixin to apply properties toAWS::Pipes::Pipe.- Parameters:
props- L1 properties to apply. This parameter is required.
-
-
Method Details
-
applyTo
@Stability(Stable) @NotNull public software.constructs.IConstruct applyTo(@NotNull software.constructs.IConstruct construct) Apply the mixin properties to the construct. -
supports
@Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct) Check if this mixin supports the given construct. -
getProps
-
getStrategy
-