software.amazon.awssdk.services.kms.model

Interface SignRequest.Builder

All Superinterfaces:

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

Enclosing class:

SignRequest

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

Method Summary

Modifier and Type	Method and Description
SignRequest.Builder	grantTokens(Collection<String> grantTokens) A list of grant tokens.
SignRequest.Builder	grantTokens(String... grantTokens) A list of grant tokens.
SignRequest.Builder	keyId(String keyId) Identifies an asymmetric CMK.
SignRequest.Builder	message(SdkBytes message) Specifies the message or message digest to sign.
SignRequest.Builder	messageType(MessageType messageType) Tells AWS KMS whether the value of the Message parameter is a message or message digest.
SignRequest.Builder	messageType(String messageType) Tells AWS KMS whether the value of the Message parameter is a message or message digest.
SignRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SignRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SignRequest.Builder	signingAlgorithm(SigningAlgorithmSpec signingAlgorithm) Specifies the signing algorithm to use when signing the message.
SignRequest.Builder	signingAlgorithm(String signingAlgorithm) Specifies the signing algorithm to use when signing the message.

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

keyId

SignRequest.Builder keyId(String keyId)

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Parameters:

keyId - Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Returns:

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

message

SignRequest.Builder message(SdkBytes message)

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

Parameters:

message - Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

Returns:

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

messageType

SignRequest.Builder messageType(String messageType)

Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Parameters:

messageType - Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Returns:

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

See Also:

MessageType, MessageType

messageType

SignRequest.Builder messageType(MessageType messageType)

Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Parameters:

messageType - Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Returns:

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

See Also:

MessageType, MessageType

grantTokens

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

SignRequest.Builder grantTokens(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.

signingAlgorithm

SignRequest.Builder signingAlgorithm(String signingAlgorithm)

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Parameters:

signingAlgorithm - Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Returns:

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

See Also:

SigningAlgorithmSpec, SigningAlgorithmSpec

signingAlgorithm

SignRequest.Builder signingAlgorithm(SigningAlgorithmSpec signingAlgorithm)

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Parameters:

signingAlgorithm - Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.

Returns:

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

See Also:

SigningAlgorithmSpec, SigningAlgorithmSpec

overrideConfiguration

SignRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder