Interface CfnPipeProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPipeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:43.318Z")
@Stability(Stable)
public interface CfnPipeProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnPipe.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.pipes.*;
CfnPipeProps cfnPipeProps = CfnPipeProps.builder()
.roleArn("roleArn")
.source("source")
.target("target")
// the properties below are optional
.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")
.sourceParameters(PipeSourceParametersProperty.builder()
.activeMqBrokerParameters(PipeSourceActiveMQBrokerParametersProperty.builder()
.credentials(MQBrokerAccessCredentialsProperty.builder()
.basicAuth("basicAuth")
.build())
.queueName("queueName")
// the properties below are optional
.batchSize(123)
.maximumBatchingWindowInSeconds(123)
.build())
.dynamoDbStreamParameters(PipeSourceDynamoDBStreamParametersProperty.builder()
.startingPosition("startingPosition")
// the properties below are optional
.batchSize(123)
.deadLetterConfig(DeadLetterConfigProperty.builder()
.arn("arn")
.build())
.maximumBatchingWindowInSeconds(123)
.maximumRecordAgeInSeconds(123)
.maximumRetryAttempts(123)
.onPartialBatchItemFailure("onPartialBatchItemFailure")
.parallelizationFactor(123)
.build())
.filterCriteria(FilterCriteriaProperty.builder()
.filters(List.of(FilterProperty.builder()
.pattern("pattern")
.build()))
.build())
.kinesisStreamParameters(PipeSourceKinesisStreamParametersProperty.builder()
.startingPosition("startingPosition")
// the properties below are optional
.batchSize(123)
.deadLetterConfig(DeadLetterConfigProperty.builder()
.arn("arn")
.build())
.maximumBatchingWindowInSeconds(123)
.maximumRecordAgeInSeconds(123)
.maximumRetryAttempts(123)
.onPartialBatchItemFailure("onPartialBatchItemFailure")
.parallelizationFactor(123)
.startingPositionTimestamp("startingPositionTimestamp")
.build())
.managedStreamingKafkaParameters(PipeSourceManagedStreamingKafkaParametersProperty.builder()
.topicName("topicName")
// the properties below are optional
.batchSize(123)
.consumerGroupId("consumerGroupId")
.credentials(MSKAccessCredentialsProperty.builder()
.clientCertificateTlsAuth("clientCertificateTlsAuth")
.saslScram512Auth("saslScram512Auth")
.build())
.maximumBatchingWindowInSeconds(123)
.startingPosition("startingPosition")
.build())
.rabbitMqBrokerParameters(PipeSourceRabbitMQBrokerParametersProperty.builder()
.credentials(MQBrokerAccessCredentialsProperty.builder()
.basicAuth("basicAuth")
.build())
.queueName("queueName")
// the properties below are optional
.batchSize(123)
.maximumBatchingWindowInSeconds(123)
.virtualHost("virtualHost")
.build())
.selfManagedKafkaParameters(PipeSourceSelfManagedKafkaParametersProperty.builder()
.topicName("topicName")
// the properties below are optional
.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")
.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"))
.targetParameters(PipeTargetParametersProperty.builder()
.batchJobParameters(PipeTargetBatchJobParametersProperty.builder()
.jobDefinition("jobDefinition")
.jobName("jobName")
// the properties below are optional
.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()))
.parameters(Map.of(
"parametersKey", "parameters"))
.retryStrategy(BatchRetryStrategyProperty.builder()
.attempts(123)
.build())
.build())
.cloudWatchLogsParameters(PipeTargetCloudWatchLogsParametersProperty.builder()
.logStreamName("logStreamName")
.timestamp("timestamp")
.build())
.ecsTaskParameters(PipeTargetEcsTaskParametersProperty.builder()
.taskDefinitionArn("taskDefinitionArn")
// the properties below are optional
.capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
.capacityProvider("capacityProvider")
// the properties below are optional
.base(123)
.weight(123)
.build()))
.enableEcsManagedTags(false)
.enableExecuteCommand(false)
.group("group")
.launchType("launchType")
.networkConfiguration(NetworkConfigurationProperty.builder()
.awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
.subnets(List.of("subnets"))
// the properties below are optional
.assignPublicIp("assignPublicIp")
.securityGroups(List.of("securityGroups"))
.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)
.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")
.sqls(List.of("sqls"))
// the properties below are optional
.dbUser("dbUser")
.secretManagerArn("secretManagerArn")
.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()))
.timeValue("timeValue")
.versionValue("versionValue")
// the properties below are optional
.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")
.build())
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnPipePropsstatic final classAn implementation forCfnPipeProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnPipeProps.Builderbuilder()default StringA description of the pipe.default StringThe state the pipe should be in.default StringThe ARN of the enrichment resource.default ObjectThe parameters required to set up enrichment on your pipe.default StringThe 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.default ObjectThe logging configuration settings for the pipe.default StringgetName()The name of the pipe.The ARN of the role that allows the pipe to send data to the target.The ARN of the source resource.default ObjectThe parameters required to set up a source for your pipe.getTags()The list of key-value pairs to associate with the pipe.The ARN of the target resource.default ObjectThe parameters required to set up a target for your pipe.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getRoleArn
The ARN of the role that allows the pipe to send data to the target.- See Also:
-
getSource
The ARN of the source resource.- See Also:
-
getTarget
The ARN of the target resource.- See Also:
-
getDescription
A description of the pipe.- See Also:
-
getDesiredState
The state the pipe should be in.- See Also:
-
getEnrichment
The ARN of the enrichment resource.- See Also:
-
getEnrichmentParameters
The parameters required to set up enrichment on your pipe.Returns union: either
IResolvableorCfnPipe.PipeEnrichmentParametersProperty- See Also:
-
getKmsKeyIdentifier
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 .
- See Also:
-
getLogConfiguration
The logging configuration settings for the pipe.Returns union: either
IResolvableorCfnPipe.PipeLogConfigurationProperty- See Also:
-
getName
The name of the pipe.- See Also:
-
getSourceParameters
The parameters required to set up a source for your pipe.Returns union: either
IResolvableorCfnPipe.PipeSourceParametersProperty- See Also:
-
getTags
The list of key-value pairs to associate with the pipe.- See Also:
-
getTargetParameters
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 .
Returns union: either
IResolvableorCfnPipe.PipeTargetParametersProperty- See Also:
-
builder
- Returns:
- a
CfnPipeProps.BuilderofCfnPipeProps
-