Amazonka.Config.Types.ConfigurationItem

Documentation

data ConfigurationItem

A list that contains detailed configurations of a specified resource.

See: newConfigurationItem smart constructor.

Constructors

ConfigurationItem'

Fields

• accountId :: Maybe Text

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

• arn :: Maybe Text

  Amazon Resource Name (ARN) associated with the resource.

• availabilityZone :: Maybe Text

  The Availability Zone associated with the resource.

• awsRegion :: Maybe Text

  The region where the resource resides.

• configuration :: Maybe Text

  The description of the resource configuration.

• configurationItemCaptureTime :: Maybe POSIX

  The time when the configuration recording was initiated.

• configurationItemMD5Hash :: Maybe Text

  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.

• configurationItemStatus :: Maybe ConfigurationItemStatus

  The configuration item status. The valid values are:

  • 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 excludes the recording of resources of this type
  • ResourceDeleted – The resource was deleted
  • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

  The CIs do not incur any cost.

• configurationStateId :: Maybe Text

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

• relatedEvents :: Maybe [Text]

  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.

• relationships :: Maybe [Relationship]

  A list of related Amazon Web Services resources.

• resourceCreationTime :: Maybe POSIX

  The time stamp when the resource was created.

• resourceId :: Maybe Text

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

• resourceName :: Maybe Text

  The custom name of the resource, if available.

• resourceType :: Maybe ResourceType

  The type of Amazon Web Services resource.

• supplementaryConfiguration :: Maybe (HashMap Text Text)

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

• tags :: Maybe (HashMap Text Text)

  A mapping of key value tags associated with the resource.

• version :: Maybe Text

  The version number of the resource configuration.

Instances

FromJSON ConfigurationItem

Defined in Amazonka.Config.Types.ConfigurationItem

Methods

parseJSON :: Value -> Parser ConfigurationItem

parseJSONList :: Value -> Parser [ConfigurationItem]

Generic ConfigurationItem

Defined in Amazonka.Config.Types.ConfigurationItem

Associated Types

type Rep ConfigurationItem :: Type -> Type

Methods

from :: ConfigurationItem -> Rep ConfigurationItem x

to :: Rep ConfigurationItem x -> ConfigurationItem

Read ConfigurationItem

Defined in Amazonka.Config.Types.ConfigurationItem

Methods

readsPrec :: Int -> ReadS ConfigurationItem

readList :: ReadS [ConfigurationItem]

readPrec :: ReadPrec ConfigurationItem

readListPrec :: ReadPrec [ConfigurationItem]

Show ConfigurationItem

Defined in Amazonka.Config.Types.ConfigurationItem

Methods

showsPrec :: Int -> ConfigurationItem -> ShowS

show :: ConfigurationItem -> String

showList :: [ConfigurationItem] -> ShowS

NFData ConfigurationItem

Defined in Amazonka.Config.Types.ConfigurationItem

Methods

rnf :: ConfigurationItem -> ()

Eq ConfigurationItem

Defined in Amazonka.Config.Types.ConfigurationItem

Methods

(==) :: ConfigurationItem -> ConfigurationItem -> Bool

(/=) :: ConfigurationItem -> ConfigurationItem -> Bool

Hashable ConfigurationItem

Defined in Amazonka.Config.Types.ConfigurationItem

Methods

hashWithSalt :: Int -> ConfigurationItem -> Int

hash :: ConfigurationItem -> Int

type Rep ConfigurationItem

Defined in Amazonka.Config.Types.ConfigurationItem

