software.amazon.awssdk.services.kms.model

Interface CreateAliasRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>, KMSRequest.Builder, SdkBuilder<CreateAliasRequest.Builder,CreateAliasRequest>, SdkRequest.Builder

Enclosing class:

CreateAliasRequest

public static interface CreateAliasRequest.Builder
extends KMSRequest.Builder, CopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>

Method Summary

Modifier and Type	Method and Description
CreateAliasRequest.Builder	aliasName(String aliasName) String that contains the display name.
CreateAliasRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
CreateAliasRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
CreateAliasRequest.Builder	targetKeyId(String targetKeyId) Identifies the CMK for which you are creating the alias.

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

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

aliasName

CreateAliasRequest.Builder aliasName(String aliasName)

String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.

Parameters:

aliasName - String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.

Returns:

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

targetKeyId

CreateAliasRequest.Builder targetKeyId(String targetKeyId)

Identifies the CMK for which you are creating the alias. This value cannot be an alias.

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 - Identifies the CMK for which you are creating the alias. This value cannot be an alias.

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.

requestOverrideConfig

CreateAliasRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

CreateAliasRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.