software.amazon.awscdk.services.kms

Class IKey.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kms.IKey.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IKey

public static final class IKey.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IKey.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

IKey.Jsii$Default, IKey.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final 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

Specified by:

getNode in interface IKey.Jsii$Default

getEnv

public final 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

Specified by:

getEnv in interface IKey.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IKey.Jsii$Default

getKeyArn

public final java.lang.String getKeyArn()

The ARN of the key.

Specified by:

getKeyArn in interface IKey

Specified by:

getKeyArn in interface IKey.Jsii$Default

getKeyId

public final 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

Specified by:

getKeyId in interface IKey.Jsii$Default

applyRemovalPolicy

public final 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

Specified by:

applyRemovalPolicy in interface IKey.Jsii$Default

Parameters:

policy - This parameter is required.

addAlias

public final Alias addAlias(java.lang.String alias)

Defines a new alias for the key.

Specified by:

addAlias in interface IKey

Specified by:

addAlias in interface IKey.Jsii$Default

Parameters:

alias - This parameter is required.

addToResourcePolicy

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

Adds a statement to the KMS key resource policy.

Specified by:

addToResourcePolicy in interface IKey

Specified by:

addToResourcePolicy in interface IKey.Jsii$Default

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.

addToResourcePolicy

public final AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)

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.

grant

public final 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

Specified by:

grant in interface IKey.Jsii$Default

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantDecrypt

public final Grant grantDecrypt(IGrantable grantee)

Grant decryption permissions using this key to the given principal.

Specified by:

grantDecrypt in interface IKey

Specified by:

grantDecrypt in interface IKey.Jsii$Default

Parameters:

grantee - This parameter is required.

grantEncrypt

public final Grant grantEncrypt(IGrantable grantee)

Grant encryption permissions using this key to the given principal.

Specified by:

grantEncrypt in interface IKey

Specified by:

grantEncrypt in interface IKey.Jsii$Default

Parameters:

grantee - This parameter is required.

grantEncryptDecrypt

public final Grant grantEncryptDecrypt(IGrantable grantee)

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

Specified by:

grantEncryptDecrypt in interface IKey

Specified by:

grantEncryptDecrypt in interface IKey.Jsii$Default

Parameters:

grantee - This parameter is required.