type Rep ConfigurationItem = D1 ('MetaData "ConfigurationItem" "Amazonka.Config.Types.ConfigurationItem" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "ConfigurationItem'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "awsRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configurationItemCaptureTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "configurationItemMD5Hash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "configurationItemStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationItemStatus)) :*: S1 ('MetaSel ('Just "configurationStateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "relatedEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "relationships") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Relationship]))) :*: (S1 ('MetaSel ('Just "resourceCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType))) :*: (S1 ('MetaSel ('Just "supplementaryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newConfigurationItem :: ConfigurationItem

Create a value of ConfigurationItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:ConfigurationItem', configurationItem_accountId - The 12-digit Amazon Web Services account ID associated with the resource.

$sel:arn:ConfigurationItem', configurationItem_arn - Amazon Resource Name (ARN) associated with the resource.

$sel:availabilityZone:ConfigurationItem', configurationItem_availabilityZone - The Availability Zone associated with the resource.

$sel:awsRegion:ConfigurationItem', configurationItem_awsRegion - The region where the resource resides.

$sel:configuration:ConfigurationItem', configurationItem_configuration - The description of the resource configuration.

$sel:configurationItemCaptureTime:ConfigurationItem', configurationItem_configurationItemCaptureTime - The time when the configuration recording was initiated.

$sel:configurationItemMD5Hash:ConfigurationItem', configurationItem_configurationItemMD5Hash - 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.

$sel:configurationItemStatus:ConfigurationItem', configurationItem_configurationItemStatus - The configuration item status. The valid values are:

• 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 excludes the recording of resources of this type
• ResourceDeleted – The resource was deleted
• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

The CIs do not incur any cost.

$sel:configurationStateId:ConfigurationItem', configurationItem_configurationStateId - An identifier that indicates the ordering of the configuration items of a resource.

$sel:relatedEvents:ConfigurationItem', configurationItem_relatedEvents - 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.

$sel:relationships:ConfigurationItem', configurationItem_relationships - A list of related Amazon Web Services resources.

$sel:resourceCreationTime:ConfigurationItem', configurationItem_resourceCreationTime - The time stamp when the resource was created.

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

ConfigurationItem, configurationItem_resourceName - The custom name of the resource, if available.

ConfigurationItem, configurationItem_resourceType - The type of Amazon Web Services resource.

$sel:supplementaryConfiguration:ConfigurationItem', configurationItem_supplementaryConfiguration - Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

$sel:tags:ConfigurationItem', configurationItem_tags - A mapping of key value tags associated with the resource.

$sel:version:ConfigurationItem', configurationItem_version - The version number of the resource configuration.

configurationItem_accountId :: Lens' ConfigurationItem (Maybe Text)

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

configurationItem_arn :: Lens' ConfigurationItem (Maybe Text)

Amazon Resource Name (ARN) associated with the resource.

configurationItem_availabilityZone :: Lens' ConfigurationItem (Maybe Text)

The Availability Zone associated with the resource.

configurationItem_awsRegion :: Lens' ConfigurationItem (Maybe Text)

The region where the resource resides.

configurationItem_configuration :: Lens' ConfigurationItem (Maybe Text)

The description of the resource configuration.

configurationItem_configurationItemCaptureTime :: Lens' ConfigurationItem (Maybe UTCTime)

The time when the configuration recording was initiated.

configurationItem_configurationItemMD5Hash :: Lens' ConfigurationItem (Maybe Text)

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.

configurationItem_configurationItemStatus :: Lens' ConfigurationItem (Maybe ConfigurationItemStatus)

The configuration item status. The valid values are:

• 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 excludes the recording of resources of this type
• ResourceDeleted – The resource was deleted
• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

The CIs do not incur any cost.

configurationItem_configurationStateId :: Lens' ConfigurationItem (Maybe Text)

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

configurationItem_relatedEvents :: Lens' ConfigurationItem (Maybe [Text])

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.

configurationItem_relationships :: Lens' ConfigurationItem (Maybe [Relationship])

A list of related Amazon Web Services resources.

configurationItem_resourceCreationTime :: Lens' ConfigurationItem (Maybe UTCTime)

The time stamp when the resource was created.

configurationItem_resourceId :: Lens' ConfigurationItem (Maybe Text)

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

configurationItem_resourceName :: Lens' ConfigurationItem (Maybe Text)

The custom name of the resource, if available.

configurationItem_resourceType :: Lens' ConfigurationItem (Maybe ResourceType)

The type of Amazon Web Services resource.

configurationItem_supplementaryConfiguration :: Lens' ConfigurationItem (Maybe (HashMap Text Text))

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

configurationItem_tags :: Lens' ConfigurationItem (Maybe (HashMap Text Text))

A mapping of key value tags associated with the resource.

configurationItem_version :: Lens' ConfigurationItem (Maybe Text)

The version number of the resource configuration.