Package software.amazon.awscdk.services.kms

Class CfnAliasProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • aliasName

      @Stability(Stable) public CfnAliasProps.Builder aliasName(String aliasName)
      Sets the value of CfnAliasProps.getAliasName()
      Parameters:
      aliasName - Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias . This parameter is required.

      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 .

      Returns:
      this

    • targetKeyId

      @Stability(Stable) public CfnAliasProps.Builder targetKeyId(String targetKeyId)
      Sets the value of CfnAliasProps.getTargetKeyId()
      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. 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 .

      Returns:
      this

    • build

      @Stability(Stable) public CfnAliasProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAliasProps>
      Returns:
      a new instance of CfnAliasProps
      Throws:
      NullPointerException - if any required attribute was not provided