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",
  key_rotation_status: false,
}

Contains metadata about an KMS key.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

Returns:

  • (String)


13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 13407

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

#creation_dateFloat

Indicates when the KMS key 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)


13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 13407

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

#descriptionString

A description of the KMS key.

Returns:

  • (String)


13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 13407

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

#key_idString

The globally unique identifier for the KMS key.

Returns:

  • (String)


13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 13407

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

#key_managerString

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

Returns:

  • (String)


13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 13407

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

#key_rotation_statusBoolean

Whether the key has key rotation enabled.

Returns:

  • (Boolean)


13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 13407

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

#key_stateString

The state of the KMS key.

Returns:

  • (String)


13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 13407

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

#originString

The source of the KMS key material.

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

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

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

Returns:

  • (String)


13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 13407

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