class StreamEncryption ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.KinesisFirehose.Alpha.StreamEncryption
Go	github.com/aws/aws-cdk-go/awscdkkinesisfirehosealpha/v2#StreamEncryption
Java	software.amazon.awscdk.services.kinesisfirehose.alpha.StreamEncryption
Python	aws_cdk.aws_kinesisfirehose_alpha.StreamEncryption
TypeScript (source)	@aws-cdk/aws-kinesisfirehose-alpha » StreamEncryption

⚠️ Deprecated: undefined

Represents server-side encryption for a Kinesis Firehose Delivery Stream.

Example

declare const destination: firehose.IDestination;

// SSE with an AWS-owned key
new firehose.DeliveryStream(this, 'Delivery Stream with AWS Owned Key', {
  encryption: firehose.StreamEncryption.awsOwnedKey(),
  destination: destination,
});
// SSE with an customer-managed key that is created automatically by the CDK
new firehose.DeliveryStream(this, 'Delivery Stream with Customer Managed Key', {
  encryption: firehose.StreamEncryption.customerManagedKey(),
  destination: destination,
});
// SSE with an customer-managed key that is explicitly specified
declare const key: kms.Key;
new firehose.DeliveryStream(this, 'Delivery Stream with Customer Managed and Provided Key', {
  encryption: firehose.StreamEncryption.customerManagedKey(key),
  destination: destination,
});

Properties

Name	Type	Description
type⚠️	StreamEncryptionType	The type of server-side encryption for the Kinesis Firehose delivery stream.
encryptionKey?⚠️	IKey	Optional KMS key used for customer managed encryption.

---

type⚠️

⚠️ Deprecated: undefined

Type: StreamEncryptionType

The type of server-side encryption for the Kinesis Firehose delivery stream.

---

encryptionKey?⚠️

⚠️ Deprecated: undefined

Type: IKey (optional)

Optional KMS key used for customer managed encryption.

Methods

Name	Description
static awsOwnedKey()⚠️	Configure server-side encryption using an AWS owned key.
static customerManagedKey(encryptionKey?)⚠️	Configure server-side encryption using customer managed keys.
static unencrypted()⚠️	No server-side encryption is configured.

---

static awsOwnedKey()⚠️

public static awsOwnedKey(): StreamEncryption

⚠️ Deprecated: undefined

Returns

• StreamEncryption

Configure server-side encryption using an AWS owned key.

---

static customerManagedKey(encryptionKey?)⚠️

public static customerManagedKey(encryptionKey?: IKey): StreamEncryption

⚠️ Deprecated: undefined

Parameters

• encryptionKey IKey — the KMS key for the delivery stream.

Returns

• StreamEncryption

Configure server-side encryption using customer managed keys.

---

static unencrypted()⚠️

public static unencrypted(): StreamEncryption

⚠️ Deprecated: undefined

Returns

• StreamEncryption

No server-side encryption is configured.