Interface ChannelDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ChannelDescription.Builder,ChannelDescription>, SdkBuilder<ChannelDescription.Builder,ChannelDescription>, SdkPojo

Enclosing class:

ChannelDescription

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

Method Summary

Modifier and Type	Method	Description
ChannelDescription.Builder	channelARN(String channelARN)	The Amazon Resource Name (ARN) of the channel.
ChannelDescription.Builder	channelCreationTimestamp(Instant channelCreationTimestamp)	The time at which the channel was created.
ChannelDescription.Builder	channelId(String channelId)	The unique identifier of the channel.
ChannelDescription.Builder	channelName(String channelName)	The name of the channel.
ChannelDescription.Builder	channelStatus(String channelStatus)	The current status of the channel.
ChannelDescription.Builder	channelStatus(ChannelStatus channelStatus)	The current status of the channel.
ChannelDescription.Builder	channelStatusReason(String channelStatusReason)	A message describing the reason for a FAILED status.
default ChannelDescription.Builder	encryptionConfiguration(Consumer<ChannelEncryptionConfiguration.Builder> encryptionConfiguration)	The server-side encryption configuration for the channel.
ChannelDescription.Builder	encryptionConfiguration(ChannelEncryptionConfiguration encryptionConfiguration)	The server-side encryption configuration for the channel.
default ChannelDescription.Builder	loggingConfiguration(Consumer<ChannelLoggingConfiguration.Builder> loggingConfiguration)	The Amazon CloudWatch Logs configuration for the channel.
ChannelDescription.Builder	loggingConfiguration(ChannelLoggingConfiguration loggingConfiguration)	The Amazon CloudWatch Logs configuration for the channel.
default ChannelDescription.Builder	s3DestinationConfiguration(Consumer<S3DestinationDescription.Builder> s3DestinationConfiguration)	The configuration for delivery to a general purpose Amazon S3 bucket.
ChannelDescription.Builder	s3DestinationConfiguration(S3DestinationDescription s3DestinationConfiguration)	The configuration for delivery to a general purpose Amazon S3 bucket.
default ChannelDescription.Builder	s3TablesDestinationConfiguration(Consumer<S3TablesDestinationDescription.Builder> s3TablesDestinationConfiguration)	The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables.
ChannelDescription.Builder	s3TablesDestinationConfiguration(S3TablesDestinationDescription s3TablesDestinationConfiguration)	The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables.
ChannelDescription.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.
ChannelDescription.Builder	streamConfigurationList(Collection<ChannelStreamDescription> streamConfigurationList)	The source stream configuration for the channel.
ChannelDescription.Builder	streamConfigurationList(Consumer<ChannelStreamDescription.Builder>... streamConfigurationList)	The source stream configuration for the channel.
ChannelDescription.Builder	streamConfigurationList(ChannelStreamDescription... streamConfigurationList)	The source stream configuration for the channel.

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

copy

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

ChannelDescription.Builder channelName(String channelName)

The name of the channel.

Parameters:

channelName - The name of the channel.

Returns:

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

channelARN

ChannelDescription.Builder channelARN(String channelARN)

The Amazon Resource Name (ARN) of the channel.

Parameters:

channelARN - The Amazon Resource Name (ARN) of the channel.

Returns:

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

channelId

ChannelDescription.Builder channelId(String channelId)

The unique identifier of the channel.

Parameters:

channelId - The unique identifier of the channel.

Returns:

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

channelStatus

ChannelDescription.Builder channelStatus(String channelStatus)

The current status of the channel. Valid values:

• CREATING - The channel is being created.

• ACTIVE - The channel is ready to deliver records.

• UPDATING - The channel configuration is being updated.

• DELETING - The channel is being deleted.

• FAILED - See ChannelStatusReason for the failure cause.

Parameters:

channelStatus - The current status of the channel. Valid values:

• CREATING - The channel is being created.

• ACTIVE - The channel is ready to deliver records.

• UPDATING - The channel configuration is being updated.

• DELETING - The channel is being deleted.

• FAILED - See ChannelStatusReason for the failure cause.

Returns:

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

See Also:

• ChannelStatus
• ChannelStatus

channelStatus

ChannelDescription.Builder channelStatus(ChannelStatus channelStatus)

The current status of the channel. Valid values:

• CREATING - The channel is being created.

• ACTIVE - The channel is ready to deliver records.

• UPDATING - The channel configuration is being updated.

• DELETING - The channel is being deleted.

• FAILED - See ChannelStatusReason for the failure cause.

Parameters:

channelStatus - The current status of the channel. Valid values:

• CREATING - The channel is being created.

• ACTIVE - The channel is ready to deliver records.

• UPDATING - The channel configuration is being updated.

• DELETING - The channel is being deleted.

• FAILED - See ChannelStatusReason for the failure cause.

Returns:

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

See Also:

• ChannelStatus
• ChannelStatus

channelStatusReason

ChannelDescription.Builder channelStatusReason(String channelStatusReason)

A message describing the reason for a FAILED status.

Parameters:

channelStatusReason - A message describing the reason for a FAILED status.

Returns:

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

channelCreationTimestamp

ChannelDescription.Builder channelCreationTimestamp(Instant channelCreationTimestamp)

The time at which the channel was created.

Parameters:

channelCreationTimestamp - The time at which the channel was created.

Returns:

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

serviceExecutionRoleARN

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

ChannelDescription.Builder streamConfigurationList(Collection<ChannelStreamDescription> streamConfigurationList)

The source stream configuration for the channel.

Parameters:

streamConfigurationList - The source stream configuration for the channel.

Returns:

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

streamConfigurationList

ChannelDescription.Builder streamConfigurationList(ChannelStreamDescription... streamConfigurationList)

The source stream configuration for the channel.

Parameters:

streamConfigurationList - The source stream configuration for the channel.

Returns:

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

streamConfigurationList

ChannelDescription.Builder streamConfigurationList(Consumer<ChannelStreamDescription.Builder>... streamConfigurationList)

The source stream configuration for the channel.

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

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

Parameters:

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

Returns:

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

See Also:

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

s3DestinationConfiguration

ChannelDescription.Builder s3DestinationConfiguration(S3DestinationDescription s3DestinationConfiguration)

The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

Parameters:

s3DestinationConfiguration - The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

Returns:

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

s3DestinationConfiguration

default ChannelDescription.Builder s3DestinationConfiguration(Consumer<S3DestinationDescription.Builder> s3DestinationConfiguration)

The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

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

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

Parameters:

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

Returns:

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

See Also:

• s3DestinationConfiguration(S3DestinationDescription)

s3TablesDestinationConfiguration

ChannelDescription.Builder s3TablesDestinationConfiguration(S3TablesDestinationDescription s3TablesDestinationConfiguration)

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

Parameters:

s3TablesDestinationConfiguration - The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

Returns:

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

s3TablesDestinationConfiguration

default ChannelDescription.Builder s3TablesDestinationConfiguration(Consumer<S3TablesDestinationDescription.Builder> s3TablesDestinationConfiguration)

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

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

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

Parameters:

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

Returns:

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

See Also:

• s3TablesDestinationConfiguration(S3TablesDestinationDescription)

encryptionConfiguration

ChannelDescription.Builder encryptionConfiguration(ChannelEncryptionConfiguration encryptionConfiguration)

The server-side encryption configuration for the channel.

Parameters:

encryptionConfiguration - The server-side encryption configuration for the channel.

Returns:

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

encryptionConfiguration

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

The server-side encryption configuration for the channel.

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)

loggingConfiguration

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