Package software.amazon.awscdk.services.kms

Interface CfnAliasProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:19.020Z")
@Stability(Stable)
public interface CfnAliasProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAlias.

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.*;
 CfnAliasProps cfnAliasProps = CfnAliasProps.builder()
         .aliasName("aliasName")
         .targetKeyId("targetKeyId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAliasProps.Builder	builder()
String	getAliasName()	Specifies the alias name.
String	getTargetKeyId()	Associates the alias with the specified customer managed key .

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, such as alias/ExampleAlias .

If you change the value of the AliasName property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).

The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/ . The alias/aws/ prefix is reserved for AWS managed keys .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-aliasname

getTargetKeyId

@Stability(Stable)
@NotNull
String getTargetKeyId()

Associates the alias with the specified customer managed key . The KMS key must be in the same AWS account and Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the key ID and ARN in the AWS Key Management Service Developer Guide .

Specify the key ID or the key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html#cfn-kms-alias-targetkeyid

builder

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

Returns:

a CfnAliasProps.Builder of CfnAliasProps