KinesisStreamBuilder (FsCDK)

KinesisStreamBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`KinesisStreamBuilder(name)` Full Usage: `KinesisStreamBuilder(name)` Parameters: name : `string` Returns: `KinesisStreamBuilder`	name : `string` Returns: `KinesisStreamBuilder`


                
                  
                    
                      KinesisStreamBuilder(name)

Full Usage: KinesisStreamBuilder(name)

Parameters:

name : string

Returns: KinesisStreamBuilder

name : string

Returns: KinesisStreamBuilder

Instance members

Instance member	Description
`this.Combine` Full Usage: `this.Combine` Parameters: a : `KinesisStreamConfig` b : `KinesisStreamConfig` Returns: `KinesisStreamConfig`	a : `KinesisStreamConfig` b : `KinesisStreamConfig` Returns: `KinesisStreamConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` Returns: `KinesisStreamConfig`	Sets the construct ID. id : `string` Returns: `KinesisStreamConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> KinesisStreamConfig` Returns: `KinesisStreamConfig` Modifiers: inline	f : `unit -> KinesisStreamConfig` Returns: `KinesisStreamConfig`
`encryption encryption` Full Usage: `encryption encryption` Parameters: encryption : `StreamEncryption` Returns: `KinesisStreamConfig`	Uses a custom KMS key for encryption. encryption : `StreamEncryption` Returns: `KinesisStreamConfig`
`encryptionKey key` Full Usage: `encryptionKey key` Parameters: key : `IKey` Returns: `KinesisStreamConfig`	Uses a custom KMS key for encryption. key : `IKey` Returns: `KinesisStreamConfig`
`this.For` Full Usage: `this.For` Parameters: config : `KinesisStreamConfig` f : `unit -> KinesisStreamConfig` Returns: `KinesisStreamConfig` Modifiers: inline	config : `KinesisStreamConfig` f : `unit -> KinesisStreamConfig` Returns: `KinesisStreamConfig`
`grantRead reader` Full Usage: `grantRead reader` Parameters: reader : `IGrantable` Returns: `KinesisStreamConfig`	Grant read for role to stream. reader : `IGrantable` Returns: `KinesisStreamConfig`
`grantWrite writer` Full Usage: `grantWrite writer` Parameters: writer : `IGrantable` Returns: `KinesisStreamConfig`	Grant WRITE for role to stream. writer : `IGrantable` Returns: `KinesisStreamConfig`
`onDemand` Full Usage: `onDemand` Returns: `KinesisStreamConfig`	Uses on-demand stream mode. Returns: `KinesisStreamConfig`
`retentionPeriod period` Full Usage: `retentionPeriod period` Parameters: period : `Duration` Returns: `KinesisStreamConfig`	Sets the retention period. period : `Duration` Returns: `KinesisStreamConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `KinesisStreamConfig` Returns: `KinesisStreamSpec`	config : `KinesisStreamConfig` Returns: `KinesisStreamSpec`
`shardCount count` Full Usage: `shardCount count` Parameters: count : `int` Returns: `KinesisStreamConfig`	Sets the number of shards. count : `int` Returns: `KinesisStreamConfig`
`streamMode mode` Full Usage: `streamMode mode` Parameters: mode : `StreamMode` Returns: `KinesisStreamConfig`	Sets the stream mode. mode : `StreamMode` Returns: `KinesisStreamConfig`
`streamName name` Full Usage: `streamName name` Parameters: name : `string` Returns: `KinesisStreamConfig`	Sets the stream name. name : `string` Returns: `KinesisStreamConfig`
`unencrypted` Full Usage: `unencrypted` Returns: `KinesisStreamConfig`	Disables encryption. Returns: `KinesisStreamConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `KinesisStreamConfig`	() : `unit` Returns: `KinesisStreamConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `KinesisStreamConfig`	Returns: `KinesisStreamConfig`