software.amazon.awscdk.services.kms

Interface IKey.Jsii$Default

All Superinterfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IKey, IResource, IResource.Jsii$Default

All Known Subinterfaces:

IAlias.Jsii$Default

All Known Implementing Classes:

IAlias.Jsii$Proxy, IKey.Jsii$Proxy

Enclosing interface:

IKey

public static interface IKey.Jsii$Default
extends IKey, IResource.Jsii$Default

Internal default implementation for IKey.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kms.IKey

IKey.Jsii$Default, IKey.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default Alias	addAlias(java.lang.String alias) Defines a new alias for the key.
default AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement, java.lang.Boolean allowNoOp) Adds a statement to the KMS key resource policy.
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default java.lang.String	getKeyArn() The ARN of the key.
default java.lang.String	getKeyId() The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab).
default ConstructNode	getNode() The construct tree node for this construct.
default Stack	getStack() The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, java.lang.String... actions) Grant the indicated permissions on this key to the given principal.
default Grant	grantDecrypt(IGrantable grantee) Grant decryption permissions using this key to the given principal.
default Grant	grantEncrypt(IGrantable grantee) Grant encryption permissions using this key to the given principal.
default Grant	grantEncryptDecrypt(IGrantable grantee) Grant encryption and decryption permissions using this key to the given principal.

Methods inherited from interface software.amazon.awscdk.services.kms.IKey

addToResourcePolicy

Method Detail

getNode

default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getKeyArn

default java.lang.String getKeyArn()

The ARN of the key.

Specified by:

getKeyArn in interface IKey

getKeyId

default java.lang.String getKeyId()

The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab).

Specified by:

getKeyId in interface IKey

applyRemovalPolicy

default void applyRemovalPolicy(RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addAlias

default Alias addAlias(java.lang.String alias)

Defines a new alias for the key.

Specified by:

addAlias in interface IKey

Parameters:

alias - This parameter is required.

addToResourcePolicy

default AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement,
                                                      java.lang.Boolean allowNoOp)

Adds a statement to the KMS key resource policy.

Specified by:

addToResourcePolicy in interface IKey

Parameters:

statement - The policy statement to add. This parameter is required.

allowNoOp - If this is set to `false` and there is no policy defined (i.e. external key), the operation will fail. Otherwise, it will no-op.

grant

default Grant grant(IGrantable grantee,
                    java.lang.String... actions)

Grant the indicated permissions on this key to the given principal.

Specified by:

grant in interface IKey

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantDecrypt

default Grant grantDecrypt(IGrantable grantee)

Grant decryption permissions using this key to the given principal.

Specified by:

grantDecrypt in interface IKey

Parameters:

grantee - This parameter is required.

grantEncrypt

default Grant grantEncrypt(IGrantable grantee)

Grant encryption permissions using this key to the given principal.

Specified by:

grantEncrypt in interface IKey

Parameters:

grantee - This parameter is required.

grantEncryptDecrypt

default Grant grantEncryptDecrypt(IGrantable grantee)

Grant encryption and decryption permissions using this key to the given principal.

Specified by:

grantEncryptDecrypt in interface IKey

Parameters:

grantee - This parameter is required.