Class: Aws::ConfigService::Types::ConfigurationItem

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::ConfigurationItem

Defined in:

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

Overview

A list that contains detailed configurations of a specified resource.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The 12-digit Amazon Web Services account ID associated with the resource.

• #arn ⇒ String

  Amazon Resource Name (ARN) associated with the resource.

• #availability_zone ⇒ String

  The Availability Zone associated with the resource.

• #aws_region ⇒ String

  The region where the resource resides.

• #configuration ⇒ String

  A JSON-encoded string that contains the contents for the resource configuration.

• #configuration_item_capture_time ⇒ Time

  The time when the recording of configuration changes was initiated for the resource.

• #configuration_item_delivery_time ⇒ Time

  The time when configuration changes for the resource were delivered.

• #configuration_item_md5_hash ⇒ String

  Unique MD5 hash that represents the configuration item's state.

• #configuration_item_status ⇒ String

  The configuration item status.

• #configuration_state_id ⇒ String

  An identifier that indicates the ordering of the configuration items of a resource.

• #recording_frequency ⇒ String

  The recording frequency that Config uses to record configuration changes for the resource.

• #related_events ⇒ Array<String>

  A list of CloudTrail event IDs.

• #relationships ⇒ Array<Types::Relationship>

  A list of related Amazon Web Services resources.

• #resource_creation_time ⇒ Time

  The time stamp when the resource was created.

• #resource_id ⇒ String

  The ID of the resource (for example, sg-xxxxxx).

• #resource_name ⇒ String

  The custom name of the resource, if available.

• #resource_type ⇒ String

  The type of Amazon Web Services resource.

• #supplementary_configuration ⇒ Hash<String,String>

  A string to string map that contains additional contents for the resource configuration.Config returns this field for certain resource types to supplement the information returned for the configuration field.

• #tags ⇒ Hash<String,String>

  A mapping of key value tags associated with the resource.

• #version ⇒ String

  The version number of the resource configuration.

Instance Attribute Details

#account_id ⇒ String

The 12-digit Amazon Web Services account ID associated with the resource.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

Amazon Resource Name (ARN) associated with the resource.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone associated with the resource.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#aws_region ⇒ String

The region where the resource resides.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ String

A JSON-encoded string that contains the contents for the resource configuration. This string needs to be deserialized using json.loads() before you can access the contents.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_item_capture_time ⇒ Time

The time when the recording of configuration changes was initiated for the resource.

Returns:

• (Time)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_item_delivery_time ⇒ Time

The time when configuration changes for the resource were delivered.

This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording, this field will be populated. However, if you are using continuous recording, this field will be omitted since the delivery time is instantaneous as the CI is available right away.

For more information on daily recording and continuous recording, see Recording Frequency in the Config Developer Guide.

Returns:

• (Time)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_item_md5_hash ⇒ String

Unique MD5 hash that represents the configuration item's state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_item_status ⇒ String

The configuration item status. Valid values include:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder doesn't record resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder doesn't record resources of this type

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_state_id ⇒ String

An identifier that indicates the ordering of the configuration items of a resource.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#recording_frequency ⇒ String

The recording frequency that Config uses to record configuration changes for the resource.

This field only appears in the API response when DAILY recording is enabled for a resource type. If this field is not present, CONTINUOUS recording is enabled for that resource type. For more information on daily recording and continuous recording, see Recording Frequency in the Config Developer Guide.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#related_events ⇒ Array<String>

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#relationships ⇒ Array<Types::Relationship>

A list of related Amazon Web Services resources.

Returns:

• (Array<Types::Relationship>)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_creation_time ⇒ Time

The time stamp when the resource was created.

Returns:

• (Time)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ String

The ID of the resource (for example, sg-xxxxxx).

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_name ⇒ String

The custom name of the resource, if available.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of Amazon Web Services resource.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#supplementary_configuration ⇒ Hash<String,String>

A string to string map that contains additional contents for the resource configuration.Config returns this field for certain resource types to supplement the information returned for the configuration field.

This string to string map needs to be deserialized using json.loads() before you can accessing the contents.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A mapping of key value tags associated with the resource.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version number of the resource configuration.

Returns:

• (String)

# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1560

class ConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :configuration_item_md5_hash,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :tags,
  :related_events,
  :relationships,
  :configuration,
  :supplementary_configuration,
  :recording_frequency,
  :configuration_item_delivery_time)
  SENSITIVE = []
  include Aws::Structure
end