Package software.amazon.awscdk.services.kms

Class CfnAlias.Builder

java.lang.Object
software.amazon.awscdk.services.kms.CfnAlias.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAlias>
Enclosing class:
CfnAlias
@Stability(Stable) public static final class CfnAlias.Builder extends Object implements software.amazon.jsii.Builder<CfnAlias>
A fluent builder for CfnAlias.

  • Method Details

    • create

      @Stability(Stable) public static CfnAlias.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      Returns:
      a new instance of CfnAlias.Builder.

    • aliasName

      @Stability(Stable) public CfnAlias.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:

    • targetKeyId

      @Stability(Stable) public CfnAlias.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:

    • build

      @Stability(Stable) public CfnAlias build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAlias>
      Returns:
      a newly built instance of CfnAlias.