software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(value=Stable)
public static interface CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 DeliveryStreamEncryptionConfigurationInputProperty deliveryStreamEncryptionConfigurationInputProperty = DeliveryStreamEncryptionConfigurationInputProperty.builder()
         .keyType("keyType")
         // the properties below are optional
         .keyArn("keyArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty.Builder A builder for CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty
static class	CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty.Jsii$Proxy An implementation for CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty

Method Summary

Modifier and Type	Method and Description
static CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty.Builder	builder()
default String	getKeyArn() If you set `KeyType` to `CUSTOMER_MANAGED_CMK` , you must specify the Amazon Resource Name (ARN) of the CMK.
String	getKeyType() Indicates the type of customer master key (CMK) to use for encryption.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getKeyType

@Stability(value=Stable)
 @NotNull
String getKeyType()

Indicates the type of customer master key (CMK) to use for encryption.

The default setting is AWS_OWNED_CMK . For more information about CMKs, see Customer Master Keys (CMKs) .

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams.

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

getKeyArn

@Stability(value=Stable)
 @Nullable
default String getKeyArn()

If you set `KeyType` to `CUSTOMER_MANAGED_CMK` , you must specify the Amazon Resource Name (ARN) of the CMK.

If you set KeyType to AWS _OWNED_CMK , Kinesis Data Firehose uses a service-account CMK.

builder

@Stability(value=Stable)
static CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty.Builder builder()

Returns:

a CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty.Builder of CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty