StreamAttributes

class aws_cdk.aws_kinesis.StreamAttributes(*, stream_arn, encryption_key=None)

Bases: object

A reference to a stream.

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

Parameters
  • stream_arn (str) – The ARN of the stream.

  • encryption_key (Optional[IKey]) – The KMS key securing the contents of the stream if encryption is enabled. Default: - No encryption

ExampleMetadata

infused

Example:

imported_stream = kinesis.Stream.from_stream_attributes(self, "ImportedEncryptedStream",
    stream_arn="arn:aws:kinesis:us-east-2:123456789012:stream/f3j09j2230j",
    encryption_key=kms.Key.from_key_arn(self, "key", "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012")
)

Attributes

encryption_key

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

Default
  • No encryption

Return type

Optional[IKey]

stream_arn

The ARN of the stream.

Return type

str