Class: Aws::SecurityHub::Types::AwsKmsKeyDetails

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

Overview

Note:

When making an API call, you may pass AwsKmsKeyDetails data as a hash:

{
  aws_account_id: "NonEmptyString",
  creation_date: 1.0,
  key_id: "NonEmptyString",
  key_manager: "NonEmptyString",
  key_state: "NonEmptyString",
  origin: "NonEmptyString",
  description: "NonEmptyString",
}

Contains metadata about a customer master key (CMK).

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The twelve-digit account ID of the AWS account that owns the CMK.

Returns:

  • (String)


5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5999

class AwsKmsKeyDetails < Struct.new(
  :aws_account_id,
  :creation_date,
  :key_id,
  :key_manager,
  :key_state,
  :origin,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateFloat

Indicates when the CMK was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (Float)


5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5999

class AwsKmsKeyDetails < Struct.new(
  :aws_account_id,
  :creation_date,
  :key_id,
  :key_manager,
  :key_state,
  :origin,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the key.

Returns:

  • (String)


5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5999

class AwsKmsKeyDetails < Struct.new(
  :aws_account_id,
  :creation_date,
  :key_id,
  :key_manager,
  :key_state,
  :origin,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#key_idString

The globally unique identifier for the CMK.

Returns:

  • (String)


5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5999

class AwsKmsKeyDetails < Struct.new(
  :aws_account_id,
  :creation_date,
  :key_id,
  :key_manager,
  :key_state,
  :origin,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#key_managerString

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.

Returns:

  • (String)


5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5999

class AwsKmsKeyDetails < Struct.new(
  :aws_account_id,
  :creation_date,
  :key_id,
  :key_manager,
  :key_state,
  :origin,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#key_stateString

The state of the CMK.

Returns:

  • (String)


5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5999

class AwsKmsKeyDetails < Struct.new(
  :aws_account_id,
  :creation_date,
  :key_id,
  :key_manager,
  :key_state,
  :origin,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#originString

The source of the CMK's key material.

When this value is AWS_KMS, AWS KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

Returns:

  • (String)


5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5999

class AwsKmsKeyDetails < Struct.new(
  :aws_account_id,
  :creation_date,
  :key_id,
  :key_manager,
  :key_state,
  :origin,
  :description)
  SENSITIVE = []
  include Aws::Structure
end