Interface CreateChannelRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>, KinesisRequest.Builder, SdkBuilder<CreateChannelRequest.Builder,CreateChannelRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateChannelRequest

@Mutable
@NotThreadSafe
public static interface CreateChannelRequest.Builder
extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Method Summary

Modifier and Type	Method	Description
CreateChannelRequest.Builder	channelName(String channelName)	The name of the channel.
default CreateChannelRequest.Builder	encryptionConfiguration(Consumer<ChannelEncryptionConfiguration.Builder> encryptionConfiguration)	The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.
CreateChannelRequest.Builder	encryptionConfiguration(ChannelEncryptionConfiguration encryptionConfiguration)	The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.
default CreateChannelRequest.Builder	loggingConfiguration(Consumer<ChannelLoggingConfiguration.Builder> loggingConfiguration)	The Amazon CloudWatch Logs configuration for the channel.
CreateChannelRequest.Builder	loggingConfiguration(ChannelLoggingConfiguration loggingConfiguration)	The Amazon CloudWatch Logs configuration for the channel.
CreateChannelRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateChannelRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateChannelRequest.Builder	s3DestinationConfiguration(Consumer<S3DestinationConfiguration.Builder> s3DestinationConfiguration)	The configuration for delivery to a general purpose Amazon S3 bucket.
CreateChannelRequest.Builder	s3DestinationConfiguration(S3DestinationConfiguration s3DestinationConfiguration)	The configuration for delivery to a general purpose Amazon S3 bucket.
default CreateChannelRequest.Builder	s3TablesDestinationConfiguration(Consumer<S3TablesDestinationConfiguration.Builder> s3TablesDestinationConfiguration)	The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables.
CreateChannelRequest.Builder	s3TablesDestinationConfiguration(S3TablesDestinationConfiguration s3TablesDestinationConfiguration)	The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables.
CreateChannelRequest.Builder	serviceExecutionRoleARN(String serviceExecutionRoleARN)	The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.
CreateChannelRequest.Builder	streamConfigurationList(Collection<ChannelStreamConfiguration> streamConfigurationList)	The source stream configuration for the channel.
CreateChannelRequest.Builder	streamConfigurationList(Consumer<ChannelStreamConfiguration.Builder>... streamConfigurationList)	The source stream configuration for the channel.
CreateChannelRequest.Builder	streamConfigurationList(ChannelStreamConfiguration... streamConfigurationList)	The source stream configuration for the channel.
CreateChannelRequest.Builder	tags(Map<String,String> tags)	A set of key-value pairs to assign to the channel.

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.kinesis.model.KinesisRequest.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

channelName

CreateChannelRequest.Builder channelName(String channelName)

The name of the channel. The name is unique within your Amazon Web Services account and Amazon Web Services Region.

Parameters:

channelName - The name of the channel. The name is unique within your Amazon Web Services account and Amazon Web Services Region.

Returns:

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

serviceExecutionRoleARN

CreateChannelRequest.Builder serviceExecutionRoleARN(String serviceExecutionRoleARN)

The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

Parameters:

serviceExecutionRoleARN - The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

Returns:

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

streamConfigurationList

CreateChannelRequest.Builder streamConfigurationList(Collection<ChannelStreamConfiguration> streamConfigurationList)

The source stream configuration for the channel. Currently, one stream is supported per channel.

Parameters:

streamConfigurationList - The source stream configuration for the channel. Currently, one stream is supported per channel.

Returns:

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

streamConfigurationList

CreateChannelRequest.Builder streamConfigurationList(ChannelStreamConfiguration... streamConfigurationList)

The source stream configuration for the channel. Currently, one stream is supported per channel.

Parameters:

streamConfigurationList - The source stream configuration for the channel. Currently, one stream is supported per channel.

Returns:

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

streamConfigurationList

CreateChannelRequest.Builder streamConfigurationList(Consumer<ChannelStreamConfiguration.Builder>... streamConfigurationList)

The source stream configuration for the channel. Currently, one stream is supported per channel.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to streamConfigurationList(List<ChannelStreamConfiguration>).

