Package software.amazon.awscdk.services.kms

Interface IAlias

All Superinterfaces:

IAliasRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IKey, IKeyRef, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IAlias.Jsii$Default

All Known Implementing Classes:

Alias, IAlias.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:16.092Z")
@Stability(Stable)
public interface IAlias
extends software.amazon.jsii.JsiiSerializable, IKey, IAliasRef

A KMS Key alias.

An alias can be used in all places that expect a key.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IAlias.Jsii$Default	Internal default implementation for IAlias.
static final class	IAlias.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getAliasName()	The name of the alias.
IKey	getAliasTargetKey()	The Key to which the Alias refers.
ResourceEnvironment	getEnv()	The environment this resource belongs to.
software.constructs.Node	getNode()	The tree node.

Methods inherited from interface software.amazon.awscdk.interfaces.kms.IAliasRef

getAliasRef

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

addAlias, addToResourcePolicy, addToResourcePolicy, getKeyArn, getKeyId, grant, grantDecrypt, grantEncrypt, grantEncryptDecrypt, grantGenerateMac, grantSign, grantSignVerify, grantVerify, grantVerifyMac

Methods inherited from interface software.amazon.awscdk.interfaces.kms.IKeyRef

getKeyRef

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAliasName

@Stability(Stable)
@NotNull
String getAliasName()

The name of the alias.

getAliasTargetKey

@Stability(Stable)
@NotNull
IKey getAliasTargetKey()

The Key to which the Alias refers.

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface IKey

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IKey