Class Stream

Provides a Kinesis Stream resource. Amazon Kinesis is a managed service that scales elastically for real-time processing of streaming big data.

For more details, see the Amazon Kinesis Documentation.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var testStream = new Aws.Kinesis.Stream("testStream", new Aws.Kinesis.StreamArgs
    {
        RetentionPeriod = 48,
        ShardCount = 1,
        ShardLevelMetrics = 
        {
            "IncomingBytes",
            "OutgoingBytes",
        },
        Tags = 
        {
            { "Environment", "test" },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Stream

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

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 class Stream : CustomResource

Constructors

Stream(String, StreamArgs, CustomResourceOptions)

Create a Stream resource with the given unique name, arguments, and options.

Declaration

public Stream(string name, StreamArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
StreamArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

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

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

EncryptionType

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

Declaration

public Output<string> EncryptionType { get; }

Property Value

Type	Description
Output<System.String>

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 Output<bool?> EnforceConsumerDeletion { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

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 Output<string> KmsKeyId { get; }

Property Value

Type	Description
Output<System.String>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

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 Output<int?> RetentionPeriod { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

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 Output<int> ShardCount { get; }

Property Value

Type	Description
Output<System.Int32>

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 Output<ImmutableArray<string>> ShardLevelMetrics { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, StreamState, CustomResourceOptions)

Get an existing Stream resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Stream Get(string name, Input<string> id, StreamState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
StreamState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Stream