aws-cdk-lib.aws_kinesis.StreamAttributes

interface StreamAttributes

LanguageType name
.NETAmazon.CDK.AWS.Kinesis.StreamAttributes
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesis#StreamAttributes
Javasoftware.amazon.awscdk.services.kinesis.StreamAttributes
Pythonaws_cdk.aws_kinesis.StreamAttributes
TypeScript (source)aws-cdk-lib » aws_kinesis » StreamAttributes

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.

Example

const importedStream = kinesis.Stream.fromStreamAttributes(this, 'ImportedEncryptedStream', {
  streamArn: 'arn:aws:kinesis:us-east-2:123456789012:stream/f3j09j2230j',
  encryptionKey: kms.Key.fromKeyArn(this, 'key',
    'arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012',
  ),
});

Properties

NameTypeDescription
streamArnstringThe ARN of the stream.
encryptionKey?IKeyThe KMS key securing the contents of the stream if encryption is enabled.

streamArn

Type: string

The ARN of the stream.


encryptionKey?

Type: IKey (optional, default: No encryption)

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