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 KMS key.
|
UpdateAliasRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
UpdateAliasRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
UpdateAliasRequest.Builder |
targetKeyId(String targetKeyId)
Identifies the customer managed
key to associate with the alias.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildUpdateAliasRequest.Builder aliasName(String aliasName)
Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by
the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change
the alias name.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
aliasName - Identifies the alias that is changing its KMS key. This value must begin with alias/
followed by the alias name, such as alias/ExampleAlias. You cannot use
UpdateAlias to change the alias name. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
UpdateAliasRequest.Builder targetKeyId(String targetKeyId)
Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.
The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they must have the same key usage.
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.
To verify that the alias is mapped to the correct KMS key, use ListAliases.
targetKeyId - Identifies the customer
managed key to associate with the alias. You don't have permission to associate an alias with an
Amazon
Web Services managed key.
The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they must have the same key usage.
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.
To verify that the alias is mapped to the correct KMS key, use ListAliases.
UpdateAliasRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderUpdateAliasRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.