Class StreamAttributes

A reference to a stream.

Inheritance

object

StreamAttributes

Implements

IStreamAttributes

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Kinesis

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class StreamAttributes : IStreamAttributes

Syntax (vb)

Public Class StreamAttributes Implements IStreamAttributes

Remarks

The easiest way to instantiate is to call stream.export(). Then, the consumer can use Stream.import(this, ref) and get a Stream.

ExampleMetadata: infused

Examples

var importedStream = Stream.FromStreamAttributes(this, "ImportedEncryptedStream", new StreamAttributes {
                 StreamArn = "arn:aws:kinesis:us-east-2:123456789012:stream/f3j09j2230j",
                 EncryptionKey = Key.FromKeyArn(this, "key", "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012")
             });

Synopsis

Constructors

StreamAttributes()

A reference to a stream.

Properties

EncryptionKey	The KMS key securing the contents of the stream if encryption is enabled.
StreamArn	The ARN of the stream.

Constructors

StreamAttributes()

A reference to a stream.

public StreamAttributes()

Remarks

The easiest way to instantiate is to call stream.export(). Then, the consumer can use Stream.import(this, ref) and get a Stream.

ExampleMetadata: infused

Examples

var importedStream = Stream.FromStreamAttributes(this, "ImportedEncryptedStream", new StreamAttributes {
                 StreamArn = "arn:aws:kinesis:us-east-2:123456789012:stream/f3j09j2230j",
                 EncryptionKey = Key.FromKeyArn(this, "key", "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012")
             });

Properties

EncryptionKey

The KMS key securing the contents of the stream if encryption is enabled.

public IKey? EncryptionKey { get; set; }

Property Value

IKey

Remarks

Default: - No encryption

StreamArn

The ARN of the stream.

public string StreamArn { get; set; }

Property Value

string

Remarks

The easiest way to instantiate is to call stream.export(). Then, the consumer can use Stream.import(this, ref) and get a Stream.

ExampleMetadata: infused

Implements

IStreamAttributes