public static interface GetPublicKeyResponse.Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder<GetPublicKeyResponse.Builder,GetPublicKeyResponse>
Modifier and Type | Method and Description |
---|---|
GetPublicKeyResponse.Builder |
customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
Deprecated.
This field has been deprecated. Instead, use the KeySpec field.
|
GetPublicKeyResponse.Builder |
customerMasterKeySpec(String customerMasterKeySpec)
Deprecated.
This field has been deprecated. Instead, use the KeySpec field.
|
GetPublicKeyResponse.Builder |
encryptionAlgorithms(Collection<EncryptionAlgorithmSpec> encryptionAlgorithms)
The encryption algorithms that KMS supports for this key.
|
GetPublicKeyResponse.Builder |
encryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms)
The encryption algorithms that KMS supports for this key.
|
GetPublicKeyResponse.Builder |
encryptionAlgorithmsWithStrings(Collection<String> encryptionAlgorithms)
The encryption algorithms that KMS supports for this key.
|
GetPublicKeyResponse.Builder |
encryptionAlgorithmsWithStrings(String... encryptionAlgorithms)
The encryption algorithms that KMS supports for this key.
|
GetPublicKeyResponse.Builder |
keyId(String keyId)
The Amazon Resource Name (key ARN) of the
asymmetric KMS key from which the public key was downloaded.
|
GetPublicKeyResponse.Builder |
keySpec(KeySpec keySpec)
The type of the of the public key that was downloaded.
|
GetPublicKeyResponse.Builder |
keySpec(String keySpec)
The type of the of the public key that was downloaded.
|
GetPublicKeyResponse.Builder |
keyUsage(KeyUsageType keyUsage)
The permitted use of the public key.
|
GetPublicKeyResponse.Builder |
keyUsage(String keyUsage)
The permitted use of the public key.
|
GetPublicKeyResponse.Builder |
publicKey(SdkBytes publicKey)
The exported public key.
|
GetPublicKeyResponse.Builder |
signingAlgorithms(Collection<SigningAlgorithmSpec> signingAlgorithms)
The signing algorithms that KMS supports for this key.
|
GetPublicKeyResponse.Builder |
signingAlgorithms(SigningAlgorithmSpec... signingAlgorithms)
The signing algorithms that KMS supports for this key.
|
GetPublicKeyResponse.Builder |
signingAlgorithmsWithStrings(Collection<String> signingAlgorithms)
The signing algorithms that KMS supports for this key.
|
GetPublicKeyResponse.Builder |
signingAlgorithmsWithStrings(String... signingAlgorithms)
The signing algorithms that KMS supports for this key.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
GetPublicKeyResponse.Builder keyId(String keyId)
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
keyId
- The Amazon Resource Name (key ARN)
of the asymmetric KMS key from which the public key was downloaded.GetPublicKeyResponse.Builder publicKey(SdkBytes publicKey)
The exported public key.
The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo
(SPKI), as
defined in RFC 5280. When you use the HTTP API or the
Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
publicKey
- The exported public key.
The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo
(SPKI),
as defined in RFC 5280. When you use the HTTP API or
the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
@Deprecated GetPublicKeyResponse.Builder customerMasterKeySpec(String customerMasterKeySpec)
Instead, use the KeySpec
field in the GetPublicKey
response.
The KeySpec
and CustomerMasterKeySpec
fields have the same value. We recommend that
you use the KeySpec
field in your code. However, to avoid breaking changes, KMS will support
both fields.
customerMasterKeySpec
- Instead, use the KeySpec
field in the GetPublicKey
response.
The KeySpec
and CustomerMasterKeySpec
fields have the same value. We
recommend that you use the KeySpec
field in your code. However, to avoid breaking
changes, KMS will support both fields.
CustomerMasterKeySpec
,
CustomerMasterKeySpec
@Deprecated GetPublicKeyResponse.Builder customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
Instead, use the KeySpec
field in the GetPublicKey
response.
The KeySpec
and CustomerMasterKeySpec
fields have the same value. We recommend that
you use the KeySpec
field in your code. However, to avoid breaking changes, KMS will support
both fields.
customerMasterKeySpec
- Instead, use the KeySpec
field in the GetPublicKey
response.
The KeySpec
and CustomerMasterKeySpec
fields have the same value. We
recommend that you use the KeySpec
field in your code. However, to avoid breaking
changes, KMS will support both fields.
CustomerMasterKeySpec
,
CustomerMasterKeySpec
GetPublicKeyResponse.Builder keySpec(String keySpec)
The type of the of the public key that was downloaded.
GetPublicKeyResponse.Builder keySpec(KeySpec keySpec)
The type of the of the public key that was downloaded.
GetPublicKeyResponse.Builder keyUsage(String keyUsage)
The permitted use of the public key. Valid values are ENCRYPT_DECRYPT
or
SIGN_VERIFY
.
This information is critical. If a public key with SIGN_VERIFY
key usage encrypts data outside
of KMS, the ciphertext cannot be decrypted.
keyUsage
- The permitted use of the public key. Valid values are ENCRYPT_DECRYPT
or
SIGN_VERIFY
.
This information is critical. If a public key with SIGN_VERIFY
key usage encrypts data
outside of KMS, the ciphertext cannot be decrypted.
KeyUsageType
,
KeyUsageType
GetPublicKeyResponse.Builder keyUsage(KeyUsageType keyUsage)
The permitted use of the public key. Valid values are ENCRYPT_DECRYPT
or
SIGN_VERIFY
.
This information is critical. If a public key with SIGN_VERIFY
key usage encrypts data outside
of KMS, the ciphertext cannot be decrypted.
keyUsage
- The permitted use of the public key. Valid values are ENCRYPT_DECRYPT
or
SIGN_VERIFY
.
This information is critical. If a public key with SIGN_VERIFY
key usage encrypts data
outside of KMS, the ciphertext cannot be decrypted.
KeyUsageType
,
KeyUsageType
GetPublicKeyResponse.Builder encryptionAlgorithmsWithStrings(Collection<String> encryptionAlgorithms)
The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the public key is
ENCRYPT_DECRYPT
.
encryptionAlgorithms
- The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the public key is
ENCRYPT_DECRYPT
.
GetPublicKeyResponse.Builder encryptionAlgorithmsWithStrings(String... encryptionAlgorithms)
The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the public key is
ENCRYPT_DECRYPT
.
encryptionAlgorithms
- The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the public key is
ENCRYPT_DECRYPT
.
GetPublicKeyResponse.Builder encryptionAlgorithms(Collection<EncryptionAlgorithmSpec> encryptionAlgorithms)
The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the public key is
ENCRYPT_DECRYPT
.
encryptionAlgorithms
- The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the public key is
ENCRYPT_DECRYPT
.
GetPublicKeyResponse.Builder encryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms)
The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the public key is
ENCRYPT_DECRYPT
.
encryptionAlgorithms
- The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the public key is
ENCRYPT_DECRYPT
.
GetPublicKeyResponse.Builder signingAlgorithmsWithStrings(Collection<String> signingAlgorithms)
The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
signingAlgorithms
- The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
GetPublicKeyResponse.Builder signingAlgorithmsWithStrings(String... signingAlgorithms)
The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
signingAlgorithms
- The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
GetPublicKeyResponse.Builder signingAlgorithms(Collection<SigningAlgorithmSpec> signingAlgorithms)
The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
signingAlgorithms
- The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
GetPublicKeyResponse.Builder signingAlgorithms(SigningAlgorithmSpec... signingAlgorithms)
The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
signingAlgorithms
- The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the public key is
SIGN_VERIFY
.
Copyright © 2022. All rights reserved.