Package software.amazon.awscdk.services.kms

Interface AliasAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AliasAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-19T18:01:37.404Z")
@Stability(Stable)
public interface AliasAttributes
extends software.amazon.jsii.JsiiSerializable

Properties of a reference to an existing KMS Alias.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kms.*;
 Key key;
 AliasAttributes aliasAttributes = AliasAttributes.builder()
         .aliasName("aliasName")
         .aliasTargetKey(key)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AliasAttributes.Builder	A builder for AliasAttributes
static final class	AliasAttributes.Jsii$Proxy	An implementation for AliasAttributes

Method Summary

Modifier and Type	Method	Description
static AliasAttributes.Builder	builder()
String	getAliasName()	Specifies the alias name.
IKey	getAliasTargetKey()	The customer master key (CMK) to which the Alias refers.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAliasName

@Stability(Stable)
@NotNull
String getAliasName()

Specifies the alias name.

This value must begin with alias/ followed by a name (i.e. alias/ExampleAlias)

getAliasTargetKey

@Stability(Stable)
@NotNull
IKey getAliasTargetKey()

The customer master key (CMK) to which the Alias refers.

builder

@Stability(Stable)
static AliasAttributes.Builder builder()

Returns:

a AliasAttributes.Builder of AliasAttributes