Package software.amazon.awssdk.services.kms.model

Interface DescribeKeyRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeKeyRequest.Builder,DescribeKeyRequest>, SdkBuilder<DescribeKeyRequest.Builder,DescribeKeyRequest>

Enclosing class:

DescribeKeyRequest

public static interface DescribeKeyRequest.Builder
extends CopyableBuilder<DescribeKeyRequest.Builder,DescribeKeyRequest>

Method Summary

Modifier and Type	Method	Description
DescribeKeyRequest.Builder	grantTokens(String... grantTokens)	A list of grant tokens.
DescribeKeyRequest.Builder	grantTokens(Collection<String> grantTokens)	A list of grant tokens.
DescribeKeyRequest.Builder	keyId(String keyId)	A unique identifier for the customer master key.

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

keyId

DescribeKeyRequest.Builder keyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

• Alias Name Example - alias/MyAliasName

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

• Alias Name Example - alias/MyAliasName

Returns:

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

grantTokens

DescribeKeyRequest.Builder grantTokens(Collection<String> grantTokens)

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Parameters:

grantTokens - A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

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

grantTokens

DescribeKeyRequest.Builder grantTokens(String... grantTokens)

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

NOTE: This method appends the values to the existing list (if any). Use #setGrantTokens(java.util.Collection) or #withGrantTokens(java.util.Collection) if you want to override the existing values.

Parameters:

grantTokens - A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

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