public static interface StreamDescriptionSummary.Builder extends SdkPojo, CopyableBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>
Modifier and Type | Method and Description |
---|---|
StreamDescriptionSummary.Builder |
consumerCount(Integer consumerCount)
The number of enhanced fan-out consumers registered with the stream.
|
StreamDescriptionSummary.Builder |
encryptionType(EncryptionType encryptionType)
The encryption type used.
|
StreamDescriptionSummary.Builder |
encryptionType(String encryptionType)
The encryption type used.
|
StreamDescriptionSummary.Builder |
enhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescriptionSummary.Builder |
enhancedMonitoring(Consumer<EnhancedMetrics.Builder>... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescriptionSummary.Builder |
enhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescriptionSummary.Builder |
keyId(String keyId)
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
StreamDescriptionSummary.Builder |
openShardCount(Integer openShardCount)
The number of open shards in the stream.
|
StreamDescriptionSummary.Builder |
retentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
|
StreamDescriptionSummary.Builder |
streamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
|
StreamDescriptionSummary.Builder |
streamCreationTimestamp(Instant streamCreationTimestamp)
The approximate time that the stream was created.
|
default StreamDescriptionSummary.Builder |
streamModeDetails(Consumer<StreamModeDetails.Builder> streamModeDetails)
Specifies the capacity mode to which you want to set your data stream.
|
StreamDescriptionSummary.Builder |
streamModeDetails(StreamModeDetails streamModeDetails)
Specifies the capacity mode to which you want to set your data stream.
|
StreamDescriptionSummary.Builder |
streamName(String streamName)
The name of the stream being described.
|
StreamDescriptionSummary.Builder |
streamStatus(StreamStatus streamStatus)
The current status of the stream being described.
|
StreamDescriptionSummary.Builder |
streamStatus(String streamStatus)
The current status of the stream being described.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
StreamDescriptionSummary.Builder streamName(String streamName)
The name of the stream being described.
streamName
- The name of the stream being described.StreamDescriptionSummary.Builder streamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
streamARN
- The Amazon Resource Name (ARN) for the stream being described.StreamDescriptionSummary.Builder streamStatus(String streamStatus)
The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Kinesis Data Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Kinesis Data Streams completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to
work while the stream is in the UPDATING
state.
streamStatus
- The current status of the stream being described. The stream status is one of the following
states:
CREATING
- The stream is being created. Kinesis Data Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the
DELETING
state until Kinesis Data Streams completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You
should perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations
continue to work while the stream is in the UPDATING
state.
StreamStatus
,
StreamStatus
StreamDescriptionSummary.Builder streamStatus(StreamStatus streamStatus)
The current status of the stream being described. The stream status is one of the following states:
CREATING
- The stream is being created. Kinesis Data Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the DELETING
state until Kinesis Data Streams completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You should
perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to
work while the stream is in the UPDATING
state.
streamStatus
- The current status of the stream being described. The stream status is one of the following
states:
CREATING
- The stream is being created. Kinesis Data Streams immediately returns and sets
StreamStatus
to CREATING
.
DELETING
- The stream is being deleted. The specified stream is in the
DELETING
state until Kinesis Data Streams completes the deletion.
ACTIVE
- The stream exists and is ready for read and write operations or deletion. You
should perform read and write operations only on an ACTIVE
stream.
UPDATING
- Shards in the stream are being merged or split. Read and write operations
continue to work while the stream is in the UPDATING
state.
StreamStatus
,
StreamStatus
StreamDescriptionSummary.Builder streamModeDetails(StreamModeDetails streamModeDetails)
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
streamModeDetails
- Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data
Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity
mode for your data streams.default StreamDescriptionSummary.Builder streamModeDetails(Consumer<StreamModeDetails.Builder> streamModeDetails)
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
This is a convenience method that creates an instance of theStreamModeDetails.Builder
avoiding the
need to create one manually via StreamModeDetails.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to streamModeDetails(StreamModeDetails)
.
streamModeDetails
- a consumer that will call methods on StreamModeDetails.Builder
streamModeDetails(StreamModeDetails)
StreamDescriptionSummary.Builder retentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
retentionPeriodHours
- The current retention period, in hours.StreamDescriptionSummary.Builder streamCreationTimestamp(Instant streamCreationTimestamp)
The approximate time that the stream was created.
streamCreationTimestamp
- The approximate time that the stream was created.StreamDescriptionSummary.Builder enhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.StreamDescriptionSummary.Builder enhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.StreamDescriptionSummary.Builder enhancedMonitoring(Consumer<EnhancedMetrics.Builder>... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
This is a convenience method that creates an instance of theEnhancedMetrics.Builder
avoiding the need to create one
manually via EnhancedMetrics.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately
and its result is passed to #enhancedMonitoring(List
.
enhancedMonitoring
- a consumer that will call methods on
EnhancedMetrics.Builder
#enhancedMonitoring(java.util.Collection)
StreamDescriptionSummary.Builder encryptionType(String encryptionType)
The encryption type used. This value is one of the following:
KMS
NONE
encryptionType
- The encryption type used. This value is one of the following:
KMS
NONE
EncryptionType
,
EncryptionType
StreamDescriptionSummary.Builder encryptionType(EncryptionType encryptionType)
The encryption type used. This value is one of the following:
KMS
NONE
encryptionType
- The encryption type used. This value is one of the following:
KMS
NONE
EncryptionType
,
EncryptionType
StreamDescriptionSummary.Builder keyId(String keyId)
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a
globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by
"alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
aws/kinesis
.
Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis
keyId
- The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be
a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name
prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the
alias aws/kinesis
.
Key ARN example:
arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally unique key ID example: 12345678-1234-1234-1234-123456789012
Alias name example: alias/MyAliasName
Master key owned by Kinesis Data Streams: alias/aws/kinesis
StreamDescriptionSummary.Builder openShardCount(Integer openShardCount)
The number of open shards in the stream.
openShardCount
- The number of open shards in the stream.StreamDescriptionSummary.Builder consumerCount(Integer consumerCount)
The number of enhanced fan-out consumers registered with the stream.
consumerCount
- The number of enhanced fan-out consumers registered with the stream.Copyright © 2023. All rights reserved.