software.amazon.awscdk.services.kms

Interface KeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

KeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:38.129Z")
 @Stability(value=Experimental)
public interface KeyProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Construction properties for a KMS Key object.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static KeyProps.Builder	builder()
default String	getAlias() (experimental) Initial alias to add to the key.
default String	getDescription() (experimental) A description of the key.
default Boolean	getEnabled() (experimental) Indicates whether the key is available for use.
default Boolean	getEnableKeyRotation() (experimental) Indicates whether AWS KMS rotates the key.
default PolicyDocument	getPolicy() (experimental) Custom policy document to attach to the KMS key.
default RemovalPolicy	getRemovalPolicy() (experimental) Whether the encryption key should be retained when it is removed from the Stack.
default Boolean	getTrustAccountIdentities() (experimental) Whether the key usage can be granted by IAM policies.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlias

@Stability(value=Experimental)
 @Nullable
default String getAlias()

(experimental) Initial alias to add to the key.

More aliases can be added later by calling addAlias.

Default: - No alias is added for the key.

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

(experimental) A description of the key.

Use a description that helps your users decide whether the key is appropriate for a particular task.

Default: - No description.

getEnabled

@Stability(value=Experimental)
 @Nullable
default Boolean getEnabled()

(experimental) Indicates whether the key is available for use.

Default: - Key is enabled.

getEnableKeyRotation

@Stability(value=Experimental)
 @Nullable
default Boolean getEnableKeyRotation()

(experimental) Indicates whether AWS KMS rotates the key.

Default: false

getPolicy

@Stability(value=Experimental)
 @Nullable
default PolicyDocument getPolicy()

(experimental) Custom policy document to attach to the KMS key.

Default: - A policy document with permissions for the account root to administer the key will be created.

getRemovalPolicy

@Stability(value=Experimental)
 @Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) Whether the encryption key should be retained when it is removed from the Stack.

This is useful when one wants to retain access to data that was encrypted with a key that is being retired.

Default: RemovalPolicy.Retain

getTrustAccountIdentities

@Stability(value=Experimental)
 @Nullable
default Boolean getTrustAccountIdentities()

(experimental) Whether the key usage can be granted by IAM policies.

Setting this to true adds a default statement which delegates key access control completely to the identity's IAM policy (similar to how it works for other AWS resources).

Default: false

See Also:

https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam

builder

@Stability(value=Experimental)
static KeyProps.Builder builder()

Returns:

a KeyProps.Builder of KeyProps