Class PipeProps.Builder
java.lang.Object
software.amazon.awscdk.services.pipes.alpha.PipeProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<PipeProps>
- Enclosing interface:
PipeProps
@Stability(Experimental)
public static final class PipeProps.Builder
extends Object
implements software.amazon.jsii.Builder<PipeProps>
A builder for
PipeProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.description
(String description) Sets the value ofPipeProps.getDescription()
desiredState
(DesiredState desiredState) Sets the value ofPipeProps.getDesiredState()
enrichment
(IEnrichment enrichment) Sets the value ofPipeProps.getEnrichment()
Sets the value ofPipeProps.getFilter()
logDestinations
(List<? extends ILogDestination> logDestinations) Sets the value ofPipeProps.getLogDestinations()
logIncludeExecutionData
(List<? extends IncludeExecutionData> logIncludeExecutionData) Sets the value ofPipeProps.getLogIncludeExecutionData()
Sets the value ofPipeProps.getLogLevel()
Sets the value ofPipeProps.getPipeName()
Sets the value ofPipeProps.getRole()
Sets the value ofPipeProps.getSource()
Sets the value ofPipeProps.getTags()
Sets the value ofPipeProps.getTarget()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
source
Sets the value ofPipeProps.getSource()
- Parameters:
source
- The source of the pipe. This parameter is required.- Returns:
this
-
target
Sets the value ofPipeProps.getTarget()
- Parameters:
target
- The target of the pipe. This parameter is required.- Returns:
this
-
description
Sets the value ofPipeProps.getDescription()
- Parameters:
description
- A description of the pipe displayed in the AWS console.- Returns:
this
-
desiredState
Sets the value ofPipeProps.getDesiredState()
- Parameters:
desiredState
- The desired state of the pipe. If the state is set to STOPPED, the pipe will not process events.- Returns:
this
-
enrichment
Sets the value ofPipeProps.getEnrichment()
- Parameters:
enrichment
- Enrichment step to enhance the data from the source before sending it to the target.- Returns:
this
-
filter
Sets the value ofPipeProps.getFilter()
- Parameters:
filter
- The filter pattern for the pipe source.- Returns:
this
-
logDestinations
@Stability(Experimental) public PipeProps.Builder logDestinations(List<? extends ILogDestination> logDestinations) Sets the value ofPipeProps.getLogDestinations()
- Parameters:
logDestinations
- Destinations for the logs.- Returns:
this
-
logIncludeExecutionData
@Stability(Experimental) public PipeProps.Builder logIncludeExecutionData(List<? extends IncludeExecutionData> logIncludeExecutionData) Sets the value ofPipeProps.getLogIncludeExecutionData()
- Parameters:
logIncludeExecutionData
- Whether the execution data (specifically, thepayload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe. This applies to all log destinations for the pipe.For more information, see Including execution data in logs and the message schema in the Amazon EventBridge User Guide .
- Returns:
this
-
logLevel
Sets the value ofPipeProps.getLogLevel()
- Parameters:
logLevel
- The level of logging detail to include. This applies to all log destinations for the pipe.- Returns:
this
-
pipeName
Sets the value ofPipeProps.getPipeName()
- Parameters:
pipeName
- Name of the pipe in the AWS console.- Returns:
this
-
role
Sets the value ofPipeProps.getRole()
- Parameters:
role
- The role used by the pipe which has permissions to read from the source and write to the target. If an enriched target is used, the role also have permissions to call the enriched target. If no role is provided, a role will be created.- Returns:
this
-
tags
Sets the value ofPipeProps.getTags()
- Parameters:
tags
- The list of key-value pairs to associate with the pipe.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<PipeProps>
- Returns:
- a new instance of
PipeProps
- Throws:
NullPointerException
- if any required attribute was not provided
-