Interface UpdatePipeRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdatePipeRequest

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

Method Summary

Modifier and Type	Method	Description
UpdatePipeRequest.Builder	description(String description)	A description of the pipe.
UpdatePipeRequest.Builder	desiredState(String desiredState)	The state the pipe should be in.
UpdatePipeRequest.Builder	desiredState(RequestedPipeState desiredState)	The state the pipe should be in.
UpdatePipeRequest.Builder	enrichment(String enrichment)	The ARN of the enrichment resource.
default UpdatePipeRequest.Builder	enrichmentParameters(Consumer<PipeEnrichmentParameters.Builder> enrichmentParameters)	The parameters required to set up enrichment on your pipe.
UpdatePipeRequest.Builder	enrichmentParameters(PipeEnrichmentParameters enrichmentParameters)	The parameters required to set up enrichment on your pipe.
UpdatePipeRequest.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 UpdatePipeRequest.Builder	logConfiguration(Consumer<PipeLogConfigurationParameters.Builder> logConfiguration)	The logging configuration settings for the pipe.
UpdatePipeRequest.Builder	logConfiguration(PipeLogConfigurationParameters logConfiguration)	The logging configuration settings for the pipe.
UpdatePipeRequest.Builder	name(String name)	The name of the pipe.
UpdatePipeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdatePipeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdatePipeRequest.Builder	roleArn(String roleArn)	The ARN of the role that allows the pipe to send data to the target.
default UpdatePipeRequest.Builder	sourceParameters(Consumer<UpdatePipeSourceParameters.Builder> sourceParameters)	The parameters required to set up a source for your pipe.
UpdatePipeRequest.Builder	sourceParameters(UpdatePipeSourceParameters sourceParameters)	The parameters required to set up a source for your pipe.
UpdatePipeRequest.Builder	target(String target)	The ARN of the target resource.
default UpdatePipeRequest.Builder	targetParameters(Consumer<PipeTargetParameters.Builder> targetParameters)	The parameters required to set up a target for your pipe.
UpdatePipeRequest.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

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

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

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

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

sourceParameters

UpdatePipeRequest.Builder sourceParameters(UpdatePipeSourceParameters 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 UpdatePipeRequest.Builder sourceParameters(Consumer<UpdatePipeSourceParameters.Builder> sourceParameters)

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

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

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

Parameters:

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

Returns:

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

See Also:

• sourceParameters(UpdatePipeSourceParameters)

enrichment

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

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

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

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

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

logConfiguration

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

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

To update a pipe that is using the default Amazon Web Services 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 Amazon Web Services owned key, specify an empty string.

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.

To update a pipe that is using the default Amazon Web Services 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 Amazon Web Services owned key, specify an empty string.

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

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

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