Class StreamState

Inheritance
System.Object
InputArgs
ResourceArgs
StreamState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Kinesis
Assembly: Pulumi.Aws.dll
Syntax
public sealed class StreamState : ResourceArgs

Constructors

View Source

StreamState()

Declaration
public StreamState()

Properties

View Source

Arn

The Amazon Resource Name (ARN) specifying the Stream (same as id)

Declaration
public Input<string> Arn { get; set; }
Property Value
Type Description
Input<System.String>
View Source

EncryptionType

The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

Declaration
public Input<string> EncryptionType { get; set; }
Property Value
Type Description
Input<System.String>
View Source

EnforceConsumerDeletion

A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

Declaration
public Input<bool> EnforceConsumerDeletion { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

KmsKeyId

The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

Declaration
public Input<string> KmsKeyId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Name

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

Declaration
public Input<string> Name { get; set; }
Property Value
Type Description
Input<System.String>
View Source

RetentionPeriod

Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours. Minimum value is 24. Default is 24.

Declaration
public Input<int> RetentionPeriod { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

ShardCount

The number of shards that the stream will use. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

Declaration
public Input<int> ShardCount { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

ShardLevelMetrics

A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

Declaration
public InputList<string> ShardLevelMetrics { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

Tags

A map of tags to assign to the resource.

Declaration
public InputMap<object> Tags { get; set; }
Property Value
Type Description
InputMap<System.Object>