public class GetPublicKeyResult
extends java.lang.Object
implements java.io.Serializable
Constructor and Description 

GetPublicKeyResult() 
Modifier and Type  Method and Description 

boolean 
equals(java.lang.Object obj) 
java.lang.String 
getCustomerMasterKeySpec()
The type of the of the public key that was downloaded.

java.util.List<java.lang.String> 
getEncryptionAlgorithms()
The encryption algorithms that AWS KMS supports for this key.

java.lang.String 
getKeyId()
The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was
downloaded.

java.lang.String 
getKeyUsage()
The permitted use of the public key.

java.nio.ByteBuffer 
getPublicKey()
The exported public key.

java.util.List<java.lang.String> 
getSigningAlgorithms()
The signing algorithms that AWS KMS supports for this key.

int 
hashCode() 
void 
setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
The type of the of the public key that was downloaded.

void 
setCustomerMasterKeySpec(java.lang.String customerMasterKeySpec)
The type of the of the public key that was downloaded.

void 
setEncryptionAlgorithms(java.util.Collection<java.lang.String> encryptionAlgorithms)
The encryption algorithms that AWS KMS supports for this key.

void 
setKeyId(java.lang.String keyId)
The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was
downloaded.

void 
setKeyUsage(KeyUsageType keyUsage)
The permitted use of the public key.

void 
setKeyUsage(java.lang.String keyUsage)
The permitted use of the public key.

void 
setPublicKey(java.nio.ByteBuffer publicKey)
The exported public key.

void 
setSigningAlgorithms(java.util.Collection<java.lang.String> signingAlgorithms)
The signing algorithms that AWS KMS supports for this key.

java.lang.String 
toString()
Returns a string representation of this object; useful for testing and
debugging.

GetPublicKeyResult 
withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
The type of the of the public key that was downloaded.

GetPublicKeyResult 
withCustomerMasterKeySpec(java.lang.String customerMasterKeySpec)
The type of the of the public key that was downloaded.

GetPublicKeyResult 
withEncryptionAlgorithms(java.util.Collection<java.lang.String> encryptionAlgorithms)
The encryption algorithms that AWS KMS supports for this key.

GetPublicKeyResult 
withEncryptionAlgorithms(java.lang.String... encryptionAlgorithms)
The encryption algorithms that AWS KMS supports for this key.

GetPublicKeyResult 
withKeyId(java.lang.String keyId)
The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was
downloaded.

GetPublicKeyResult 
withKeyUsage(KeyUsageType keyUsage)
The permitted use of the public key.

GetPublicKeyResult 
withKeyUsage(java.lang.String keyUsage)
The permitted use of the public key.

GetPublicKeyResult 
withPublicKey(java.nio.ByteBuffer publicKey)
The exported public key.

GetPublicKeyResult 
withSigningAlgorithms(java.util.Collection<java.lang.String> signingAlgorithms)
The signing algorithms that AWS KMS supports for this key.

GetPublicKeyResult 
withSigningAlgorithms(java.lang.String... signingAlgorithms)
The signing algorithms that AWS KMS supports for this key.

public java.lang.String getKeyId()
The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
Constraints:
Length: 1  2048
The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
public void setKeyId(java.lang.String keyId)
The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
Constraints:
Length: 1  2048
keyId
 The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
public GetPublicKeyResult withKeyId(java.lang.String keyId)
The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1  2048
keyId
 The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
public java.nio.ByteBuffer getPublicKey()
The exported public key.
The value is a DERencoded X.509 public key, also known as
SubjectPublicKeyInfo
(SPKI), as defined in RFC 5280. When you use the
HTTP API or the AWS CLI, the value is Base64encoded. Otherwise, it is
not Base64encoded.
Constraints:
Length: 1  8192
The exported public key.
The value is a DERencoded X.509 public key, also known as
SubjectPublicKeyInfo
(SPKI), as defined in RFC 5280. When you
use the HTTP API or the AWS CLI, the value is Base64encoded.
Otherwise, it is not Base64encoded.
public void setPublicKey(java.nio.ByteBuffer publicKey)
The exported public key.
The value is a DERencoded X.509 public key, also known as
SubjectPublicKeyInfo
(SPKI), as defined in RFC 5280. When you use the
HTTP API or the AWS CLI, the value is Base64encoded. Otherwise, it is
not Base64encoded.
Constraints:
Length: 1  8192
publicKey
 The exported public key.
The value is a DERencoded X.509 public key, also known as
SubjectPublicKeyInfo
(SPKI), as defined in RFC 5280. When
you use the HTTP API or the AWS CLI, the value is
Base64encoded. Otherwise, it is not Base64encoded.
public GetPublicKeyResult withPublicKey(java.nio.ByteBuffer publicKey)
The exported public key.
The value is a DERencoded X.509 public key, also known as
SubjectPublicKeyInfo
(SPKI), as defined in RFC 5280. When you use the
HTTP API or the AWS CLI, the value is Base64encoded. Otherwise, it is
not Base64encoded.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1  8192
publicKey
 The exported public key.
