public static interface StreamDescription.Builder extends SdkPojo, CopyableBuilder<StreamDescription.Builder,StreamDescription>
Modifier and Type | Method and Description |
---|---|
StreamDescription.Builder |
encryptionType(EncryptionType encryptionType)
The server-side encryption type used on the stream.
|
StreamDescription.Builder |
encryptionType(String encryptionType)
The server-side encryption type used on the stream.
|
StreamDescription.Builder |
enhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription.Builder |
enhancedMonitoring(Consumer<EnhancedMetrics.Builder>... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription.Builder |
enhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription.Builder |
hasMoreShards(Boolean hasMoreShards)
If set to
true , more shards in the stream are available to describe. |
StreamDescription.Builder |
keyId(String keyId)
The GUID for the customer-managed AWS KMS key to use for encryption.
|
StreamDescription.Builder |
retentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
|
StreamDescription.Builder |
shards(Collection<Shard> shards)
The shards that comprise the stream.
|
StreamDescription.Builder |
shards(Consumer<Shard.Builder>... shards)
The shards that comprise the stream.
|
StreamDescription.Builder |
shards(Shard... shards)
The shards that comprise the stream.
|
StreamDescription.Builder |
streamARN(String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
|
StreamDescription.Builder |
streamCreationTimestamp(Instant streamCreationTimestamp)
The approximate time that the stream was created.
|
StreamDescription.Builder |
streamName(String streamName)
The name of the stream being described.
|
StreamDescription.Builder |
streamStatus(StreamStatus streamStatus)
The current status of the stream being described.
|
StreamDescription.Builder |
streamStatus(String streamStatus)
The current status of the stream being described.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
StreamDescription.Builder streamName(String streamName)
The name of the stream being described.
streamName
- The name of the stream being described.StreamDescription.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.StreamDescription.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
StreamDescription.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
StreamDescription.Builder shards(Collection<Shard> shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.StreamDescription.Builder shards(Shard... shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.StreamDescription.Builder shards(Consumer<Shard.Builder>... shards)
The shards that comprise the stream.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #shards(List)
.shards
- a consumer that will call methods on List.Builder
#shards(List)
StreamDescription.Builder hasMoreShards(Boolean hasMoreShards)
If set to true
, more shards in the stream are available to describe.
hasMoreShards
- If set to true
, more shards in the stream are available to describe.StreamDescription.Builder retentionPeriodHours(Integer retentionPeriodHours)
The current retention period, in hours.
retentionPeriodHours
- The current retention period, in hours.StreamDescription.Builder streamCreationTimestamp(Instant streamCreationTimestamp)
The approximate time that the stream was created.
streamCreationTimestamp
- The approximate time that the stream was created.StreamDescription.Builder enhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.StreamDescription.Builder enhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.StreamDescription.Builder enhancedMonitoring(Consumer<EnhancedMetrics.Builder>... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
This is a convenience that creates an instance of theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #enhancedMonitoring(List)
.enhancedMonitoring
- a consumer that will call methods on List.Builder
#enhancedMonitoring(List)
StreamDescription.Builder encryptionType(String encryptionType)
The server-side encryption type used on the stream. This parameter can be one of the following values:
NONE
: Do not encrypt the records in the stream.
KMS
: Use server-side encryption on the records in the stream using a customer-managed AWS KMS
key.
encryptionType
- The server-side encryption type used on the stream. This parameter can be one of the following
values:
NONE
: Do not encrypt the records in the stream.
KMS
: Use server-side encryption on the records in the stream using a customer-managed AWS
KMS key.
EncryptionType
,
EncryptionType
StreamDescription.Builder encryptionType(EncryptionType encryptionType)
The server-side encryption type used on the stream. This parameter can be one of the following values:
NONE
: Do not encrypt the records in the stream.
KMS
: Use server-side encryption on the records in the stream using a customer-managed AWS KMS
key.
encryptionType
- The server-side encryption type used on the stream. This parameter can be one of the following
values:
NONE
: Do not encrypt the records in the stream.
KMS
: Use server-side encryption on the records in the stream using a customer-managed AWS
KMS key.
EncryptionType
,
EncryptionType
StreamDescription.Builder keyId(String keyId)
The GUID for the customer-managed AWS 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 AWS 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
Copyright © 2020. All rights reserved.