Interface CreateAliasRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAliasRequest.Builder,
,CreateAliasRequest> KmsRequest.Builder
,SdkBuilder<CreateAliasRequest.Builder,
,CreateAliasRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAliasRequest
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the alias name.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.targetKeyId
(String targetKeyId) Associates the alias with the specified customer managed key.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
Specifies the alias name. This value must begin with
alias/
followed by a name, such asalias/ExampleAlias
.Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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 withalias/aws/
. Thealias/aws/
prefix is reserved for Amazon Web Services managed keys.- Parameters:
aliasName
- Specifies the alias name. This value must begin withalias/
followed by a name, such asalias/ExampleAlias
.Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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 withalias/aws/
. Thealias/aws/
prefix is reserved for Amazon Web Services managed keys.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
CreateAliasRequest.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
CreateAliasRequest.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.
-