software.amazon.awssdk.services.kms.model

Interface CreateAliasRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>, KmsRequest.Builder, SdkBuilder<CreateAliasRequest.Builder,CreateAliasRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAliasRequest

public static interface CreateAliasRequest.Builder
extends KmsRequest.Builder, SdkPojo, CopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>

Method Summary

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 CMK.

Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

aliasName

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 AWS managed CMKs.

Parameters:

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 AWS managed CMKs.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetKeyId

CreateAliasRequest.Builder targetKeyId(String targetKeyId)

Associates the alias with the specified customer managed CMK. The CMK must be in the same AWS Region.

A valid CMK 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 AWS Key Management Service Developer Guide.

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.

Parameters:

targetKeyId - Associates the alias with the specified customer managed CMK. The CMK must be in the same AWS Region.

A valid CMK 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 AWS Key Management Service Developer Guide.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateAliasRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateAliasRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder