Interface GetPublicKeyResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetPublicKeyResponse.Builder,
,GetPublicKeyResponse> KmsResponse.Builder
,SdkBuilder<GetPublicKeyResponse.Builder,
,GetPublicKeyResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetPublicKeyResponse
-
Method Summary
Modifier and TypeMethodDescriptioncustomerMasterKeySpec
(String customerMasterKeySpec) Deprecated.This field has been deprecated.customerMasterKeySpec
(CustomerMasterKeySpec customerMasterKeySpec) Deprecated.This field has been deprecated.encryptionAlgorithms
(Collection<EncryptionAlgorithmSpec> encryptionAlgorithms) The encryption algorithms that KMS supports for this key.encryptionAlgorithms
(EncryptionAlgorithmSpec... encryptionAlgorithms) The encryption algorithms that KMS supports for this key.encryptionAlgorithmsWithStrings
(String... encryptionAlgorithms) The encryption algorithms that KMS supports for this key.encryptionAlgorithmsWithStrings
(Collection<String> encryptionAlgorithms) The encryption algorithms that KMS supports for this key.The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.The type of the of the public key that was downloaded.The type of the of the public key that was downloaded.The permitted use of the public key.keyUsage
(KeyUsageType keyUsage) The permitted use of the public key.The exported public key.signingAlgorithms
(Collection<SigningAlgorithmSpec> signingAlgorithms) The signing algorithms that KMS supports for this key.signingAlgorithms
(SigningAlgorithmSpec... signingAlgorithms) The signing algorithms that KMS supports for this key.signingAlgorithmsWithStrings
(String... signingAlgorithms) The signing algorithms that KMS supports for this key.signingAlgorithmsWithStrings
(Collection<String> signingAlgorithms) The signing algorithms that KMS supports for this key.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
- Parameters:
keyId
- The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customerMasterKeySpec
Deprecated.This field has been deprecated. Instead, use the KeySpec field.Instead, use the
KeySpec
field in theGetPublicKey
response.The
KeySpec
andCustomerMasterKeySpec
fields have the same value. We recommend that you use theKeySpec
field in your code. However, to avoid breaking changes, KMS supports both fields.- Parameters:
customerMasterKeySpec
- Instead, use theKeySpec
field in theGetPublicKey
response.The
KeySpec
andCustomerMasterKeySpec
fields have the same value. We recommend that you use theKeySpec
field in your code. However, to avoid breaking changes, KMS supports both fields.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
customerMasterKeySpec
@Deprecated GetPublicKeyResponse.Builder customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec) Deprecated.This field has been deprecated. Instead, use the KeySpec field.Instead, use the
KeySpec
field in theGetPublicKey
response.The
KeySpec
andCustomerMasterKeySpec
fields have the same value. We recommend that you use theKeySpec
field in your code. However, to avoid breaking changes, KMS supports both fields.- Parameters:
customerMasterKeySpec
- Instead, use theKeySpec
field in theGetPublicKey
response.The
KeySpec
andCustomerMasterKeySpec
fields have the same value. We recommend that you use theKeySpec
field in your code. However, to avoid breaking changes, KMS supports both fields.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keySpec
The type of the of the public key that was downloaded.
- Parameters:
keySpec
- The type of the of the public key that was downloaded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keySpec
The type of the of the public key that was downloaded.
- Parameters:
keySpec
- The type of the of the public key that was downloaded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyUsage
The permitted use of the public key. Valid values are
ENCRYPT_DECRYPT
orSIGN_VERIFY
.This information is critical. If a public key with
SIGN_VERIFY
key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.- Parameters:
keyUsage
- The permitted use of the public key. Valid values areENCRYPT_DECRYPT
orSIGN_VERIFY
.This information is critical. If a public key with
SIGN_VERIFY
key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyUsage
The permitted use of the public key. Valid values are
ENCRYPT_DECRYPT
orSIGN_VERIFY
.This information is critical. If a public key with
SIGN_VERIFY
key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.- Parameters:
keyUsage
- The permitted use of the public key. Valid values areENCRYPT_DECRYPT
orSIGN_VERIFY
.This information is critical. If a public key with
SIGN_VERIFY
key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encryptionAlgorithmsWithStrings
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 isENCRYPT_DECRYPT
.- Parameters:
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 isENCRYPT_DECRYPT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionAlgorithmsWithStrings
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 isENCRYPT_DECRYPT
.- Parameters:
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 isENCRYPT_DECRYPT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionAlgorithms
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 isENCRYPT_DECRYPT
.- Parameters:
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 isENCRYPT_DECRYPT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isENCRYPT_DECRYPT
.- Parameters:
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 isENCRYPT_DECRYPT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
signingAlgorithmsWithStrings
The signing algorithms that KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.- Parameters:
signingAlgorithms
- The signing algorithms that KMS supports for this key.This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
signingAlgorithmsWithStrings
The signing algorithms that KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.- Parameters:
signingAlgorithms
- The signing algorithms that KMS supports for this key.This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
signingAlgorithms
The signing algorithms that KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.- Parameters:
signingAlgorithms
- The signing algorithms that KMS supports for this key.This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
signingAlgorithms
The signing algorithms that KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.- Parameters:
signingAlgorithms
- The signing algorithms that KMS supports for this key.This field appears in the response only when the
KeyUsage
of the public key isSIGN_VERIFY
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-