software.amazon.awscdk.services.kinesis

Interface StreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.197Z")
 @Stability(value=Stable)
public interface StreamProps
extends software.amazon.jsii.JsiiSerializable

Properties for a Kinesis Stream.

Example:

 Key key = new Key(this, "MyKey");
 Stream.Builder.create(this, "MyEncryptedStream")
         .encryption(StreamEncryption.KMS)
         .encryptionKey(key)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StreamProps.Builder A builder for StreamProps
static class	StreamProps.Jsii$Proxy An implementation for StreamProps

Method Summary

Modifier and Type	Method and Description
static StreamProps.Builder	builder()
default StreamEncryption	getEncryption() The kind of server-side encryption to apply to this stream.
default IKey	getEncryptionKey() External KMS key to use for stream encryption.
default Duration	getRetentionPeriod() The number of hours for the data records that are stored in shards to remain accessible.
default Number	getShardCount() The number of shards for the stream.
default StreamMode	getStreamMode() The capacity mode of this stream.
default String	getStreamName() Enforces a particular physical stream name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEncryption

@Stability(value=Stable)
 @Nullable
default StreamEncryption getEncryption()

The kind of server-side encryption to apply to this stream.

If you choose KMS, you can specify a KMS key via encryptionKey. If encryption key is not specified, a key will automatically be created.

Default: - StreamEncryption.KMS if encrypted Streams are supported in the region or StreamEncryption.UNENCRYPTED otherwise. StreamEncryption.KMS if an encryption key is supplied through the encryptionKey property

getEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionKey()

External KMS key to use for stream encryption.

The 'encryption' property must be set to "Kms".

Default: - Kinesis Data Streams master key ('/alias/aws/kinesis'). If encryption is set to StreamEncryption.KMS and this property is undefined, a new KMS key will be created and associated with this stream.

getRetentionPeriod

@Stability(value=Stable)
 @Nullable
default Duration getRetentionPeriod()

The number of hours for the data records that are stored in shards to remain accessible.

Default: Duration.hours(24)

getShardCount

@Stability(value=Stable)
 @Nullable
default Number getShardCount()

The number of shards for the stream.

Can only be provided if streamMode is Provisioned.

Default: 1

getStreamMode

@Stability(value=Stable)
 @Nullable
default StreamMode getStreamMode()

The capacity mode of this stream.

Default: StreamMode.PROVISIONED

getStreamName

@Stability(value=Stable)
 @Nullable
default String getStreamName()

Enforces a particular physical stream name.

Default:

builder

@Stability(value=Stable)
static StreamProps.Builder builder()

Returns:

a StreamProps.Builder of StreamProps