public static final class CfnAliasProps.Builder
extends java.lang.Object
CfnAliasProps
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
CfnAliasProps.Builder |
aliasName(java.lang.String aliasName)
Sets the value of
CfnAliasProps.getAliasName() |
CfnAliasProps |
build()
Builds the configured instance.
|
CfnAliasProps.Builder |
targetKeyId(java.lang.String targetKeyId)
Sets the value of
CfnAliasProps.getTargetKeyId() |
public CfnAliasProps.Builder aliasName(java.lang.String aliasName)
CfnAliasProps.getAliasName()
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 .
Pattern : ^alias/[a-zA-Z0-9/_-]+$
Minimum : 1
Maximum : 256
this
public CfnAliasProps.Builder targetKeyId(java.lang.String targetKeyId)
CfnAliasProps.getTargetKeyId()
targetKeyId
- Associates the alias with the specified [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) . 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:
1234abcd-12ab-34cd-56ef-1234567890ab
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 .
this
public CfnAliasProps build()
CfnAliasProps
java.lang.NullPointerException
- if any required attribute was not provided