public static interface VerifyRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<VerifyRequest.Builder,VerifyRequest>
| Modifier and Type | Method and Description |
|---|---|
VerifyRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
VerifyRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
VerifyRequest.Builder |
keyId(String keyId)
Identifies the asymmetric CMK that will be used to verify the signature.
|
VerifyRequest.Builder |
message(SdkBytes message)
Specifies the message that was signed.
|
VerifyRequest.Builder |
messageType(MessageType messageType)
Tells AWS KMS whether the value of the
Message parameter is a message or message digest. |
VerifyRequest.Builder |
messageType(String messageType)
Tells AWS KMS whether the value of the
Message parameter is a message or message digest. |
VerifyRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
VerifyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
VerifyRequest.Builder |
signature(SdkBytes signature)
The signature that the
Sign operation generated. |
VerifyRequest.Builder |
signingAlgorithm(SigningAlgorithmSpec signingAlgorithm)
The signing algorithm that was used to sign the message.
|
VerifyRequest.Builder |
signingAlgorithm(String signingAlgorithm)
The signing algorithm that was used to sign the message.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildVerifyRequest.Builder keyId(String keyId)
Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK that was used to generate the signature. If you specify a different CMK, the signature verification fails.
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.
keyId - Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK
that was used to generate the signature. If you specify a different CMK, the signature verification
fails.
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.
VerifyRequest.Builder message(SdkBytes message)
Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of
the message. If you submit a digest, use the MessageType parameter with a value of
DIGEST.
If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
message - Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash
digest of the message. If you submit a digest, use the MessageType parameter with a value
of DIGEST.
If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
VerifyRequest.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.
Use the DIGEST value only when the value of the Message parameter is a message
digest. If you use the DIGEST value with a raw message, the security of the verification
operation can be compromised.
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
.
Use the DIGEST value only when the value of the Message parameter is a
message digest. If you use the DIGEST value with a raw message, the security of the
verification operation can be compromised.
MessageType,
MessageTypeVerifyRequest.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.
Use the DIGEST value only when the value of the Message parameter is a message
digest. If you use the DIGEST value with a raw message, the security of the verification
operation can be compromised.
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
.
Use the DIGEST value only when the value of the Message parameter is a
message digest. If you use the DIGEST value with a raw message, the security of the
verification operation can be compromised.
MessageType,
MessageTypeVerifyRequest.Builder signature(SdkBytes signature)
The signature that the Sign operation generated.
signature - The signature that the Sign operation generated.VerifyRequest.Builder signingAlgorithm(String signingAlgorithm)
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
signingAlgorithm - The signing algorithm that was used to sign the message. If you submit a different algorithm, the
signature verification fails.SigningAlgorithmSpec,
SigningAlgorithmSpecVerifyRequest.Builder signingAlgorithm(SigningAlgorithmSpec signingAlgorithm)
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
signingAlgorithm - The signing algorithm that was used to sign the message. If you submit a different algorithm, the
signature verification fails.SigningAlgorithmSpec,
SigningAlgorithmSpecVerifyRequest.Builder grantTokens(Collection<String> grantTokens)
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
grantTokens - A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
VerifyRequest.Builder grantTokens(String... grantTokens)
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
grantTokens - A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
VerifyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderVerifyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.