Package software.amazon.awscdk.services.kinesis

Class StreamProps.Builder

java.lang.Object

software.amazon.awscdk.services.kinesis.StreamProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StreamProps>

Enclosing interface:

StreamProps

@Stability(Stable)
public static final class StreamProps.Builder
extends Object
implements software.amazon.jsii.Builder<StreamProps>

A builder for StreamProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StreamProps	build()	Builds the configured instance.
StreamProps.Builder	encryption(StreamEncryption encryption)	Sets the value of StreamProps.getEncryption()
StreamProps.Builder	encryptionKey(IKey encryptionKey)	Sets the value of StreamProps.getEncryptionKey()
StreamProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of StreamProps.getRemovalPolicy()
StreamProps.Builder	retentionPeriod(Duration retentionPeriod)	Sets the value of StreamProps.getRetentionPeriod()
StreamProps.Builder	shardCount(Number shardCount)	Sets the value of StreamProps.getShardCount()
StreamProps.Builder	shardLevelMetrics(List<? extends ShardLevelMetrics> shardLevelMetrics)	Sets the value of StreamProps.getShardLevelMetrics()
StreamProps.Builder	streamMode(StreamMode streamMode)	Sets the value of StreamProps.getStreamMode()
StreamProps.Builder	streamName(String streamName)	Sets the value of StreamProps.getStreamName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

encryption

@Stability(Stable)
public StreamProps.Builder encryption(StreamEncryption encryption)

Sets the value of StreamProps.getEncryption()

Parameters:

encryption - 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.

Returns:

this

encryptionKey

@Stability(Stable)
public StreamProps.Builder encryptionKey(IKey encryptionKey)

Sets the value of StreamProps.getEncryptionKey()

Parameters:

encryptionKey - External KMS key to use for stream encryption. The 'encryption' property must be set to "Kms".

Returns:

this

removalPolicy

@Stability(Stable)
public StreamProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of StreamProps.getRemovalPolicy()

Parameters:

removalPolicy - Policy to apply when the stream is removed from the stack.

Returns:

this

retentionPeriod

@Stability(Stable)
public StreamProps.Builder retentionPeriod(Duration retentionPeriod)

Sets the value of StreamProps.getRetentionPeriod()

Parameters:

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

Returns:

this

shardCount

@Stability(Stable)
public StreamProps.Builder shardCount(Number shardCount)

Sets the value of StreamProps.getShardCount()

Parameters:

shardCount - The number of shards for the stream. Can only be provided if streamMode is Provisioned.

Returns:

this

shardLevelMetrics

@Stability(Stable)
public StreamProps.Builder shardLevelMetrics(List<? extends ShardLevelMetrics> shardLevelMetrics)

Sets the value of StreamProps.getShardLevelMetrics()

Parameters:

shardLevelMetrics - A list of shard-level metrics in properties to enable enhanced monitoring mode.

Returns:

this

streamMode

@Stability(Stable)
public StreamProps.Builder streamMode(StreamMode streamMode)

Sets the value of StreamProps.getStreamMode()

Parameters:

streamMode - The capacity mode of this stream.

Returns:

this

streamName

@Stability(Stable)
public StreamProps.Builder streamName(String streamName)

Sets the value of StreamProps.getStreamName()

Parameters:

streamName - Enforces a particular physical stream name.

Returns:

this

build

@Stability(Stable)
public StreamProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<StreamProps>

Returns:

a new instance of StreamProps

Throws:

NullPointerException - if any required attribute was not provided