Parameters:

streamConfigurationList - a consumer that will call methods on ChannelStreamConfiguration.Builder

Returns:

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

See Also:

• streamConfigurationList(java.util.Collection<ChannelStreamConfiguration>)

s3DestinationConfiguration

CreateChannelRequest.Builder s3DestinationConfiguration(S3DestinationConfiguration s3DestinationConfiguration)

The configuration for delivery to a general purpose Amazon S3 bucket. You must specify either S3DestinationConfiguration or S3TablesDestinationConfiguration, but not both.

Parameters:

s3DestinationConfiguration - The configuration for delivery to a general purpose Amazon S3 bucket. You must specify either S3DestinationConfiguration or S3TablesDestinationConfiguration, but not both.

Returns:

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

s3DestinationConfiguration

default CreateChannelRequest.Builder s3DestinationConfiguration(Consumer<S3DestinationConfiguration.Builder> s3DestinationConfiguration)

The configuration for delivery to a general purpose Amazon S3 bucket. You must specify either S3DestinationConfiguration or S3TablesDestinationConfiguration, but not both.

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

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

Parameters:

s3DestinationConfiguration - a consumer that will call methods on S3DestinationConfiguration.Builder

Returns:

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

See Also:

• s3DestinationConfiguration(S3DestinationConfiguration)

s3TablesDestinationConfiguration

CreateChannelRequest.Builder s3TablesDestinationConfiguration(S3TablesDestinationConfiguration s3TablesDestinationConfiguration)

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. You must specify either S3DestinationConfiguration or S3TablesDestinationConfiguration, but not both.

Parameters:

s3TablesDestinationConfiguration - The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. You must specify either S3DestinationConfiguration or S3TablesDestinationConfiguration, but not both.

Returns:

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

s3TablesDestinationConfiguration

default CreateChannelRequest.Builder s3TablesDestinationConfiguration(Consumer<S3TablesDestinationConfiguration.Builder> s3TablesDestinationConfiguration)

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. You must specify either S3DestinationConfiguration or S3TablesDestinationConfiguration, but not both.

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

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

Parameters:

s3TablesDestinationConfiguration - a consumer that will call methods on S3TablesDestinationConfiguration.Builder

Returns:

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

See Also:

• s3TablesDestinationConfiguration(S3TablesDestinationConfiguration)

encryptionConfiguration

CreateChannelRequest.Builder encryptionConfiguration(ChannelEncryptionConfiguration encryptionConfiguration)

The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.

Parameters:

encryptionConfiguration - The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.

Returns:

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

encryptionConfiguration

default CreateChannelRequest.Builder encryptionConfiguration(Consumer<ChannelEncryptionConfiguration.Builder> encryptionConfiguration)

The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.

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

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

Parameters:

encryptionConfiguration - a consumer that will call methods on ChannelEncryptionConfiguration.Builder

Returns:

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

See Also:

• encryptionConfiguration(ChannelEncryptionConfiguration)

tags

CreateChannelRequest.Builder tags(Map<String,String> tags)

A set of key-value pairs to assign to the channel. A tag consists of a required key and an optional value.

Parameters:

tags - A set of key-value pairs to assign to the channel. A tag consists of a required key and an optional value.

Returns:

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

loggingConfiguration

CreateChannelRequest.Builder loggingConfiguration(ChannelLoggingConfiguration loggingConfiguration)

The Amazon CloudWatch Logs configuration for the channel.

Parameters:

loggingConfiguration - The Amazon CloudWatch Logs configuration for the channel.

Returns:

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

loggingConfiguration

default CreateChannelRequest.Builder loggingConfiguration(Consumer<ChannelLoggingConfiguration.Builder> loggingConfiguration)

The Amazon CloudWatch Logs configuration for the channel.

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

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

Parameters:

loggingConfiguration - a consumer that will call methods on ChannelLoggingConfiguration.Builder

Returns:

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

See Also:

• loggingConfiguration(ChannelLoggingConfiguration)

overrideConfiguration

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

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