public static interface UpdateAliasRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>
| Modifier and Type | Method and Description |
|---|---|
UpdateAliasRequest.Builder |
aliasName(String aliasName)
Identifies the alias that is changing its CMK.
|
UpdateAliasRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
UpdateAliasRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
UpdateAliasRequest.Builder |
targetKeyId(String targetKeyId)
Identifies the customer managed
CMK to associate with the alias.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildUpdateAliasRequest.Builder aliasName(String aliasName)
Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the
alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.
aliasName - Identifies the alias that is changing its CMK. This value must begin with alias/ followed
by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the
alias name.UpdateAliasRequest.Builder targetKeyId(String targetKeyId)
Identifies the customer managed CMK to associate with the alias. You don't have permission to associate an alias with an AWS managed CMK.
The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct CMK, use ListAliases.
targetKeyId - Identifies the customer
managed CMK to associate with the alias. You don't have permission to associate an alias with an
AWS
managed CMK.
The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct CMK, use ListAliases.
UpdateAliasRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.UpdateAliasRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.