You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Instance Attribute Summary

• #account_id ⇒ String

  The 12-digit AWS account ID associated with the resource.

• #arn ⇒ String

  accoun.

• #availability_zone ⇒ String

  The Availability Zone associated with the resource.

• #aws_region ⇒ String

  The region where the resource resides.

• #configuration ⇒ String

  The description of the resource configuration.

• #configuration_item_capture_time ⇒ Time

  The time when the configuration recording was initiated.

• #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.

• #related_events ⇒ Array<String>

  A list of CloudTrail event IDs.

• #relationships ⇒ Array<Types::Relationship>

  A list of related AWS 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 AWS resource.

• #supplementary_configuration ⇒ Hash<String,String>

  Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the configuration parameter.

• #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 AWS account ID associated with the resource.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#arn ⇒ String

accoun

Returns:

• (String)

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

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)
  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 1175

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)
  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 1175

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)
  include Aws::Structure
end

#configuration ⇒ String

The description of the resource configuration.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#configuration_item_capture_time ⇒ Time

The time when the configuration recording was initiated.

Returns:

• (Time)

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

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)
  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 1175

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)
  include Aws::Structure
end

#configuration_item_status ⇒ String

The configuration item status.

Returns:

• (String)

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

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)
  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 1175

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)
  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 AWS 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 AWS 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 1175

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)
  include Aws::Structure
end

#relationships ⇒ Array<Types::Relationship>

A list of related AWS resources.

Returns:

• (Array<Types::Relationship>)

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

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)
  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 1175

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)
  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 1175

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)
  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 1175

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)
  include Aws::Structure
end

#resource_type ⇒ String

The type of AWS resource.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#supplementary_configuration ⇒ Hash<String,String>

Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the configuration parameter.

Returns:

• (Hash<String,String>)

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

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)
  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 1175

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)
  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 1175

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)
  include Aws::Structure
end