Interface VerifyMacRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<VerifyMacRequest.Builder,
,VerifyMacRequest> KmsRequest.Builder
,SdkBuilder<VerifyMacRequest.Builder,
,VerifyMacRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
VerifyMacRequest
-
Method Summary
Modifier and TypeMethodDescriptionChecks if your request will succeed.grantTokens
(String... grantTokens) A list of grant tokens.grantTokens
(Collection<String> grantTokens) A list of grant tokens.The KMS key that will be used in the verification.The HMAC to verify.macAlgorithm
(String macAlgorithm) The MAC algorithm that will be used in the verification.macAlgorithm
(MacAlgorithmSpec macAlgorithm) The MAC algorithm that will be used in the verification.The message that will be used in the verification.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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, sdkFields
-
Method Details
-
message
The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
GenerateMac and
VerifyMac
do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.- Parameters:
message
- The message that will be used in the verification. Enter the same message that was used to generate the HMAC.GenerateMac and
VerifyMac
do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyId
The KMS key that will be used in the verification.
Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
VerifyMac
operation fails.- Parameters:
keyId
- The KMS key that will be used in the verification.Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
VerifyMac
operation fails.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
macAlgorithm
The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
KeyId
parameter.- Parameters:
macAlgorithm
- The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by theKeyId
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
macAlgorithm
The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
KeyId
parameter.- Parameters:
macAlgorithm
- The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by theKeyId
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mac
The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
- Parameters:
mac
- The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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.
- 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 KMS API calls in the Key Management Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
VerifyMacRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
VerifyMacRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-