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

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsKmsKeyDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Contains metadata about an KMS key.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aws_account_id ⇒ String

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

• #creation_date ⇒ Float

  Indicates when the KMS key was created.

• #description ⇒ String

  A description of the KMS key.

• #key_id ⇒ String

  The globally unique identifier for the KMS key.

• #key_manager ⇒ String

  The manager of the KMS key.

• #key_rotation_status ⇒ Boolean

  Whether the key has key rotation enabled.

• #key_state ⇒ String

  The state of the KMS key.

• #origin ⇒ String

  The source of the KMS key material.

Instance Attribute Details

#aws_account_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14425

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_date ⇒ Float

Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

• (Float)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14425

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

#description ⇒ String

A description of the KMS key.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14425

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_id ⇒ String

The globally unique identifier for the KMS key.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14425

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_manager ⇒ String

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)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14425

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_status ⇒ Boolean

Whether the key has key rotation enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14425

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_state ⇒ String

The state of the KMS key. Valid values are as follows:

• Disabled

• Enabled

• PendingDeletion

• PendingImport

• Unavailable

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14425

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

#origin ⇒ String

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)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 14425

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