Interface GenerateDataKeyPairResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GenerateDataKeyPairResponse.Builder,
,GenerateDataKeyPairResponse> KmsResponse.Builder
,SdkBuilder<GenerateDataKeyPairResponse.Builder,
,GenerateDataKeyPairResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GenerateDataKeyPairResponse
-
Method Summary
Modifier and TypeMethodDescriptionciphertextForRecipient
(SdkBytes ciphertextForRecipient) The plaintext private data key encrypted with the public key from the Nitro enclave.The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.keyPairSpec
(String keyPairSpec) The type of data key pair that was generated.keyPairSpec
(DataKeyPairSpec keyPairSpec) The type of data key pair that was generated.privateKeyCiphertextBlob
(SdkBytes privateKeyCiphertextBlob) The encrypted copy of the private key.privateKeyPlaintext
(SdkBytes privateKeyPlaintext) The plaintext copy of the private key.The public key (in plaintext).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
-
privateKeyCiphertextBlob
The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
- Parameters:
privateKeyCiphertextBlob
- The encrypted copy of the private key. 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.
-
privateKeyPlaintext
The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
If the response includes the
CiphertextForRecipient
field, thePrivateKeyPlaintext
field is null or empty.- Parameters:
privateKeyPlaintext
- The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.If the response includes the
CiphertextForRecipient
field, thePrivateKeyPlaintext
field is null or empty.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publicKey
The public key (in plaintext). 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 public key (in plaintext). 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.
-
keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
- Parameters:
keyId
- The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyPairSpec
The type of data key pair that was generated.
- Parameters:
keyPairSpec
- The type of data key pair that was generated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyPairSpec
The type of data key pair that was generated.
- Parameters:
keyPairSpec
- The type of data key pair that was generated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ciphertextForRecipient
The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.
This field is included in the response only when the
Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.- Parameters:
ciphertextForRecipient
- The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.This field is included in the response only when the
Recipient
parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-