Package software.amazon.awscdk.services.pipes

Class CfnPipe

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pipes.CfnPipe

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITaggable, IPipeRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:46.481Z")
@Stability(Stable)
public class CfnPipe
extends CfnResource
implements IInspectable, IPipeRef, ITaggable

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.services.pipes.*;
 CfnPipe cfnPipe = CfnPipe.Builder.create(this, "MyCfnPipe")
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.pipes.IPipeRef

IPipeRef.Jsii$Default, IPipeRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPipe(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPipe(software.constructs.Construct scope, String id, CfnPipeProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The ARN of the pipe.
String	getAttrCreationTime()	The time the pipe was created.
String	getAttrCurrentState()	The state the pipe is in.
String	getAttrLastModifiedTime()	When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String	getAttrStateReason()	The reason the pipe is in its current state.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description of the pipe.
String	getDesiredState()	The state the pipe should be in.
String	getEnrichment()	The ARN of the enrichment resource.
Object	getEnrichmentParameters()	The parameters required to set up enrichment on your pipe.
String	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.
Object	getLogConfiguration()	The logging configuration settings for the pipe.
String	getName()	The name of the pipe.
PipeReference	getPipeRef()	A reference to a Pipe resource.
String	getRoleArn()	The ARN of the role that allows the pipe to send data to the target.
String	getSource()	The ARN of the source resource.
Object	getSourceParameters()	The parameters required to set up a source for your pipe.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Map<String,String>	getTagsRaw()	The list of key-value pairs to associate with the pipe.
String	getTarget()	The ARN of the target resource.
Object	getTargetParameters()	The parameters required to set up a target for your pipe.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	A description of the pipe.
void	setDesiredState(String value)	The state the pipe should be in.
void	setEnrichment(String value)	The ARN of the enrichment resource.
void	setEnrichmentParameters(IResolvable value)	The parameters required to set up enrichment on your pipe.
void	setEnrichmentParameters(CfnPipe.PipeEnrichmentParametersProperty value)	The parameters required to set up enrichment on your pipe.
void	setKmsKeyIdentifier(String value)	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.
void	setLogConfiguration(IResolvable value)	The logging configuration settings for the pipe.
void	setLogConfiguration(CfnPipe.PipeLogConfigurationProperty value)	The logging configuration settings for the pipe.
void	setName(String value)	The name of the pipe.
void	setRoleArn(String value)	The ARN of the role that allows the pipe to send data to the target.
void	setSource(String value)	The ARN of the source resource.
void	setSourceParameters(IResolvable value)	The parameters required to set up a source for your pipe.
void	setSourceParameters(CfnPipe.PipeSourceParametersProperty value)	The parameters required to set up a source for your pipe.
void	setTagsRaw(Map<String,String> value)	The list of key-value pairs to associate with the pipe.
void	setTarget(String value)	The ARN of the target resource.
void	setTargetParameters(IResolvable value)	The parameters required to set up a target for your pipe.
void	setTargetParameters(CfnPipe.PipeTargetParametersProperty value)	The parameters required to set up a target for your pipe.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnPipe

protected CfnPipe(software.amazon.jsii.JsiiObjectRef objRef)

CfnPipe

protected CfnPipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPipe

@Stability(Stable)
public CfnPipe(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPipeProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The ARN of the pipe.

getAttrCreationTime

@Stability(Stable)
@NotNull
public String getAttrCreationTime()

The time the pipe was created.

getAttrCurrentState

@Stability(Stable)
@NotNull
public String getAttrCurrentState()

The state the pipe is in.

getAttrLastModifiedTime

@Stability(Stable)
@NotNull
public String getAttrLastModifiedTime()

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

getAttrStateReason

@Stability(Stable)
@NotNull
public String getAttrStateReason()

The reason the pipe is in its current state.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPipeRef

@Stability(Stable)
@NotNull
public PipeReference getPipeRef()

A reference to a Pipe resource.

Specified by:

getPipeRef in interface IPipeRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

The ARN of the role that allows the pipe to send data to the target.

setRoleArn

@Stability(Stable)
public void setRoleArn(@NotNull
 String value)

The ARN of the role that allows the pipe to send data to the target.

getSource

@Stability(Stable)
@NotNull
public String getSource()

The ARN of the source resource.

setSource

@Stability(Stable)
public void setSource(@NotNull
 String value)

The ARN of the source resource.

getTarget

@Stability(Stable)
@NotNull
public String getTarget()

The ARN of the target resource.

setTarget

@Stability(Stable)
public void setTarget(@NotNull
 String value)

The ARN of the target resource.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description of the pipe.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description of the pipe.

getDesiredState

@Stability(Stable)
@Nullable
public String getDesiredState()

The state the pipe should be in.

setDesiredState

@Stability(Stable)
public void setDesiredState(@Nullable
 String value)

The state the pipe should be in.

getEnrichment

@Stability(Stable)
@Nullable
public String getEnrichment()

The ARN of the enrichment resource.

setEnrichment

@Stability(Stable)
public void setEnrichment(@Nullable
 String value)

The ARN of the enrichment resource.

getEnrichmentParameters

@Stability(Stable)
@Nullable
public Object getEnrichmentParameters()

The parameters required to set up enrichment on your pipe.

Returns union: either IResolvable or CfnPipe.PipeEnrichmentParametersProperty

setEnrichmentParameters

@Stability(Stable)
public void setEnrichmentParameters(@Nullable
 IResolvable value)

The parameters required to set up enrichment on your pipe.

setEnrichmentParameters

@Stability(Stable)
public void setEnrichmentParameters(@Nullable
 CfnPipe.PipeEnrichmentParametersProperty value)

The parameters required to set up enrichment on your pipe.

getKmsKeyIdentifier

@Stability(Stable)
@Nullable
public String 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.

setKmsKeyIdentifier

@Stability(Stable)
public void setKmsKeyIdentifier(@Nullable
 String value)

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.

getLogConfiguration

@Stability(Stable)
@Nullable
public Object getLogConfiguration()

The logging configuration settings for the pipe.

Returns union: either IResolvable or CfnPipe.PipeLogConfigurationProperty

setLogConfiguration

@Stability(Stable)
public void setLogConfiguration(@Nullable
 IResolvable value)

The logging configuration settings for the pipe.

setLogConfiguration

@Stability(Stable)
public void setLogConfiguration(@Nullable
 CfnPipe.PipeLogConfigurationProperty value)

The logging configuration settings for the pipe.

getName

@Stability(Stable)
@Nullable
public String getName()

The name of the pipe.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the pipe.

getSourceParameters

@Stability(Stable)
@Nullable
public Object getSourceParameters()

The parameters required to set up a source for your pipe.

Returns union: either IResolvable or CfnPipe.PipeSourceParametersProperty

setSourceParameters

@Stability(Stable)
public void setSourceParameters(@Nullable
 IResolvable value)

The parameters required to set up a source for your pipe.

setSourceParameters

@Stability(Stable)
public void setSourceParameters(@Nullable
 CfnPipe.PipeSourceParametersProperty value)

The parameters required to set up a source for your pipe.

getTagsRaw

@Stability(Stable)
@Nullable
public Map<String,String> getTagsRaw()

The list of key-value pairs to associate with the pipe.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Map<String,String> value)

The list of key-value pairs to associate with the pipe.

getTargetParameters

@Stability(Stable)
@Nullable
public Object getTargetParameters()

The parameters required to set up a target for your pipe.

Returns union: either IResolvable or CfnPipe.PipeTargetParametersProperty

setTargetParameters

@Stability(Stable)
public void setTargetParameters(@Nullable
 IResolvable value)

The parameters required to set up a target for your pipe.

setTargetParameters

@Stability(Stable)
public void setTargetParameters(@Nullable
 CfnPipe.PipeTargetParametersProperty value)

The parameters required to set up a target for your pipe.