Class CfnPipeMixinProps.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.pipes.CfnPipeMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPipeMixinProps>
- Enclosing interface:
CfnPipeMixinProps
@Stability(Stable)
public static final class CfnPipeMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPipeMixinProps>
A builder for
CfnPipeMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.description(String description) Sets the value ofCfnPipeMixinProps.getDescription()desiredState(String desiredState) Sets the value ofCfnPipeMixinProps.getDesiredState()enrichment(String enrichment) Sets the value ofCfnPipeMixinProps.getEnrichment()enrichment(IFunctionRef enrichment) Sets the value ofCfnPipeMixinProps.getEnrichment()enrichmentParameters(CfnPipePropsMixin.PipeEnrichmentParametersProperty enrichmentParameters) Sets the value ofCfnPipeMixinProps.getEnrichmentParameters()enrichmentParameters(IResolvable enrichmentParameters) Sets the value ofCfnPipeMixinProps.getEnrichmentParameters()kmsKeyIdentifier(String kmsKeyIdentifier) Sets the value ofCfnPipeMixinProps.getKmsKeyIdentifier()logConfiguration(CfnPipePropsMixin.PipeLogConfigurationProperty logConfiguration) Sets the value ofCfnPipeMixinProps.getLogConfiguration()logConfiguration(IResolvable logConfiguration) Sets the value ofCfnPipeMixinProps.getLogConfiguration()Sets the value ofCfnPipeMixinProps.getName()Sets the value ofCfnPipeMixinProps.getRoleArn()Sets the value ofCfnPipeMixinProps.getRoleArn()Sets the value ofCfnPipeMixinProps.getSource()source(IStreamRef source) Sets the value ofCfnPipeMixinProps.getSource()Sets the value ofCfnPipeMixinProps.getSource()sourceParameters(CfnPipePropsMixin.PipeSourceParametersProperty sourceParameters) Sets the value ofCfnPipeMixinProps.getSourceParameters()sourceParameters(IResolvable sourceParameters) Sets the value ofCfnPipeMixinProps.getSourceParameters()Sets the value ofCfnPipeMixinProps.getTags()Sets the value ofCfnPipeMixinProps.getTarget()target(IEventBusRef target) Sets the value ofCfnPipeMixinProps.getTarget()target(IFunctionRef target) Sets the value ofCfnPipeMixinProps.getTarget()target(ILogGroupRef target) Sets the value ofCfnPipeMixinProps.getTarget()Sets the value ofCfnPipeMixinProps.getTarget()Sets the value ofCfnPipeMixinProps.getTarget()target(IStateMachineRef target) Sets the value ofCfnPipeMixinProps.getTarget()targetParameters(CfnPipePropsMixin.PipeTargetParametersProperty targetParameters) Sets the value ofCfnPipeMixinProps.getTargetParameters()targetParameters(IResolvable targetParameters) Sets the value ofCfnPipeMixinProps.getTargetParameters()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
description
Sets the value ofCfnPipeMixinProps.getDescription()- Parameters:
description- A description of the pipe.- Returns:
this
-
desiredState
Sets the value ofCfnPipeMixinProps.getDesiredState()- Parameters:
desiredState- The state the pipe should be in.- Returns:
this
-
enrichment
Sets the value ofCfnPipeMixinProps.getEnrichment()- Parameters:
enrichment- The ARN of the enrichment resource.- Returns:
this
-
enrichment
Sets the value ofCfnPipeMixinProps.getEnrichment()- Parameters:
enrichment- The ARN of the enrichment resource.- Returns:
this
-
enrichmentParameters
@Stability(Stable) public CfnPipeMixinProps.Builder enrichmentParameters(IResolvable enrichmentParameters) Sets the value ofCfnPipeMixinProps.getEnrichmentParameters()- Parameters:
enrichmentParameters- The parameters required to set up enrichment on your pipe.- Returns:
this
-
enrichmentParameters
@Stability(Stable) public CfnPipeMixinProps.Builder enrichmentParameters(CfnPipePropsMixin.PipeEnrichmentParametersProperty enrichmentParameters) Sets the value ofCfnPipeMixinProps.getEnrichmentParameters()- Parameters:
enrichmentParameters- The parameters required to set up enrichment on your pipe.- Returns:
this
-
kmsKeyIdentifier
Sets the value ofCfnPipeMixinProps.getKmsKeyIdentifier()- Parameters:
kmsKeyIdentifier- The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.
To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string.
For more information, see Managing keys in the AWS Key Management Service Developer Guide .
- Returns:
this
-
logConfiguration
Sets the value ofCfnPipeMixinProps.getLogConfiguration()- Parameters:
logConfiguration- The logging configuration settings for the pipe.- Returns:
this
-
logConfiguration
@Stability(Stable) public CfnPipeMixinProps.Builder logConfiguration(CfnPipePropsMixin.PipeLogConfigurationProperty logConfiguration) Sets the value ofCfnPipeMixinProps.getLogConfiguration()- Parameters:
logConfiguration- The logging configuration settings for the pipe.- Returns:
this
-
name
Sets the value ofCfnPipeMixinProps.getName()- Parameters:
name- The name of the pipe.- Returns:
this
-
roleArn
Sets the value ofCfnPipeMixinProps.getRoleArn()- Parameters:
roleArn- The ARN of the role that allows the pipe to send data to the target.- Returns:
this
-
roleArn
Sets the value ofCfnPipeMixinProps.getRoleArn()- Parameters:
roleArn- The ARN of the role that allows the pipe to send data to the target.- Returns:
this
-
source
Sets the value ofCfnPipeMixinProps.getSource()- Parameters:
source- The ARN of the source resource.- Returns:
this
-
source
Sets the value ofCfnPipeMixinProps.getSource()- Parameters:
source- The ARN of the source resource.- Returns:
this
-
source
Sets the value ofCfnPipeMixinProps.getSource()- Parameters:
source- The ARN of the source resource.- Returns:
this
-
sourceParameters
Sets the value ofCfnPipeMixinProps.getSourceParameters()- Parameters:
sourceParameters- The parameters required to set up a source for your pipe.- Returns:
this
-
sourceParameters
@Stability(Stable) public CfnPipeMixinProps.Builder sourceParameters(CfnPipePropsMixin.PipeSourceParametersProperty sourceParameters) Sets the value ofCfnPipeMixinProps.getSourceParameters()- Parameters:
sourceParameters- The parameters required to set up a source for your pipe.- Returns:
this
-
tags
Sets the value ofCfnPipeMixinProps.getTags()- Parameters:
tags- The list of key-value pairs to associate with the pipe.- Returns:
this
-
target
Sets the value ofCfnPipeMixinProps.getTarget()- Parameters:
target- The ARN of the target resource.- Returns:
this
-
target
Sets the value ofCfnPipeMixinProps.getTarget()- Parameters:
target- The ARN of the target resource.- Returns:
this
-
target
Sets the value ofCfnPipeMixinProps.getTarget()- Parameters:
target- The ARN of the target resource.- Returns:
this
-
target
Sets the value ofCfnPipeMixinProps.getTarget()- Parameters:
target- The ARN of the target resource.- Returns:
this
-
target
Sets the value ofCfnPipeMixinProps.getTarget()- Parameters:
target- The ARN of the target resource.- Returns:
this
-
target
Sets the value ofCfnPipeMixinProps.getTarget()- Parameters:
target- The ARN of the target resource.- Returns:
this
-
target
Sets the value ofCfnPipeMixinProps.getTarget()- Parameters:
target- The ARN of the target resource.- Returns:
this
-
targetParameters
Sets the value ofCfnPipeMixinProps.getTargetParameters()- Parameters:
targetParameters- The parameters required to set up a target for your pipe. For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .- Returns:
this
-
targetParameters
@Stability(Stable) public CfnPipeMixinProps.Builder targetParameters(CfnPipePropsMixin.PipeTargetParametersProperty targetParameters) Sets the value ofCfnPipeMixinProps.getTargetParameters()- Parameters:
targetParameters- The parameters required to set up a target for your pipe. For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnPipeMixinProps>- Returns:
- a new instance of
CfnPipeMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-