Class CfnPipe

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:55.096Z") @Stability(Stable) public class CfnPipe extends CfnResource implements IInspectable, 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())
         .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:
  • 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
    • 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.
    • 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.
    • getLogConfiguration

      @Stability(Stable) @Nullable public Object getLogConfiguration()
      The logging configuration settings for the pipe.
    • 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.
    • 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.
    • 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.