Interface CfnStreamProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStreamProps.Jsii$Proxy
CfnStream
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.kinesis.*; CfnStreamProps cfnStreamProps = CfnStreamProps.builder() .name("name") .retentionPeriodHours(123) .shardCount(123) .streamEncryption(StreamEncryptionProperty.builder() .encryptionType("encryptionType") .keyId("keyId") .build()) .streamModeDetails(StreamModeDetailsProperty.builder() .streamMode("streamMode") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnStreamProps
static final class
An implementation forCfnStreamProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnStreamProps.Builder
builder()
default String
getName()
The name of the Kinesis stream.default Number
The number of hours for the data records that are stored in shards to remain accessible.default Number
The number of shards that the stream uses.default Object
When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.default Object
Specifies the capacity mode to which you want to set your data stream.getTags()
An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name of the Kinesis stream.If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name. For more information, see Name Type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- See Also:
-
getRetentionPeriodHours
The number of hours for the data records that are stored in shards to remain accessible.The default value is 24. For more information about the stream retention period, see Changing the Data Retention Period in the Amazon Kinesis Developer Guide.
- See Also:
-
getShardCount
The number of shards that the stream uses.For greater provisioned throughput, increase the number of shards.
- See Also:
-
getStreamEncryption
When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.Removing this property from your stack template and updating your stack disables encryption.
- See Also:
-
getStreamModeDetails
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 capacity mode and a provisioned capacity mode for your data streams.
- See Also:
-
getTags
An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.For information about constraints for this property, see Tag Restrictions in the Amazon Kinesis Developer Guide .
- See Also:
-
builder
- Returns:
- a
CfnStreamProps.Builder
ofCfnStreamProps
-