Package software.amazon.awscdk.services.pipes.alpha

Class Pipe.Builder

java.lang.Object

software.amazon.awscdk.services.pipes.alpha.Pipe.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Pipe>

Enclosing class:

Pipe

@Stability(Experimental)
public static final class Pipe.Builder
extends Object
implements software.amazon.jsii.Builder<Pipe>

(experimental) A fluent builder for Pipe.

Method Summary

Modifier and Type	Method	Description
Pipe	build()
static Pipe.Builder	create(software.constructs.Construct scope, String id)
Pipe.Builder	description(String description)	(experimental) A description of the pipe displayed in the AWS console.
Pipe.Builder	desiredState(DesiredState desiredState)	(experimental) The desired state of the pipe.
Pipe.Builder	enrichment(IEnrichment enrichment)	(experimental) Enrichment step to enhance the data from the source before sending it to the target.
Pipe.Builder	filter(IFilter filter)	(experimental) The filter pattern for the pipe source.
Pipe.Builder	logDestinations(List<? extends ILogDestination> logDestinations)	(experimental) Destinations for the logs.
Pipe.Builder	logIncludeExecutionData(List<? extends IncludeExecutionData> logIncludeExecutionData)	(experimental) Whether the execution data (specifically, the payload , awsRequest , and awsResponse fields) is included in the log messages for this pipe.
Pipe.Builder	logLevel(LogLevel logLevel)	(experimental) The level of logging detail to include.
Pipe.Builder	pipeName(String pipeName)	(experimental) Name of the pipe in the AWS console.
Pipe.Builder	role(IRole role)	(experimental) The role used by the pipe which has permissions to read from the source and write to the target.
Pipe.Builder	source(ISource source)	(experimental) The source of the pipe.
Pipe.Builder	tags(Map<String,String> tags)	(experimental) The list of key-value pairs to associate with the pipe.
Pipe.Builder	target(ITarget target)	(experimental) The target of the pipe.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Experimental)
public static Pipe.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Pipe.Builder.

source

@Stability(Experimental)
public Pipe.Builder source(ISource source)

(experimental) The source of the pipe.

Parameters:

source - The source of the pipe. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-source.html

target

@Stability(Experimental)
public Pipe.Builder target(ITarget target)

(experimental) The target of the pipe.

Parameters:

target - The target of the pipe. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html

description

@Stability(Experimental)
public Pipe.Builder description(String description)

(experimental) A description of the pipe displayed in the AWS console.

Default: - no description

Parameters:

description - A description of the pipe displayed in the AWS console. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-description

desiredState

@Stability(Experimental)
public Pipe.Builder desiredState(DesiredState desiredState)

(experimental) The desired state of the pipe.

If the state is set to STOPPED, the pipe will not process events.

Default: - DesiredState.RUNNING

Parameters:

desiredState - The desired state of the pipe. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_Pipe.html#eventbridge-Type-Pipe-DesiredState

enrichment

@Stability(Experimental)
public Pipe.Builder enrichment(IEnrichment enrichment)

(experimental) Enrichment step to enhance the data from the source before sending it to the target.

Default: - no enrichment

Parameters:

enrichment - Enrichment step to enhance the data from the source before sending it to the target. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-enrichment.html

filter

@Stability(Experimental)
public Pipe.Builder filter(IFilter filter)

(experimental) The filter pattern for the pipe source.

Default: - no filter

Parameters:

filter - The filter pattern for the pipe source. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-filtering.html

logDestinations

@Stability(Experimental)
public Pipe.Builder logDestinations(List<? extends ILogDestination> logDestinations)

(experimental) Destinations for the logs.

Default: - no logs

Parameters:

logDestinations - Destinations for the logs. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html

logIncludeExecutionData

@Stability(Experimental)
public Pipe.Builder logIncludeExecutionData(List<? extends IncludeExecutionData> logIncludeExecutionData)

(experimental) Whether the execution data (specifically, the payload , awsRequest , and awsResponse 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 .

Default: - none

Parameters:

logIncludeExecutionData - Whether the execution data (specifically, the payload , awsRequest , and awsResponse fields) is included in the log messages for this pipe. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata

logLevel

@Stability(Experimental)
public Pipe.Builder logLevel(LogLevel logLevel)

(experimental) The level of logging detail to include.

This applies to all log destinations for the pipe.

Default: - LogLevel.ERROR

Parameters:

logLevel - The level of logging detail to include. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html

pipeName

@Stability(Experimental)
public Pipe.Builder pipeName(String pipeName)

(experimental) Name of the pipe in the AWS console.

Default: - automatically generated name

Parameters:

pipeName - Name of the pipe in the AWS console. This parameter is required.

Returns:

this

role

@Stability(Experimental)
public Pipe.Builder role(IRole role)

(experimental) 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.

Default: - a new role will be created.

Parameters:

role - The role used by the pipe which has permissions to read from the source and write to the target. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-permissions.html

tags

@Stability(Experimental)
public Pipe.Builder tags(Map<String,String> tags)

(experimental) The list of key-value pairs to associate with the pipe.

Default: - no tags

Parameters:

tags - The list of key-value pairs to associate with the pipe. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-tags

build

@Stability(Experimental)
public Pipe build()

Specified by:

build in interface software.amazon.jsii.Builder<Pipe>

Returns:

a newly built instance of Pipe.