Package software.amazon.awscdk.services.pipes

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnPipeProps	build()	Builds the configured instance.
CfnPipeProps.Builder	description(String description)	Sets the value of CfnPipeProps.getDescription()
CfnPipeProps.Builder	desiredState(String desiredState)	Sets the value of CfnPipeProps.getDesiredState()
CfnPipeProps.Builder	enrichment(String enrichment)	Sets the value of CfnPipeProps.getEnrichment()
CfnPipeProps.Builder	enrichmentParameters(IResolvable enrichmentParameters)	Sets the value of CfnPipeProps.getEnrichmentParameters()
CfnPipeProps.Builder	enrichmentParameters(CfnPipe.PipeEnrichmentParametersProperty enrichmentParameters)	Sets the value of CfnPipeProps.getEnrichmentParameters()
CfnPipeProps.Builder	kmsKeyIdentifier(String kmsKeyIdentifier)	Sets the value of CfnPipeProps.getKmsKeyIdentifier()
CfnPipeProps.Builder	logConfiguration(IResolvable logConfiguration)	Sets the value of CfnPipeProps.getLogConfiguration()
CfnPipeProps.Builder	logConfiguration(CfnPipe.PipeLogConfigurationProperty logConfiguration)	Sets the value of CfnPipeProps.getLogConfiguration()
CfnPipeProps.Builder	name(String name)	Sets the value of CfnPipeProps.getName()
CfnPipeProps.Builder	roleArn(String roleArn)	Sets the value of CfnPipeProps.getRoleArn()
CfnPipeProps.Builder	source(String source)	Sets the value of CfnPipeProps.getSource()
CfnPipeProps.Builder	sourceParameters(IResolvable sourceParameters)	Sets the value of CfnPipeProps.getSourceParameters()
CfnPipeProps.Builder	sourceParameters(CfnPipe.PipeSourceParametersProperty sourceParameters)	Sets the value of CfnPipeProps.getSourceParameters()
CfnPipeProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnPipeProps.getTags()
CfnPipeProps.Builder	target(String target)	Sets the value of CfnPipeProps.getTarget()
CfnPipeProps.Builder	targetParameters(IResolvable targetParameters)	Sets the value of CfnPipeProps.getTargetParameters()
CfnPipeProps.Builder	targetParameters(CfnPipe.PipeTargetParametersProperty targetParameters)	Sets the value of CfnPipeProps.getTargetParameters()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

roleArn

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

Sets the value of CfnPipeProps.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

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

Sets the value of CfnPipeProps.getSource()

Parameters:

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

Returns:

this

target

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

Sets the value of CfnPipeProps.getTarget()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnPipeProps.getDescription()

Parameters:

description - A description of the pipe.

Returns:

this

desiredState

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

Sets the value of CfnPipeProps.getDesiredState()

Parameters:

desiredState - The state the pipe should be in.

Returns:

this

enrichment

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

Sets the value of CfnPipeProps.getEnrichment()

Parameters:

enrichment - The ARN of the enrichment resource.

Returns:

this

enrichmentParameters

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

Sets the value of CfnPipeProps.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 of CfnPipeProps.getEnrichmentParameters()

Parameters:

enrichmentParameters - The parameters required to set up enrichment on your pipe.

Returns:

this

kmsKeyIdentifier

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

Sets the value of CfnPipeProps.getKmsKeyIdentifier()

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. 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

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

Sets the value of CfnPipeProps.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 of CfnPipeProps.getLogConfiguration()

Parameters:

logConfiguration - The logging configuration settings for the pipe.

Returns:

this

name

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

Sets the value of CfnPipeProps.getName()

Parameters:

name - The name of the pipe.

Returns:

this

sourceParameters

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

Sets the value of CfnPipeProps.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 of CfnPipeProps.getSourceParameters()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnPipeProps.getTags()

Parameters:

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

Returns:

this

targetParameters

@Stability(Stable)
public CfnPipeProps.Builder targetParameters(IResolvable targetParameters)

Sets the value of CfnPipeProps.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 of CfnPipeProps.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

@Stability(Stable)
public CfnPipeProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnPipeProps

Throws:

NullPointerException - if any required attribute was not provided