CfnPipe

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.pipes.CfnPipe

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.294Z")
public class CfnPipe
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pipes::Pipe`.

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

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())
         .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())
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and 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 class`	`CfnPipe.Builder` A fluent builder for `CfnPipe`.
`static interface`	`CfnPipe.CapacityProviderStrategyItemProperty` The details of a capacity provider strategy.
`static interface`	`CfnPipe.DeadLetterConfigProperty` A `DeadLetterConfig` object that contains information about a dead-letter queue configuration.
`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.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.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.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 source.
`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 pipeline as a target.
`static interface`	`CfnPipe.PipeTargetSqsQueueParametersProperty` The parameters for using a Amazon SQS stream as a source.
`static interface`	`CfnPipe.PipeTargetStateMachineParametersProperty` The parameters for using a Step Functions state machine 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.SageMakerPipelineParameterProperty` Name/Value pair of a parameter to start execution of a SageMaker 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.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnPipe(Construct scope, java.lang.String id, CfnPipeProps props)` Create a new `AWS::Pipes::Pipe`.
`protected`	`CfnPipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnPipe(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The ARN of the pipe.
`java.lang.String`	`getAttrCreationTime()` The time the pipe was created.
`java.lang.String`	`getAttrCurrentState()` The state the pipe is in.
`java.lang.String`	`getAttrLastModifiedTime()` When the pipe was last updated, in [ISO-8601 format](https://docs.aws.amazon.com/https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).
`java.lang.String`	`getAttrStateReason()` The reason the pipe is in its current state.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDescription()` A description of the pipe.
`java.lang.String`	`getDesiredState()` The state the pipe should be in.
`java.lang.String`	`getEnrichment()` The ARN of the enrichment resource.
`java.lang.Object`	`getEnrichmentParameters()` The parameters required to set up enrichment on your pipe.
`java.lang.String`	`getName()` The name of the pipe.
`java.lang.String`	`getRoleArn()` The ARN of the role that allows the pipe to send data to the target.
`java.lang.String`	`getSource()` The ARN of the source resource.
`java.lang.Object`	`getSourceParameters()` The parameters required to set up a source for your pipe.
`TagManager`	`getTags()` The list of key-value pairs to associate with the pipe.
`java.lang.String`	`getTarget()` The ARN of the target resource.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDescription(java.lang.String value)` A description of the pipe.
`void`	`setDesiredState(java.lang.String value)` The state the pipe should be in.
`void`	`setEnrichment(java.lang.String value)` The ARN of the enrichment resource.
`void`	`setEnrichmentParameters(CfnPipe.PipeEnrichmentParametersProperty value)` The parameters required to set up enrichment on your pipe.
`void`	`setEnrichmentParameters(IResolvable value)` The parameters required to set up enrichment on your pipe.
`void`	`setName(java.lang.String value)` The name of the pipe.
`void`	`setRoleArn(java.lang.String value)` The ARN of the role that allows the pipe to send data to the target.
`void`	`setSource(java.lang.String value)` The ARN of the source resource.
`void`	`setSourceParameters(CfnPipe.PipeSourceParametersProperty value)` The parameters required to set up a source for your pipe.
`void`	`setSourceParameters(IResolvable value)` The parameters required to set up a source for your pipe.
`void`	`setTarget(java.lang.String value)` The ARN of the target resource.
`void`	`setTargetParameters(CfnPipe.PipeTargetParametersProperty value)` The parameters required to set up a target for your pipe.
`void`	`setTargetParameters(IResolvable value)` The parameters required to set up a target for your pipe.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnPipe
```
protected CfnPipe(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnPipe
```
protected CfnPipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnPipe
```
public CfnPipe(Construct scope,
               java.lang.String id,
               CfnPipeProps props)
```
    Create a new `AWS::Pipes::Pipe`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The ARN of the pipe.
  - getAttrCreationTime
```
public java.lang.String getAttrCreationTime()
```
    The time the pipe was created.
  - getAttrCurrentState
```
public java.lang.String getAttrCurrentState()
```
    The state the pipe is in.
  - getAttrLastModifiedTime
```
public java.lang.String getAttrLastModifiedTime()
```
    When the pipe was last updated, in [ISO-8601 format](https://docs.aws.amazon.com/https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).
  - getAttrStateReason
```
public java.lang.String getAttrStateReason()
```
    The reason the pipe is in its current state.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The list of key-value pairs to associate with the pipe.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The ARN of the role that allows the pipe to send data to the target.
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    The ARN of the role that allows the pipe to send data to the target.
  - getSource
```
public java.lang.String getSource()
```
    The ARN of the source resource.
  - setSource
```
public void setSource(java.lang.String value)
```
    The ARN of the source resource.
  - getTarget
```
public java.lang.String getTarget()
```
    The ARN of the target resource.
  - setTarget
```
public void setTarget(java.lang.String value)
```
    The ARN of the target resource.
  - getDescription
```
public java.lang.String getDescription()
```
    A description of the pipe.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A description of the pipe.
  - getDesiredState
```
public java.lang.String getDesiredState()
```
    The state the pipe should be in.
  - setDesiredState
```
public void setDesiredState(java.lang.String value)
```
    The state the pipe should be in.
  - getEnrichment
```
public java.lang.String getEnrichment()
```
    The ARN of the enrichment resource.
  - setEnrichment
```
public void setEnrichment(java.lang.String value)
```
    The ARN of the enrichment resource.
  - getEnrichmentParameters
```
public java.lang.Object getEnrichmentParameters()
```
    The parameters required to set up enrichment on your pipe.
  - setEnrichmentParameters
```
public void setEnrichmentParameters(CfnPipe.PipeEnrichmentParametersProperty value)
```
    The parameters required to set up enrichment on your pipe.
  - setEnrichmentParameters
```
public void setEnrichmentParameters(IResolvable value)
```
    The parameters required to set up enrichment on your pipe.
  - getName
```
public java.lang.String getName()
```
    The name of the pipe.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the pipe.
  - getSourceParameters
```
public java.lang.Object getSourceParameters()
```
    The parameters required to set up a source for your pipe.
  - setSourceParameters
```
public void setSourceParameters(IResolvable value)
```
    The parameters required to set up a source for your pipe.
  - setSourceParameters
```
public void setSourceParameters(CfnPipe.PipeSourceParametersProperty value)
```
    The parameters required to set up a source for your pipe.
  - getTargetParameters
```
public java.lang.Object 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 .
  - setTargetParameters
```
public void setTargetParameters(IResolvable value)
```
    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 .
  - setTargetParameters
```
public void setTargetParameters(CfnPipe.PipeTargetParametersProperty value)
```
    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 .

Class CfnPipe

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnPipe

CfnPipe

CfnPipe

Method Detail

inspect

renderProperties

getAttrArn

getAttrCreationTime

getAttrCurrentState

getAttrLastModifiedTime

getAttrStateReason

getCfnProperties

getTags

getRoleArn

setRoleArn

getSource

setSource

getTarget

setTarget

getDescription

setDescription

getDesiredState

setDesiredState

getEnrichment

setEnrichment

getEnrichmentParameters

setEnrichmentParameters

setEnrichmentParameters

getName

setName

getSourceParameters

setSourceParameters

setSourceParameters

getTargetParameters

setTargetParameters

setTargetParameters