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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customer_master_key_specString

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

Returns:

  • (String)


2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2532

class GetPublicKeyResponse < Struct.new(
  :key_id,
  :public_key,
  :customer_master_key_spec,
  :key_usage,
  :encryption_algorithms,
  :signing_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_algorithmsArray<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>)


2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2532

class GetPublicKeyResponse < Struct.new(
  :key_id,
  :public_key,
  :customer_master_key_spec,
  :key_usage,
  :encryption_algorithms,
  :signing_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#key_idString

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

Returns:

  • (String)


2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2532

class GetPublicKeyResponse < Struct.new(
  :key_id,
  :public_key,
  :customer_master_key_spec,
  :key_usage,
  :encryption_algorithms,
  :signing_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#key_usageString

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:

  • (String)


2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2532

class GetPublicKeyResponse < Struct.new(
  :key_id,
  :public_key,
  :customer_master_key_spec,
  :key_usage,
  :encryption_algorithms,
  :signing_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#public_keyString

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)


2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2532

class GetPublicKeyResponse < Struct.new(
  :key_id,
  :public_key,
  :customer_master_key_spec,
  :key_usage,
  :encryption_algorithms,
  :signing_algorithms)
  SENSITIVE = []
  include Aws::Structure
end

#signing_algorithmsArray<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>)


2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2532

class GetPublicKeyResponse < Struct.new(
  :key_id,
  :public_key,
  :customer_master_key_spec,
  :key_usage,
  :encryption_algorithms,
  :signing_algorithms)
  SENSITIVE = []
  include Aws::Structure
end