The value is a DERencoded X.509 public key, also known as
SubjectPublicKeyInfo
(SPKI), as defined in RFC 5280. When
you use the HTTP API or the AWS CLI, the value is
Base64encoded. Otherwise, it is not Base64encoded.
public java.lang.String getCustomerMasterKeySpec()
The type of the of the public key that was downloaded.
Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256,
ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
The type of the of the public key that was downloaded.
CustomerMasterKeySpec
public void setCustomerMasterKeySpec(java.lang.String customerMasterKeySpec)
The type of the of the public key that was downloaded.
Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256,
ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
customerMasterKeySpec
 The type of the of the public key that was downloaded.
CustomerMasterKeySpec
public GetPublicKeyResult withCustomerMasterKeySpec(java.lang.String customerMasterKeySpec)
The type of the of the public key that was downloaded.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256,
ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
customerMasterKeySpec
 The type of the of the public key that was downloaded.
CustomerMasterKeySpec
public void setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
The type of the of the public key that was downloaded.
Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256,
ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
customerMasterKeySpec
 The type of the of the public key that was downloaded.
CustomerMasterKeySpec
public GetPublicKeyResult withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
The type of the of the public key that was downloaded.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256,
ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT
customerMasterKeySpec
 The type of the of the public key that was downloaded.
CustomerMasterKeySpec
public java.lang.String getKeyUsage()
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 AWS KMS, the
ciphertext cannot be decrypted.
Constraints:
Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
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 AWS
KMS, the ciphertext cannot be decrypted.
KeyUsageType
public void setKeyUsage(java.lang.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 AWS KMS, the
ciphertext cannot be decrypted.
Constraints:
Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
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
AWS KMS, the ciphertext cannot be decrypted.
KeyUsageType
public GetPublicKeyResult withKeyUsage(java.lang.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 AWS KMS, the
ciphertext cannot be decrypted.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
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
AWS KMS, the ciphertext cannot be decrypted.
KeyUsageType
public void setKeyUsage(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 AWS KMS, the
ciphertext cannot be decrypted.
Constraints:
Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
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
AWS KMS, the ciphertext cannot be decrypted.
KeyUsageType
public GetPublicKeyResult withKeyUsage(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 AWS KMS, the
ciphertext cannot be decrypted.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIGN_VERIFY, ENCRYPT_DECRYPT
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
AWS KMS, the ciphertext cannot be decrypted.
KeyUsageType
public java.util.List<java.lang.String> getEncryptionAlgorithms()
The encryption algorithms that AWS KMS supports for this key.
This information is critical. If a public key encrypts data outside of AWS 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
.
The encryption algorithms that AWS KMS supports for this key.
This information is critical. If a public key encrypts data outside of AWS 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
.
public void setEncryptionAlgorithms(java.util.Collection<java.lang.String> encryptionAlgorithms)
The encryption algorithms that AWS KMS supports for this key.
This information is critical. If a public key encrypts data outside of AWS 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 AWS KMS supports for this key.
This information is critical. If a public key encrypts data outside of AWS 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
.
public GetPublicKeyResult withEncryptionAlgorithms(java.lang.String... encryptionAlgorithms)
The encryption algorithms that AWS KMS supports for this key.
This information is critical. If a public key encrypts data outside of AWS 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
.
Returns a reference to this object so that method calls can be chained together.
encryptionAlgorithms
 The encryption algorithms that AWS KMS supports for this key.
This information is critical. If a public key encrypts data outside of AWS 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
.
public GetPublicKeyResult withEncryptionAlgorithms(java.util.Collection<java.lang.String> encryptionAlgorithms)
The encryption algorithms that AWS KMS supports for this key.
This information is critical. If a public key encrypts data outside of AWS 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
.
Returns a reference to this object so that method calls can be chained together.
encryptionAlgorithms
 The encryption algorithms that AWS KMS supports for this key.
This information is critical. If a public key encrypts data outside of AWS 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
.
public java.util.List<java.lang.String> getSigningAlgorithms()
The signing algorithms that AWS KMS supports for this key.
This field appears in the response only when the KeyUsage
of
the public key is SIGN_VERIFY
.
The signing algorithms that AWS KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key is
SIGN_VERIFY
.
public void setSigningAlgorithms(java.util.Collection<java.lang.String> signingAlgorithms)
The signing algorithms that AWS 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 AWS KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key is
SIGN_VERIFY
.
public GetPublicKeyResult withSigningAlgorithms(java.lang.String... signingAlgorithms)
The signing algorithms that AWS KMS supports for this key.
This field appears in the response only when the KeyUsage
of
the public key is SIGN_VERIFY
.
Returns a reference to this object so that method calls can be chained together.
signingAlgorithms
 The signing algorithms that AWS KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key is
SIGN_VERIFY
.
public GetPublicKeyResult withSigningAlgorithms(java.util.Collection<java.lang.String> signingAlgorithms)
The signing algorithms that AWS KMS supports for this key.
This field appears in the response only when the KeyUsage
of
the public key is SIGN_VERIFY
.
Returns a reference to this object so that method calls can be chained together.
signingAlgorithms
 The signing algorithms that AWS KMS supports for this key.
This field appears in the response only when the
KeyUsage
of the public key is
SIGN_VERIFY
.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.