Package software.amazon.awscdk.services.amazonmq

Interface CfnBroker.EncryptionOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBroker.EncryptionOptionsProperty.Jsii$Proxy

Enclosing class:

CfnBroker

@Stability(Stable)
public static interface CfnBroker.EncryptionOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Encryption options for the broker.

Does not apply to RabbitMQ brokers.

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.amazonmq.*;
 EncryptionOptionsProperty encryptionOptionsProperty = EncryptionOptionsProperty.builder()
         .useAwsOwnedKey(false)
         // the properties below are optional
         .kmsKeyId("kmsKeyId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBroker.EncryptionOptionsProperty.Builder	A builder for CfnBroker.EncryptionOptionsProperty
static final class	CfnBroker.EncryptionOptionsProperty.Jsii$Proxy	An implementation for CfnBroker.EncryptionOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnBroker.EncryptionOptionsProperty.Builder	builder()
default String	getKmsKeyId()	The customer master key (CMK) to use for the A AWS KMS (KMS).
Object	getUseAwsOwnedKey()	Enables the use of an AWS owned CMK using AWS KMS (KMS).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUseAwsOwnedKey

@Stability(Stable)
@NotNull
Object getUseAwsOwnedKey()

Enables the use of an AWS owned CMK using AWS KMS (KMS).

Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html#cfn-amazonmq-broker-encryptionoptions-useawsownedkey

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The customer master key (CMK) to use for the A AWS KMS (KMS).

This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-encryptionoptions.html#cfn-amazonmq-broker-encryptionoptions-kmskeyid

builder

@Stability(Stable)
static CfnBroker.EncryptionOptionsProperty.Builder builder()

Returns:

a CfnBroker.EncryptionOptionsProperty.Builder of CfnBroker.EncryptionOptionsProperty