software.amazon.awscdk.services.kms

Class KeyProps.Builder

java.lang.Object

software.amazon.awscdk.services.kms.KeyProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KeyProps>

Enclosing interface:

KeyProps

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

A builder for KeyProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
KeyProps.Builder	alias(String alias) Sets the value of KeyProps.getAlias()
KeyProps	build() Builds the configured instance.
KeyProps.Builder	description(String description) Sets the value of KeyProps.getDescription()
KeyProps.Builder	enabled(Boolean enabled) Sets the value of KeyProps.getEnabled()
KeyProps.Builder	enableKeyRotation(Boolean enableKeyRotation) Sets the value of KeyProps.getEnableKeyRotation()
KeyProps.Builder	policy(PolicyDocument policy) Sets the value of KeyProps.getPolicy()
KeyProps.Builder	removalPolicy(RemovalPolicy removalPolicy) Sets the value of KeyProps.getRemovalPolicy()
KeyProps.Builder	trustAccountIdentities(Boolean trustAccountIdentities) Sets the value of KeyProps.getTrustAccountIdentities()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

alias

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

Sets the value of KeyProps.getAlias()

Parameters:

alias - Initial alias to add to the key. More aliases can be added later by calling addAlias.

Returns:

this

description

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

Sets the value of KeyProps.getDescription()

Parameters:

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

Returns:

this

enabled

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

Sets the value of KeyProps.getEnabled()

Parameters:

enabled - Indicates whether the key is available for use.

Returns:

this

enableKeyRotation

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

Sets the value of KeyProps.getEnableKeyRotation()

Parameters:

enableKeyRotation - Indicates whether AWS KMS rotates the key.

Returns:

this

policy

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

Sets the value of KeyProps.getPolicy()

Parameters:

policy - Custom policy document to attach to the KMS key.

Returns:

this

removalPolicy

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

Sets the value of KeyProps.getRemovalPolicy()

Parameters:

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

Returns:

this

trustAccountIdentities

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

Sets the value of KeyProps.getTrustAccountIdentities()

Parameters:

trustAccountIdentities - 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).

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of KeyProps

Throws:

NullPointerException - if any required attribute was not provided