You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KMS::Types::GetPublicKeyResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#customer_master_key_spec ⇒ String

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

Possible values:

  • RSA_2048
  • RSA_3072
  • RSA_4096
  • ECC_NIST_P256
  • ECC_NIST_P384
  • ECC_NIST_P521
  • ECC_SECG_P256K1
  • SYMMETRIC_DEFAULT

Returns:

  • (String) —

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

#encryption_algorithms ⇒ Array<String>

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:

  • (Array<String>) —

    The encryption algorithms that AWS KMS supports for this key.

#key_id ⇒ String

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

Returns:

  • (String) —

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

#key_usage ⇒ String

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.

Possible values:

  • SIGN_VERIFY
  • ENCRYPT_DECRYPT

Returns:

  • (String) —

    The permitted use of the public key.

#public_key ⇒ String

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:

  • (String) —

    The exported public key.

#signing_algorithms ⇒ Array<String>

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:

  • (Array<String>) —

    The signing algorithms that AWS KMS supports for this key.