Configuration item schema - Amazon CloudTrail
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Configuration item schema

The following table describes the required and optional schema elements that match those in configuration item records. The contents of eventData are provided by your configuration items; other fields are provided by CloudTrail after ingestion.

CloudTrail event record contents are described in more detail in CloudTrail record contents.

Fields that are provided by CloudTrail after ingestion
Field name Input type Requirement Description
eventVersion string Required

The version of the Amazon event format.

eventCategory string Required

The event category. For configuration items, the valid value is ConfigurationItem.

eventType string Required

The event type. For configuration items, the valid value is AwsConfigurationItem.

eventID string Required

A unique ID for an event.

eventTime

string

Required

The event timestamp, in yyyy-MM-DDTHH:mm:ss format, in Universal Coordinated Time (UTC).

awsRegion string Required

The Amazon Web Services Region to which to assign an event.

recipientAccountId string Required

Represents the Amazon Web Services account ID that received this event.

addendum

addendum

Optional

Shows information about why an event was delayed. If information was missing from an existing event, the addendum block includes the missing information and a reason for why it was missing.

Fields in eventData are provided by your configuration items
Field name Input type Requirement Description
eventData

-

Required Fields in eventData are provided by your configuration items.
  • configurationItemVersion

string Optional

The version of the configuration item from its source.

  • configurationItemCaptureTime

string Optional

The time when the configuration recording was initiated.

  • configurationItemStatus

string Optional

The configuration item status. Valid values are OK, ResourceDiscovered, ResourceNotRecorded, ResourceDeleted, and ResourceDeletedNotRecorded.

  • accountId

string Optional

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

  • resourceType

string Optional

The type of Amazon resource. For more information about valid resource types, see ConfigurationItem in the Amazon Config API Reference.

  • resourceId

string Optional

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

  • resourceName

string Optional

The custom name of the resource, if available.

  • arn

string Optional

Amazon Resource Name (ARN) associated with the resource.

  • awsRegion

string

Optional

The Amazon Web Services Region where the resource resides.

  • availabilityZone

string

Optional

The Availability Zone associated with the resource.

  • resourceCreationTime

string

Optional

The time stamp when the resource was created.

  • configuration

JSON

Optional

The description of the resource configuration.

  • supplementaryConfiguration

JSON

Optional

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

  • relatedEvents

string

Optional

A list of CloudTrail event IDs.

  • relationships

- Optional

A list of related Amazon resources.

    • name

string

Optional

The type of relationship with the related resource.

    • resourceType

string

Optional

The resource type of the related resource.

    • resourceId

string

Optional

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

    • resourceName

string

Optional

The custom name of the related resource, if available.

  • tags

JSON

Optional

A mapping of key value tags associated with the resource.

The following example shows the hierarchy of schema elements that match those in configuration item records.

{ "eventVersion": String, "eventCategory: String, "eventType": String, "eventID": String, "eventTime": String, "awsRegion": String, "recipientAccountId": String, "addendum": Addendum, "eventData": { "configurationItemVersion": String, "configurationItemCaptureTime": String, "configurationItemStatus": String, "configurationStateId": String, "accountId": String, "resourceType": String, "resourceId": String, "resourceName": String, "arn": String, "awsRegion": String, "availabilityZone": String, "resourceCreationTime": String, "configuration": { JSON, }, "supplementaryConfiguration": { JSON, }, "relatedEvents": [ String ], "relationships": [ struct{ "name" : String, "resourceType": String, "resourceId": String, "resourceName": String } ], "tags": { JSON } } } }