com.amazonaws.services.kms.model

Class GetPublicKeyResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kms.model.GetPublicKeyResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetPublicKeyResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetPublicKeyResult()

Method Summary

Modifier and Type	Method and Description
GetPublicKeyResult	clone()
boolean	equals(Object obj)
String	getCustomerMasterKeySpec() The type of the of the public key that was downloaded.
List<String>	getEncryptionAlgorithms() The encryption algorithms that AWS KMS supports for this key.
String	getKeyId() The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
String	getKeyUsage() The permitted use of the public key.
ByteBuffer	getPublicKey() The exported public key.
List<String>	getSigningAlgorithms() The signing algorithms that AWS KMS supports for this key.
int	hashCode()
void	setCustomerMasterKeySpec(String customerMasterKeySpec) The type of the of the public key that was downloaded.
void	setEncryptionAlgorithms(Collection<String> encryptionAlgorithms) The encryption algorithms that AWS KMS supports for this key.
void	setKeyId(String keyId) The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.
void	setKeyUsage(String keyUsage) The permitted use of the public key.
void	setPublicKey(ByteBuffer publicKey) The exported public key.
void	setSigningAlgorithms(Collection<String> signingAlgorithms) The signing algorithms that AWS KMS supports for this key.
String	toString() Returns a string representation of this object.
GetPublicKeyResult	withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec) The type of the of the public key that was downloaded.
GetPublicKeyResult	withCustomerMasterKeySpec(String customerMasterKeySpec) The type of the of the public key that was downloaded.
GetPublicKeyResult	withEncryptionAlgorithms(Collection<String> encryptionAlgorithms) The encryption algorithms that AWS KMS supports for this key.
GetPublicKeyResult	withEncryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms) The encryption algorithms that AWS KMS supports for this key.
GetPublicKeyResult	withEncryptionAlgorithms(String... encryptionAlgorithms) The encryption algorithms that AWS KMS supports for this key.
GetPublicKeyResult	withKeyId(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(String keyUsage) The permitted use of the public key.
GetPublicKeyResult	withPublicKey(ByteBuffer publicKey) The exported public key.
GetPublicKeyResult	withSigningAlgorithms(Collection<String> signingAlgorithms) The signing algorithms that AWS KMS supports for this key.
GetPublicKeyResult	withSigningAlgorithms(SigningAlgorithmSpec... signingAlgorithms) The signing algorithms that AWS KMS supports for this key.
GetPublicKeyResult	withSigningAlgorithms(String... signingAlgorithms) The signing algorithms that AWS KMS supports for this key.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetPublicKeyResult

public GetPublicKeyResult()

Method Detail

setKeyId

public void setKeyId(String keyId)

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

Parameters:

keyId - The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

getKeyId

public String getKeyId()

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

Returns:

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

withKeyId

public GetPublicKeyResult withKeyId(String keyId)

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

Parameters:

keyId - The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPublicKey

public void setPublicKey(ByteBuffer 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

getPublicKey

public ByteBuffer getPublicKey()

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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

withPublicKey

public GetPublicKeyResult withPublicKey(ByteBuffer 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

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 AWS 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.

setCustomerMasterKeySpec

public void setCustomerMasterKeySpec(String customerMasterKeySpec)

The type of the of the public key that was downloaded.

Parameters:

customerMasterKeySpec - The type of the of the public key that was downloaded.

See Also:

CustomerMasterKeySpec

getCustomerMasterKeySpec

public String getCustomerMasterKeySpec()

The type of the of the public key that was downloaded.

Returns:

The type of the of the public key that was downloaded.

See Also:

CustomerMasterKeySpec

withCustomerMasterKeySpec

public GetPublicKeyResult withCustomerMasterKeySpec(String customerMasterKeySpec)

The type of the of the public key that was downloaded.

Parameters:

customerMasterKeySpec - 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:

CustomerMasterKeySpec

withCustomerMasterKeySpec

public GetPublicKeyResult withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)

The type of the of the public key that was downloaded.

Parameters:

customerMasterKeySpec - 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:

CustomerMasterKeySpec

setKeyUsage

public void setKeyUsage(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.

Parameters:

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.

See Also:

KeyUsageType

getKeyUsage

public 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.

Returns:

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.

See Also:

KeyUsageType

withKeyUsage

public GetPublicKeyResult withKeyUsage(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

KeyUsageType

withKeyUsage

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

KeyUsageType

getEncryptionAlgorithms

public List<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.

Returns:

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.

See Also:

EncryptionAlgorithmSpec

setEncryptionAlgorithms

public void setEncryptionAlgorithms(Collection<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.

Parameters:

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.

See Also:

EncryptionAlgorithmSpec

withEncryptionAlgorithms

public GetPublicKeyResult withEncryptionAlgorithms(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.

NOTE: This method appends the values to the existing list (if any). Use setEncryptionAlgorithms(java.util.Collection) or withEncryptionAlgorithms(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlgorithmSpec

withEncryptionAlgorithms

public GetPublicKeyResult withEncryptionAlgorithms(Collection<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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlgorithmSpec

withEncryptionAlgorithms

public GetPublicKeyResult withEncryptionAlgorithms(EncryptionAlgorithmSpec... 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlgorithmSpec

getSigningAlgorithms

public List<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.

Returns:

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.

See Also:

SigningAlgorithmSpec

setSigningAlgorithms

public void setSigningAlgorithms(Collection<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.

Parameters:

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.

See Also:

SigningAlgorithmSpec

withSigningAlgorithms

public GetPublicKeyResult withSigningAlgorithms(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.

NOTE: This method appends the values to the existing list (if any). Use setSigningAlgorithms(java.util.Collection) or withSigningAlgorithms(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlgorithmSpec

withSigningAlgorithms

public GetPublicKeyResult withSigningAlgorithms(Collection<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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlgorithmSpec

withSigningAlgorithms

public GetPublicKeyResult withSigningAlgorithms(SigningAlgorithmSpec... 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlgorithmSpec

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetPublicKeyResult clone()

Overrides:

clone in class Object