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:
IInspectable,ITaggable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
date="2023-10-26T00:56:11.005Z")
@Stability(Stable)
public class CfnPipe
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceThis structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.static interfaceExample:static interfaceExample:static interfaceThe environment variables to send to the container.static interfaceAn object that represents an AWS Batch job dependency.static interfaceThe type and amount of a resource to assign to a container.static interfaceThe retry strategy that's associated with a job.static final classA fluent builder forCfnPipe.static interfaceThe details of a capacity provider strategy.static interfaceADeadLetterConfigobject that contains information about a dead-letter queue configuration.static interfaceThe overrides that are sent to a container.static interfaceA list of files containing the environment variables to pass to a container.static interfaceThe environment variables to send to the container.static interfaceThe amount of ephemeral storage to allocate for the task.static interfaceDetails on an Elastic Inference accelerator task override.static interfaceThe type and amount of a resource to assign to a container.static interfaceExample:static interfaceExample:static interfaceFilter events using an event pattern.static interfaceThe AWS Secrets Manager secret that stores your broker credentials.static interfaceThe AWS Secrets Manager secret that stores your stream credentials.static interfaceThis structure specifies the network configuration for an Amazon ECS task.static interfaceThese are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceAn object representing a constraint on task placement.static interfaceThe task placement strategy for a task or service.static interfaceName/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.static interfaceThe AWS Secrets Manager secret that stores your stream credentials.static interfaceThis structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnPipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnPipe(software.amazon.jsii.JsiiObjectRef objRef) CfnPipe(software.constructs.Construct scope, String id, CfnPipeProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the pipe.The time the pipe was created.The state the pipe is in.When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).The reason the pipe is in its current state.getName()getTags()Tag Manager which manages the tags for this resource.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetDescription(String value) voidsetDesiredState(String value) voidsetEnrichment(String value) voidvoidvoidvoidsetRoleArn(String value) voidvoidsetSourceParameters(IResolvable value) voidvoidsetTagsRaw(Map<String, String> value) voidvoidsetTargetParameters(IResolvable value) voidMethods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The ARN of the pipe. -
getAttrCreationTime
The time the pipe was created. -
getAttrCurrentState
The state the pipe is in. -
getAttrLastModifiedTime
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). -
getAttrStateReason
The reason the pipe is in its current state. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getRoleArn
-
setRoleArn
-
getSource
-
setSource
-
getTarget
-
setTarget
-
getDescription
-
setDescription
-
getDesiredState
-
setDesiredState
-
getEnrichment
-
setEnrichment
-
getEnrichmentParameters
-
setEnrichmentParameters
-
setEnrichmentParameters
@Stability(Stable) public void setEnrichmentParameters(@Nullable CfnPipe.PipeEnrichmentParametersProperty value) -
getName
-
setName
-
getSourceParameters
-
setSourceParameters
-
setSourceParameters
@Stability(Stable) public void setSourceParameters(@Nullable CfnPipe.PipeSourceParametersProperty value) -
getTagsRaw
-
setTagsRaw
-
getTargetParameters
-
setTargetParameters
-
setTargetParameters
@Stability(Stable) public void setTargetParameters(@Nullable CfnPipe.PipeTargetParametersProperty value)
-