Class: Aws::KMS::Types::GetPublicKeyResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::GetPublicKeyResponse
- Defined in:
- gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#customer_master_key_spec ⇒ String
Instead, use the
KeySpec
field in theGetPublicKey
response. -
#encryption_algorithms ⇒ Array<String>
The encryption algorithms that KMS supports for this key.
-
#key_id ⇒ String
The Amazon Resource Name ([key ARN][1]) of the asymmetric KMS key from which the public key was downloaded.
-
#key_spec ⇒ String
The type of the of the public key that was downloaded.
-
#key_usage ⇒ String
The permitted use of the public key.
-
#public_key ⇒ String
The exported public key.
-
#signing_algorithms ⇒ Array<String>
The signing algorithms that KMS supports for this key.
Instance Attribute Details
#customer_master_key_spec ⇒ String
Instead, use the KeySpec
field in the GetPublicKey
response.
The KeySpec
and CustomerMasterKeySpec
fields have the same
value. We recommend that you use the KeySpec
field in your code.
However, to avoid breaking changes, KMS supports both fields.
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 |
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3419 class GetPublicKeyResponse < Struct.new( :key_id, :public_key, :customer_master_key_spec, :key_spec, :key_usage, :encryption_algorithms, :signing_algorithms) SENSITIVE = [] include Aws::Structure end |
#encryption_algorithms ⇒ Array<String>
The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of 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
.
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 |
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3419 class GetPublicKeyResponse < Struct.new( :key_id, :public_key, :customer_master_key_spec, :key_spec, :key_usage, :encryption_algorithms, :signing_algorithms) SENSITIVE = [] include Aws::Structure end |
#key_id ⇒ String
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 |
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3419 class GetPublicKeyResponse < Struct.new( :key_id, :public_key, :customer_master_key_spec, :key_spec, :key_usage, :encryption_algorithms, :signing_algorithms) SENSITIVE = [] include Aws::Structure end |
#key_spec ⇒ String
The type of the of the public key that was downloaded.
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 |
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3419 class GetPublicKeyResponse < Struct.new( :key_id, :public_key, :customer_master_key_spec, :key_spec, :key_usage, :encryption_algorithms, :signing_algorithms) SENSITIVE = [] include Aws::Structure end |
#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 KMS, the ciphertext cannot be
decrypted.
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 |
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3419 class GetPublicKeyResponse < Struct.new( :key_id, :public_key, :customer_master_key_spec, :key_spec, :key_usage, :encryption_algorithms, :signing_algorithms) SENSITIVE = [] include Aws::Structure end |
#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 Amazon Web Services CLI, the value is
Base64-encoded. Otherwise, it is not Base64-encoded.
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 |
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3419 class GetPublicKeyResponse < Struct.new( :key_id, :public_key, :customer_master_key_spec, :key_spec, :key_usage, :encryption_algorithms, :signing_algorithms) SENSITIVE = [] include Aws::Structure end |
#signing_algorithms ⇒ Array<String>
The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the
public key is SIGN_VERIFY
.
3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 |
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3419 class GetPublicKeyResponse < Struct.new( :key_id, :public_key, :customer_master_key_spec, :key_spec, :key_usage, :encryption_algorithms, :signing_algorithms) SENSITIVE = [] include Aws::Structure end |