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

Interface GenerateMacRequest.Builder

All Superinterfaces:

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

Enclosing class:

GenerateMacRequest

@Mutable
@NotThreadSafe
public static interface GenerateMacRequest.Builder
extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GenerateMacRequest.Builder,GenerateMacRequest>

Method Summary

Modifier and Type	Method	Description
GenerateMacRequest.Builder	dryRun(Boolean dryRun)	Checks if your request will succeed.
GenerateMacRequest.Builder	grantTokens(String... grantTokens)	A list of grant tokens.
GenerateMacRequest.Builder	grantTokens(Collection<String> grantTokens)	A list of grant tokens.
GenerateMacRequest.Builder	keyId(String keyId)	The HMAC KMS key to use in the operation.
GenerateMacRequest.Builder	macAlgorithm(String macAlgorithm)	The MAC algorithm used in the operation.
GenerateMacRequest.Builder	macAlgorithm(MacAlgorithmSpec macAlgorithm)	The MAC algorithm used in the operation.
GenerateMacRequest.Builder	message(SdkBytes message)	The message to be hashed.
GenerateMacRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GenerateMacRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

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, sdkFieldNameToField, sdkFields

Method Detail

message

GenerateMacRequest.Builder message(SdkBytes message)

The message to be hashed. Specify a message of up to 4,096 bytes.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.

Parameters:

message - The message to be hashed. Specify a message of up to 4,096 bytes.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.

Returns:

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

keyId

GenerateMacRequest.Builder keyId(String keyId)

The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

Parameters:

keyId - The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

Returns:

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

macAlgorithm

GenerateMacRequest.Builder macAlgorithm(String macAlgorithm)

The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

Parameters:

macAlgorithm - The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

Returns:

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

See Also:

MacAlgorithmSpec, MacAlgorithmSpec

macAlgorithm

GenerateMacRequest.Builder macAlgorithm(MacAlgorithmSpec macAlgorithm)

The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

Parameters:

macAlgorithm - The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

Returns:

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

See Also:

MacAlgorithmSpec, MacAlgorithmSpec

grantTokens

GenerateMacRequest.Builder grantTokens(Collection<String> grantTokens)

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Parameters:

grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Returns:

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

grantTokens

GenerateMacRequest.Builder grantTokens(String... grantTokens)

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Parameters:

grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Returns:

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

dryRun

GenerateMacRequest.Builder dryRun(Boolean dryRun)

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide.

Parameters:

dryRun - Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide.

Returns:

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

overrideConfiguration

GenerateMacRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder