Class: Aws::PaymentCryptography::Types::Key

Inherits:

Struct

Object
Struct
Aws::PaymentCryptography::Types::Key

show all

Defined in:: gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb

Overview

Metadata about an Amazon Web Services Payment Cryptography key.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#create_timestamp ⇒ Time
The date and time when the key was created.
#delete_pending_timestamp ⇒ Time
The date and time after which Amazon Web Services Payment Cryptography will delete the key.
#delete_timestamp ⇒ Time
The date and time after which Amazon Web Services Payment Cryptography will delete the key.
#derive_key_usage ⇒ String
The cryptographic usage of an ECDH derived key as deﬁned in section A.5.2 of the TR-31 spec.
#enabled ⇒ Boolean
Specifies whether the key is enabled.
#exportable ⇒ Boolean
Specifies whether the key is exportable.
#key_arn ⇒ String
The Amazon Resource Name (ARN) of the key.
#key_attributes ⇒ Types::KeyAttributes
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
#key_check_value ⇒ String
The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
#key_check_value_algorithm ⇒ String
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
#key_origin ⇒ String
The source of the key material.
#key_state ⇒ String
The state of key that is being created or deleted.
#usage_start_timestamp ⇒ Time
The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
#usage_stop_timestamp ⇒ Time
The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

Instance Attribute Details

#create_timestamp ⇒ `Time`

The date and time when the key was created.

Returns:

(Time)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#delete_pending_timestamp ⇒ `Time`

The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.

Returns:

(Time)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#delete_timestamp ⇒ `Time`

The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.

Returns:

(Time)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#derive_key_usage ⇒ `String`

The cryptographic usage of an ECDH derived key as deﬁned in section A.5.2 of the TR-31 spec.

Returns:

(String)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ `Boolean`

Specifies whether the key is enabled.

Returns:

(Boolean)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#exportable ⇒ `Boolean`

Specifies whether the key is exportable. This data is immutable after the key is created.

Returns:

(Boolean)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#key_arn ⇒ `String`

The Amazon Resource Name (ARN) of the key.

Returns:

(String)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#key_attributes ⇒ `Types::KeyAttributes`

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

Returns:

(Types::KeyAttributes)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#key_check_value ⇒ `String`

The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

Returns:

(String)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#key_check_value_algorithm ⇒ `String`

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

Returns:

(String)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#key_origin ⇒ `String`

The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.

Returns:

(String)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#key_state ⇒ `String`

The state of key that is being created or deleted.

Returns:

(String)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#usage_start_timestamp ⇒ `Time`

The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.

Returns:

(Time)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

#usage_stop_timestamp ⇒ `Time`

The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

Returns:

(Time)

# File 'gems/aws-sdk-paymentcryptography/lib/aws-sdk-paymentcryptography/types.rb', line 1157

class Key < Struct.new(
  :key_arn,
  :key_attributes,
  :key_check_value,
  :key_check_value_algorithm,
  :enabled,
  :exportable,
  :key_state,
  :key_origin,
  :create_timestamp,
  :usage_start_timestamp,
  :usage_stop_timestamp,
  :delete_pending_timestamp,
  :delete_timestamp,
  :derive_key_usage)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::PaymentCryptography::Types::Key

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#create_timestamp ⇒ Time

#delete_pending_timestamp ⇒ Time

#delete_timestamp ⇒ Time

#derive_key_usage ⇒ String

#enabled ⇒ Boolean

#exportable ⇒ Boolean

#key_arn ⇒ String

#key_attributes ⇒ Types::KeyAttributes

#key_check_value ⇒ String

#key_check_value_algorithm ⇒ String

#key_origin ⇒ String

#key_state ⇒ String

#usage_start_timestamp ⇒ Time

#usage_stop_timestamp ⇒ Time

#create_timestamp ⇒ `Time`

#delete_pending_timestamp ⇒ `Time`

#delete_timestamp ⇒ `Time`

#derive_key_usage ⇒ `String`

#enabled ⇒ `Boolean`

#exportable ⇒ `Boolean`

#key_arn ⇒ `String`

#key_attributes ⇒ `Types::KeyAttributes`

#key_check_value ⇒ `String`

#key_check_value_algorithm ⇒ `String`

#key_origin ⇒ `String`

#key_state ⇒ `String`

#usage_start_timestamp ⇒ `Time`

#usage_stop_timestamp ⇒ `Time`