Package software.amazon.awscdk.cfnpropertymixins.services.kms

Class CfnAliasPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kms.CfnAliasPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAliasPropsMixin>

Enclosing class:

CfnAliasPropsMixin

@Stability(Stable)
public static final class CfnAliasPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAliasPropsMixin>

A fluent builder for CfnAliasPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAliasPropsMixin.Builder	aliasName(String aliasName)	Specifies the alias name.
CfnAliasPropsMixin	build()
static CfnAliasPropsMixin.Builder	create()
static CfnAliasPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAliasPropsMixin.Builder	targetKeyId(String targetKeyId)	Associates the alias with the specified customer managed key .
CfnAliasPropsMixin.Builder	targetKeyId(IKeyRef targetKeyId)	Associates the alias with the specified customer managed key .
CfnAliasPropsMixin.Builder	targetKeyId(IReplicaKeyRef targetKeyId)	Associates the alias with the specified customer managed key .

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnAliasPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAliasPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAliasPropsMixin.Builder create()

Returns:

a new instance of CfnAliasPropsMixin.Builder.

aliasName

@Stability(Stable)
public CfnAliasPropsMixin.Builder aliasName(String aliasName)

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 .

Parameters:

aliasName - Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias . This parameter is required.

Returns:

this

See Also:

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

targetKeyId

@Stability(Stable)
public CfnAliasPropsMixin.Builder targetKeyId(String targetKeyId)

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 .

Parameters:

targetKeyId - Associates the alias with the specified customer managed key . The KMS key must be in the same AWS account and Region. This parameter is required.

Returns:

this

See Also:

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

targetKeyId

@Stability(Stable)
public CfnAliasPropsMixin.Builder targetKeyId(IKeyRef targetKeyId)

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 .

Parameters:

targetKeyId - Associates the alias with the specified customer managed key . The KMS key must be in the same AWS account and Region. This parameter is required.

Returns:

this

See Also:

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

targetKeyId

@Stability(Stable)
public CfnAliasPropsMixin.Builder targetKeyId(IReplicaKeyRef targetKeyId)

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 .

Parameters:

targetKeyId - Associates the alias with the specified customer managed key . The KMS key must be in the same AWS account and Region. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAliasPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAliasPropsMixin>

Returns:

a newly built instance of CfnAliasPropsMixin.