Class: Aws::ConfigService::Types::BaseConfigurationItem

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-configservice/types.rb

Overview

The detailed configurations of a specified resource.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

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

Returns:

  • (String) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

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

#arn ⇒ String

The Amazon Resource Name (ARN) of the resource.

Returns:

  • (String) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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.

<note markdown=“1”> 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][1

in the *Config Developer Guide*.

</note>

[1]: docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency

Returns:

  • (Time) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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.

<note markdown=“1”> 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][1

in the *Config Developer Guide*.

</note>

[1]: docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency

Returns:

  • (String) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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 needs to be deserialized using ‘json.loads()` before you can access the contents.

Returns:

  • (Hash<String,String>) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

class BaseConfigurationItem < Struct.new(
  :version,
  :account_id,
  :configuration_item_capture_time,
  :configuration_item_status,
  :configuration_state_id,
  :arn,
  :resource_type,
  :resource_id,
  :resource_name,
  :aws_region,
  :availability_zone,
  :resource_creation_time,
  :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) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-configservice/types.rb', line 666

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