Interface UpdateAliasRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateAliasRequest.Builder,
,UpdateAliasRequest> KmsRequest.Builder
,SdkBuilder<UpdateAliasRequest.Builder,
,UpdateAliasRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateAliasRequest
-
Method Summary
Modifier and TypeMethodDescriptionIdentifies the alias that is changing its KMS key.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.targetKeyId
(String targetKeyId) Identifies the customer managed key to associate with the alias.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
aliasName
Identifies the alias that is changing its KMS key. This value must begin with
alias/
followed by the alias name, such asalias/ExampleAlias
. You cannot useUpdateAlias
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.
- Parameters:
aliasName
- Identifies the alias that is changing its KMS key. This value must begin withalias/
followed by the alias name, such asalias/ExampleAlias
. You cannot useUpdateAlias
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
UpdateAliasRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateAliasRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-