Package software.amazon.awscdk.services.pipes

Class CfnPipe.Builder

java.lang.Object

software.amazon.awscdk.services.pipes.CfnPipe.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPipe>

Enclosing class:

CfnPipe

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

A fluent builder for CfnPipe.

Method Summary

Modifier and Type	Method	Description
CfnPipe	build()
static CfnPipe.Builder	create(software.constructs.Construct scope, String id)
CfnPipe.Builder	description(String description)	A description of the pipe.
CfnPipe.Builder	desiredState(String desiredState)	The state the pipe should be in.
CfnPipe.Builder	enrichment(String enrichment)	The ARN of the enrichment resource.
CfnPipe.Builder	enrichmentParameters(IResolvable enrichmentParameters)	The parameters required to set up enrichment on your pipe.
CfnPipe.Builder	enrichmentParameters(CfnPipe.PipeEnrichmentParametersProperty enrichmentParameters)	The parameters required to set up enrichment on your pipe.
CfnPipe.Builder	kmsKeyIdentifier(String kmsKeyIdentifier)	The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.
CfnPipe.Builder	logConfiguration(IResolvable logConfiguration)	The logging configuration settings for the pipe.
CfnPipe.Builder	logConfiguration(CfnPipe.PipeLogConfigurationProperty logConfiguration)	The logging configuration settings for the pipe.
CfnPipe.Builder	name(String name)	The name of the pipe.
CfnPipe.Builder	roleArn(String roleArn)	The ARN of the role that allows the pipe to send data to the target.
CfnPipe.Builder	source(String source)	The ARN of the source resource.
CfnPipe.Builder	sourceParameters(IResolvable sourceParameters)	The parameters required to set up a source for your pipe.
CfnPipe.Builder	sourceParameters(CfnPipe.PipeSourceParametersProperty sourceParameters)	The parameters required to set up a source for your pipe.
CfnPipe.Builder	tags(Map<String,String> tags)	The list of key-value pairs to associate with the pipe.
CfnPipe.Builder	target(String target)	The ARN of the target resource.
CfnPipe.Builder	targetParameters(IResolvable targetParameters)	The parameters required to set up a target for your pipe.
CfnPipe.Builder	targetParameters(CfnPipe.PipeTargetParametersProperty targetParameters)	The parameters required to set up a target for your pipe.

Methods inherited from class java.lang.Object

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

Method Details

create

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

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.

Returns:

a new instance of CfnPipe.Builder.

roleArn

@Stability(Stable)
public CfnPipe.Builder roleArn(String roleArn)

The ARN of the role that allows the pipe to send data to the target.

Parameters:

roleArn - The ARN of the role that allows the pipe to send data to the target. This parameter is required.

Returns:

this

See Also:

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

source

@Stability(Stable)
public CfnPipe.Builder source(String source)

The ARN of the source resource.

Parameters:

source - The ARN of the source resource. This parameter is required.

Returns:

this

See Also:

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

target

@Stability(Stable)
public CfnPipe.Builder target(String target)

The ARN of the target resource.

Parameters:

target - The ARN of the target resource. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnPipe.Builder description(String description)

A description of the pipe.

Parameters:

description - A description of 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-description

desiredState

@Stability(Stable)
public CfnPipe.Builder desiredState(String desiredState)

The state the pipe should be in.

Parameters:

desiredState - The state the pipe should be in. This parameter is required.

Returns:

this

See Also:

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

enrichment

@Stability(Stable)
public CfnPipe.Builder enrichment(String enrichment)

The ARN of the enrichment resource.

Parameters:

enrichment - The ARN of the enrichment resource. This parameter is required.

Returns:

this

See Also:

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

enrichmentParameters

@Stability(Stable)
public CfnPipe.Builder enrichmentParameters(IResolvable enrichmentParameters)

The parameters required to set up enrichment on your pipe.

Parameters:

enrichmentParameters - The parameters required to set up enrichment on your 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-enrichmentparameters

enrichmentParameters

@Stability(Stable)
public CfnPipe.Builder enrichmentParameters(CfnPipe.PipeEnrichmentParametersProperty enrichmentParameters)

The parameters required to set up enrichment on your pipe.

Parameters:

enrichmentParameters - The parameters required to set up enrichment on your 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-enrichmentparameters

kmsKeyIdentifier

@Stability(Stable)
public CfnPipe.Builder kmsKeyIdentifier(String kmsKeyIdentifier)

The identifier of the AWS KMS 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 .

Parameters:

kmsKeyIdentifier - The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. This parameter is required.

Returns:

this

See Also:

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

logConfiguration

@Stability(Stable)
public CfnPipe.Builder logConfiguration(IResolvable logConfiguration)

The logging configuration settings for the pipe.

Parameters:

logConfiguration - The logging configuration settings for 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-logconfiguration

logConfiguration

@Stability(Stable)
public CfnPipe.Builder logConfiguration(CfnPipe.PipeLogConfigurationProperty logConfiguration)

The logging configuration settings for the pipe.

Parameters:

logConfiguration - The logging configuration settings for 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-logconfiguration

name

@Stability(Stable)
public CfnPipe.Builder name(String name)

The name of the pipe.

Parameters:

name - The name of 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-name

sourceParameters

@Stability(Stable)
public CfnPipe.Builder sourceParameters(IResolvable sourceParameters)

The parameters required to set up a source for your pipe.

Parameters:

sourceParameters - The parameters required to set up a source for your 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-sourceparameters

sourceParameters

@Stability(Stable)
public CfnPipe.Builder sourceParameters(CfnPipe.PipeSourceParametersProperty sourceParameters)

The parameters required to set up a source for your pipe.

Parameters:

sourceParameters - The parameters required to set up a source for your 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-sourceparameters

tags

@Stability(Stable)
public CfnPipe.Builder tags(Map<String,String> tags)

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

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

targetParameters

@Stability(Stable)
public CfnPipe.Builder targetParameters(IResolvable 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 .

Parameters:

targetParameters - The parameters required to set up a target for your 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-targetparameters

targetParameters

@Stability(Stable)
public CfnPipe.Builder targetParameters(CfnPipe.PipeTargetParametersProperty 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 .

Parameters:

targetParameters - The parameters required to set up a target for your 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-targetparameters

build

@Stability(Stable)
public CfnPipe build()

Specified by:

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

Returns:

a newly built instance of CfnPipe.