software.amazon.awscdk.services.kms

Interface IKey.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IKey, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IAlias.Jsii$Default

All Known Implementing Classes:

IAlias.Jsii$Proxy, IKey.Jsii$Proxy

Enclosing interface:

IKey

@Internal
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(String alias) (experimental) Defines a new alias for the key.
default AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement, Boolean allowNoOp) (experimental) Adds a statement to the KMS key resource policy.
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default String	getKeyArn() (experimental) The ARN of the key.
default String	getKeyId() (experimental) The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab).
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, String... actions) (experimental) Grant the indicated permissions on this key to the given principal.
default Grant	grantDecrypt(IGrantable grantee) (experimental) Grant decryption permissions using this key to the given principal.
default Grant	grantEncrypt(IGrantable grantee) (experimental) Grant encryption permissions using this key to the given principal.
default Grant	grantEncryptDecrypt(IGrantable grantee) (experimental) Grant encryption and decryption permissions using this key to the given principal.

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

addToResourcePolicy

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) 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

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getKeyArn

@Stability(value=Experimental)
 @NotNull
default String getKeyArn()

(experimental) The ARN of the key.

Specified by:

getKeyArn in interface IKey

getKeyId

@Stability(value=Experimental)
 @NotNull
default String getKeyId()

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

Specified by:

getKeyId in interface IKey

addAlias

@Stability(value=Experimental)
 @NotNull
default Alias addAlias(@NotNull
                                                                String alias)

(experimental) Defines a new alias for the key.

Specified by:

addAlias in interface IKey

Parameters:

alias - This parameter is required.

addToResourcePolicy

@Stability(value=Experimental)
 @NotNull
default AddToResourcePolicyResult addToResourcePolicy(@NotNull
                                                                                               PolicyStatement statement,
                                                                                               @Nullable
                                                                                               Boolean allowNoOp)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
default Grant grant(@NotNull
                                                             IGrantable grantee,
                                                             @NotNull
                                                             String... actions)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
default Grant grantDecrypt(@NotNull
                                                                    IGrantable grantee)

(experimental) Grant decryption permissions using this key to the given principal.

Specified by:

grantDecrypt in interface IKey

Parameters:

grantee - This parameter is required.

grantEncrypt

@Stability(value=Experimental)
 @NotNull
default Grant grantEncrypt(@NotNull
                                                                    IGrantable grantee)

(experimental) Grant encryption permissions using this key to the given principal.

Specified by:

grantEncrypt in interface IKey

Parameters:

grantee - This parameter is required.

grantEncryptDecrypt

@Stability(value=Experimental)
 @NotNull
default Grant grantEncryptDecrypt(@NotNull
                                                                           IGrantable grantee)

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

Specified by:

grantEncryptDecrypt in interface IKey

Parameters:

grantee - This parameter is required.