public static interface GenerateMacRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<GenerateMacRequest.Builder,GenerateMacRequest>
| Modifier and Type | Method and Description |
|---|---|
GenerateMacRequest.Builder |
dryRun(Boolean dryRun)
Checks if your request will succeed.
|
GenerateMacRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
GenerateMacRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
GenerateMacRequest.Builder |
keyId(String keyId)
The HMAC KMS key to use in the operation.
|
GenerateMacRequest.Builder |
macAlgorithm(MacAlgorithmSpec macAlgorithm)
The MAC algorithm used in the operation.
|
GenerateMacRequest.Builder |
macAlgorithm(String macAlgorithm)
The MAC algorithm used in the operation.
|
GenerateMacRequest.Builder |
message(SdkBytes message)
The message to be hashed.
|
GenerateMacRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GenerateMacRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGenerateMacRequest.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.
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.
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.
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.
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.
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.
MacAlgorithmSpec,
MacAlgorithmSpecGenerateMacRequest.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.
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.
MacAlgorithmSpec,
MacAlgorithmSpecGenerateMacRequest.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.
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.
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.
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.
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 KMS API calls in the Key Management Service Developer Guide.
dryRun - Checks if your request will succeed. DryRun is an optional parameter.
To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
GenerateMacRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGenerateMacRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.