public static interface CreateAliasRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>
Modifier and Type | Method and Description |
---|---|
CreateAliasRequest.Builder |
aliasName(String aliasName)
Specifies the alias name.
|
CreateAliasRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateAliasRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateAliasRequest.Builder |
targetKeyId(String targetKeyId)
Associates the alias with the specified customer managed
key.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
CreateAliasRequest.Builder aliasName(String aliasName)
Specifies the alias name. This value must begin with alias/
followed by a name, such as
alias/ExampleAlias
.
The AliasName
value 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 Amazon Web
Services managed keys.
aliasName
- Specifies the alias name. This value must begin with alias/
followed by a name, such as
alias/ExampleAlias
.
The AliasName
value 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 Amazon Web
Services managed keys.
CreateAliasRequest.Builder targetKeyId(String targetKeyId)
Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services 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 Key Management Service Developer Guide .
Specify the key ID or 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.
targetKeyId
- Associates the alias with the specified customer
managed key. The KMS key must be in the same Amazon Web Services 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 Key Management Service Developer Guide .
Specify the key ID or 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.
CreateAliasRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
CreateAliasRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2022. All rights reserved.