software.amazon.awscdk.services.kms

Class Key.Builder

java.lang.Object

software.amazon.awscdk.services.kms.Key.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Key>

Enclosing class:

Key

@Stability(value=Experimental)
public static final class Key.Builder
extends Object
implements software.amazon.jsii.Builder<Key>

(experimental) A fluent builder for Key.

Method Summary

Modifier and Type	Method and Description
Key.Builder	alias(String alias) (experimental) Initial alias to add to the key.
Key	build()
static Key.Builder	create(software.constructs.Construct scope, String id)
Key.Builder	description(String description) (experimental) A description of the key.
Key.Builder	enabled(Boolean enabled) (experimental) Indicates whether the key is available for use.
Key.Builder	enableKeyRotation(Boolean enableKeyRotation) (experimental) Indicates whether AWS KMS rotates the key.
Key.Builder	policy(PolicyDocument policy) (experimental) Custom policy document to attach to the KMS key.
Key.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) Whether the encryption key should be retained when it is removed from the Stack.
Key.Builder	trustAccountIdentities(Boolean trustAccountIdentities) (experimental) Whether the key usage can be granted by IAM policies.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static Key.Builder create(software.constructs.Construct scope,
                                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Key.Builder.

alias

@Stability(value=Experimental)
public Key.Builder alias(String alias)

(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.

Parameters:

alias - Initial alias to add to the key. This parameter is required.

Returns:

this

description

@Stability(value=Experimental)
public Key.Builder description(String description)

(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.

Parameters:

description - A description of the key. This parameter is required.

Returns:

this

enabled

@Stability(value=Experimental)
public Key.Builder enabled(Boolean enabled)

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

Default: - Key is enabled.

Parameters:

enabled - Indicates whether the key is available for use. This parameter is required.

Returns:

this

enableKeyRotation

@Stability(value=Experimental)
public Key.Builder enableKeyRotation(Boolean enableKeyRotation)

(experimental) Indicates whether AWS KMS rotates the key.

Default: false

Parameters:

enableKeyRotation - Indicates whether AWS KMS rotates the key. This parameter is required.

Returns:

this

policy

@Stability(value=Experimental)
public Key.Builder policy(PolicyDocument policy)

(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.

Parameters:

policy - Custom policy document to attach to the KMS key. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Experimental)
public Key.Builder removalPolicy(RemovalPolicy removalPolicy)

(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

Parameters:

removalPolicy - Whether the encryption key should be retained when it is removed from the Stack. This parameter is required.

Returns:

this

trustAccountIdentities

@Stability(value=Experimental)
public Key.Builder trustAccountIdentities(Boolean trustAccountIdentities)

(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

Parameters:

trustAccountIdentities - Whether the key usage can be granted by IAM policies. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(value=Experimental)
public Key build()

Specified by:

build in interface software.amazon.jsii.Builder<Key>