Interface CreatePipeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreatePipeRequest.Builder,CreatePipeRequest>, PipesRequest.Builder, SdkBuilder<CreatePipeRequest.Builder,CreatePipeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreatePipeRequest

@Mutable
@NotThreadSafe
public static interface CreatePipeRequest.Builder
extends PipesRequest.Builder, SdkPojo, CopyableBuilder<CreatePipeRequest.Builder,CreatePipeRequest>

Method Summary

Modifier and Type	Method	Description
CreatePipeRequest.Builder	description(String description)	A description of the pipe.
CreatePipeRequest.Builder	desiredState(String desiredState)	The state the pipe should be in.
CreatePipeRequest.Builder	desiredState(RequestedPipeState desiredState)	The state the pipe should be in.
CreatePipeRequest.Builder	enrichment(String enrichment)	The ARN of the enrichment resource.
default CreatePipeRequest.Builder	enrichmentParameters(Consumer<PipeEnrichmentParameters.Builder> enrichmentParameters)	The parameters required to set up enrichment on your pipe.
CreatePipeRequest.Builder	enrichmentParameters(PipeEnrichmentParameters enrichmentParameters)	The parameters required to set up enrichment on your pipe.
CreatePipeRequest.Builder	kmsKeyIdentifier(String kmsKeyIdentifier)	The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.
default CreatePipeRequest.Builder	logConfiguration(Consumer<PipeLogConfigurationParameters.Builder> logConfiguration)	The logging configuration settings for the pipe.
CreatePipeRequest.Builder	logConfiguration(PipeLogConfigurationParameters logConfiguration)	The logging configuration settings for the pipe.
CreatePipeRequest.Builder	name(String name)	The name of the pipe.
CreatePipeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreatePipeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreatePipeRequest.Builder	roleArn(String roleArn)	The ARN of the role that allows the pipe to send data to the target.
CreatePipeRequest.Builder	source(String source)	The ARN of the source resource.
default CreatePipeRequest.Builder	sourceParameters(Consumer<PipeSourceParameters.Builder> sourceParameters)	The parameters required to set up a source for your pipe.
CreatePipeRequest.Builder	sourceParameters(PipeSourceParameters sourceParameters)	The parameters required to set up a source for your pipe.
CreatePipeRequest.Builder	tags(Map<String,String> tags)	The list of key-value pairs to associate with the pipe.
CreatePipeRequest.Builder	target(String target)	The ARN of the target resource.
default CreatePipeRequest.Builder	targetParameters(Consumer<PipeTargetParameters.Builder> targetParameters)	The parameters required to set up a target for your pipe.
CreatePipeRequest.Builder	targetParameters(PipeTargetParameters targetParameters)	The parameters required to set up a target for your pipe.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.pipes.model.PipesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

name

CreatePipeRequest.Builder name(String name)

The name of the pipe.

Parameters:

name - The name of the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreatePipeRequest.Builder description(String description)

A description of the pipe.

Parameters:

description - A description of the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

desiredState

CreatePipeRequest.Builder desiredState(String desiredState)

The state the pipe should be in.

Parameters:

desiredState - The state the pipe should be in.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RequestedPipeState
• RequestedPipeState

desiredState

CreatePipeRequest.Builder desiredState(RequestedPipeState desiredState)

The state the pipe should be in.

Parameters:

desiredState - The state the pipe should be in.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RequestedPipeState
• RequestedPipeState

source

CreatePipeRequest.Builder source(String source)

The ARN of the source resource.

Parameters:

source - The ARN of the source resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceParameters

CreatePipeRequest.Builder sourceParameters(PipeSourceParameters 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceParameters

default CreatePipeRequest.Builder sourceParameters(Consumer<PipeSourceParameters.Builder> sourceParameters)

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

This is a convenience method that creates an instance of the PipeSourceParameters.Builder avoiding the need to create one manually via PipeSourceParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceParameters(PipeSourceParameters).

Parameters:

sourceParameters - a consumer that will call methods on PipeSourceParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sourceParameters(PipeSourceParameters)

enrichment

CreatePipeRequest.Builder enrichment(String enrichment)

The ARN of the enrichment resource.

Parameters:

enrichment - The ARN of the enrichment resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

enrichmentParameters

CreatePipeRequest.Builder enrichmentParameters(PipeEnrichmentParameters enrichmentParameters)

The parameters required to set up enrichment on your pipe.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

enrichmentParameters

default CreatePipeRequest.Builder enrichmentParameters(Consumer<PipeEnrichmentParameters.Builder> enrichmentParameters)

The parameters required to set up enrichment on your pipe.

This is a convenience method that creates an instance of the PipeEnrichmentParameters.Builder avoiding the need to create one manually via PipeEnrichmentParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to enrichmentParameters(PipeEnrichmentParameters).

Parameters:

enrichmentParameters - a consumer that will call methods on PipeEnrichmentParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• enrichmentParameters(PipeEnrichmentParameters)

target

CreatePipeRequest.Builder target(String target)

The ARN of the target resource.

Parameters:

target - The ARN of the target resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetParameters

CreatePipeRequest.Builder targetParameters(PipeTargetParameters 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.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetParameters

default CreatePipeRequest.Builder targetParameters(Consumer<PipeTargetParameters.Builder> 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.

This is a convenience method that creates an instance of the PipeTargetParameters.Builder avoiding the need to create one manually via PipeTargetParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetParameters(PipeTargetParameters).

Parameters:

targetParameters - a consumer that will call methods on PipeTargetParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• targetParameters(PipeTargetParameters)

roleArn

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

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

Returns:

Returns a reference to this object so that method calls can be chained together.

logConfiguration

CreatePipeRequest.Builder logConfiguration(PipeLogConfigurationParameters logConfiguration)

The logging configuration settings for the pipe.

Parameters:

logConfiguration - The logging configuration settings for the pipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

logConfiguration

default CreatePipeRequest.Builder logConfiguration(Consumer<PipeLogConfigurationParameters.Builder> logConfiguration)

The logging configuration settings for the pipe.

This is a convenience method that creates an instance of the PipeLogConfigurationParameters.Builder avoiding the need to create one manually via PipeLogConfigurationParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logConfiguration(PipeLogConfigurationParameters).

Parameters:

logConfiguration - a consumer that will call methods on PipeLogConfigurationParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• logConfiguration(PipeLogConfigurationParameters)

kmsKeyIdentifier

CreatePipeRequest.Builder kmsKeyIdentifier(String kmsKeyIdentifier)

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

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.

For more information, see Managing keys in the Key Management Service Developer Guide.

Parameters:

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

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.

For more information, see Managing keys in the Key Management Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreatePipeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreatePipeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.