Class CfnPipeProps.Builder
java.lang.Object
software.amazon.awscdk.services.pipes.CfnPipeProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPipeProps>
- Enclosing interface:
CfnPipeProps
@Stability(Stable)
public static final class CfnPipeProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPipeProps>
A builder for
CfnPipeProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.description
(String description) Sets the value ofCfnPipeProps.getDescription()
desiredState
(String desiredState) Sets the value ofCfnPipeProps.getDesiredState()
enrichment
(String enrichment) Sets the value ofCfnPipeProps.getEnrichment()
enrichmentParameters
(IResolvable enrichmentParameters) Sets the value ofCfnPipeProps.getEnrichmentParameters()
enrichmentParameters
(CfnPipe.PipeEnrichmentParametersProperty enrichmentParameters) Sets the value ofCfnPipeProps.getEnrichmentParameters()
logConfiguration
(IResolvable logConfiguration) Sets the value ofCfnPipeProps.getLogConfiguration()
logConfiguration
(CfnPipe.PipeLogConfigurationProperty logConfiguration) Sets the value ofCfnPipeProps.getLogConfiguration()
Sets the value ofCfnPipeProps.getName()
Sets the value ofCfnPipeProps.getRoleArn()
Sets the value ofCfnPipeProps.getSource()
sourceParameters
(IResolvable sourceParameters) Sets the value ofCfnPipeProps.getSourceParameters()
sourceParameters
(CfnPipe.PipeSourceParametersProperty sourceParameters) Sets the value ofCfnPipeProps.getSourceParameters()
Sets the value ofCfnPipeProps.getTags()
Sets the value ofCfnPipeProps.getTarget()
targetParameters
(IResolvable targetParameters) Sets the value ofCfnPipeProps.getTargetParameters()
targetParameters
(CfnPipe.PipeTargetParametersProperty targetParameters) Sets the value ofCfnPipeProps.getTargetParameters()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
roleArn
Sets the value ofCfnPipeProps.getRoleArn()
- Parameters:
roleArn
- The ARN of the role that allows the pipe to send data to the target. This parameter is required.- Returns:
this
-
source
Sets the value ofCfnPipeProps.getSource()
- Parameters:
source
- The ARN of the source resource. This parameter is required.- Returns:
this
-
target
Sets the value ofCfnPipeProps.getTarget()
- Parameters:
target
- The ARN of the target resource. This parameter is required.- Returns:
this
-
description
Sets the value ofCfnPipeProps.getDescription()
- Parameters:
description
- A description of the pipe.- Returns:
this
-
desiredState
Sets the value ofCfnPipeProps.getDesiredState()
- Parameters:
desiredState
- The state the pipe should be in.- Returns:
this
-
enrichment
Sets the value ofCfnPipeProps.getEnrichment()
- Parameters:
enrichment
- The ARN of the enrichment resource.- Returns:
this
-
enrichmentParameters
@Stability(Stable) public CfnPipeProps.Builder enrichmentParameters(IResolvable enrichmentParameters) Sets the value ofCfnPipeProps.getEnrichmentParameters()
- Parameters:
enrichmentParameters
- The parameters required to set up enrichment on your pipe.- Returns:
this
-
enrichmentParameters
@Stability(Stable) public CfnPipeProps.Builder enrichmentParameters(CfnPipe.PipeEnrichmentParametersProperty enrichmentParameters) Sets the value ofCfnPipeProps.getEnrichmentParameters()
- Parameters:
enrichmentParameters
- The parameters required to set up enrichment on your pipe.- Returns:
this
-
logConfiguration
Sets the value ofCfnPipeProps.getLogConfiguration()
- Parameters:
logConfiguration
- The logging configuration settings for the pipe.- Returns:
this
-
logConfiguration
@Stability(Stable) public CfnPipeProps.Builder logConfiguration(CfnPipe.PipeLogConfigurationProperty logConfiguration) Sets the value ofCfnPipeProps.getLogConfiguration()
- Parameters:
logConfiguration
- The logging configuration settings for the pipe.- Returns:
this
-
name
Sets the value ofCfnPipeProps.getName()
- Parameters:
name
- The name of the pipe.- Returns:
this
-
sourceParameters
Sets the value ofCfnPipeProps.getSourceParameters()
- Parameters:
sourceParameters
- The parameters required to set up a source for your pipe.- Returns:
this
-
sourceParameters
@Stability(Stable) public CfnPipeProps.Builder sourceParameters(CfnPipe.PipeSourceParametersProperty sourceParameters) Sets the value ofCfnPipeProps.getSourceParameters()
- Parameters:
sourceParameters
- The parameters required to set up a source for your pipe.- Returns:
this
-
tags
Sets the value ofCfnPipeProps.getTags()
- Parameters:
tags
- The list of key-value pairs to associate with the pipe.- Returns:
this
-
targetParameters
Sets the value ofCfnPipeProps.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 CfnPipeProps.Builder targetParameters(CfnPipe.PipeTargetParametersProperty targetParameters) Sets the value ofCfnPipeProps.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:
build
in interfacesoftware.amazon.jsii.Builder<CfnPipeProps>
- Returns:
- a new instance of
CfnPipeProps
- Throws:
NullPointerException
- if any required attribute was not provided
-