Interface AwsKinesisStreamDetails.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsKinesisStreamDetails.Builder,
,AwsKinesisStreamDetails> SdkBuilder<AwsKinesisStreamDetails.Builder,
,AwsKinesisStreamDetails> SdkPojo
- Enclosing class:
AwsKinesisStreamDetails
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the Kinesis data stream.The name of the Kinesis stream.retentionPeriodHours
(Integer retentionPeriodHours) The number of hours for the data records that are stored in shards to remain accessible.shardCount
(Integer shardCount) The number of shards that the stream uses.default AwsKinesisStreamDetails.Builder
streamEncryption
(Consumer<AwsKinesisStreamStreamEncryptionDetails.Builder> streamEncryption) When specified, enables or updates server-side encryption using an KMS key for a specified stream.streamEncryption
(AwsKinesisStreamStreamEncryptionDetails streamEncryption) When specified, enables or updates server-side encryption using an KMS key for a specified stream.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, sdkFields
-
Method Details
-
name
The name of the Kinesis stream. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the stream name.
- Parameters:
name
- The name of the Kinesis stream. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the stream name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The Amazon Resource Name (ARN) of the Kinesis data stream.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the Kinesis data stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamEncryption
AwsKinesisStreamDetails.Builder streamEncryption(AwsKinesisStreamStreamEncryptionDetails streamEncryption) When specified, enables or updates server-side encryption using an KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.
- Parameters:
streamEncryption
- When specified, enables or updates server-side encryption using an KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamEncryption
default AwsKinesisStreamDetails.Builder streamEncryption(Consumer<AwsKinesisStreamStreamEncryptionDetails.Builder> streamEncryption) When specified, enables or updates server-side encryption using an KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.
This is a convenience method that creates an instance of theAwsKinesisStreamStreamEncryptionDetails.Builder
avoiding the need to create one manually viaAwsKinesisStreamStreamEncryptionDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostreamEncryption(AwsKinesisStreamStreamEncryptionDetails)
.- Parameters:
streamEncryption
- a consumer that will call methods onAwsKinesisStreamStreamEncryptionDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
shardCount
The number of shards that the stream uses.
- Parameters:
shardCount
- The number of shards that the stream uses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retentionPeriodHours
The number of hours for the data records that are stored in shards to remain accessible.
- Parameters:
retentionPeriodHours
- The number of hours for the data records that are stored in shards to remain accessible.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-