Logging Amazon AppConfig API calls using Amazon CloudTrail
Amazon AppConfig is integrated with Amazon CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Services service. CloudTrail captures all API calls for Amazon AppConfig as events. The calls captured include calls from the Amazon AppConfig console and code calls to the Amazon AppConfig API operations. Using the information collected by CloudTrail, you can determine the request that was made to Amazon AppConfig, the IP address from which the request was made, when it was made, and additional details.
Every event or log entry contains information about who generated the request. The identity information helps you determine the following:
-
Whether the request was made with root user or user credentials.
-
Whether the request was made on behalf of an IAM Identity Center user.
-
Whether the request was made with temporary security credentials for a role or federated user.
-
Whether the request was made by another Amazon Web Services service.
CloudTrail is active in your Amazon Web Services account when you create the account and you automatically have access to the CloudTrail Event history. The CloudTrail Event history provides a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management events in an Amazon Web Services Region. For more information, see Working with CloudTrail Event history in the Amazon CloudTrail User Guide. There are no CloudTrail charges for viewing the Event history.
For an ongoing record of events in your Amazon Web Services account past 90 days, create a trail or a CloudTrail Lake event data store.
- CloudTrail trails
-
A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. All trails created using the Amazon Web Services Management Console are multi-Region. You can create a single-Region or a multi-Region trail by using the Amazon CLI. Creating a multi-Region trail is recommended because you capture activity in all Amazon Web Services Regions in your account. If you create a single-Region trail, you can view only the events logged in the trail's Amazon Web Services Region. For more information about trails, see Creating a trail for your Amazon Web Services account and Creating a trail for an organization in the Amazon CloudTrail User Guide.
You can deliver one copy of your ongoing management events to your Amazon S3 bucket at no charge from CloudTrail by creating a trail, however, there are Amazon S3 storage charges. For more information about CloudTrail pricing, see Amazon CloudTrail Pricing
. For information about Amazon S3 pricing, see Amazon S3 Pricing . - CloudTrail Lake event data stores
-
CloudTrail Lake lets you run SQL-based queries on your events. CloudTrail Lake converts existing events in row-based JSON format to Apache ORC
format. ORC is a columnar storage format that is optimized for fast retrieval of data. Events are aggregated into event data stores, which are immutable collections of events based on criteria that you select by applying advanced event selectors. The selectors that you apply to an event data store control which events persist and are available for you to query. For more information about CloudTrail Lake, see Working with Amazon CloudTrail Lake in the Amazon CloudTrail User Guide. CloudTrail Lake event data stores and queries incur costs. When you create an event data store, you choose the pricing option you want to use for the event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum retention period for the event data store. For more information about CloudTrail pricing, see Amazon CloudTrail Pricing
.
Amazon AppConfig data events in CloudTrail
Data events provide information about the resource operations performed on or in a resource (for example, retrieving the latest deployed configuration by calling GetLatestConfiguration). These are also known as data plane operations. Data events are often high-volume activities. By default, CloudTrail doesn’t log data events. The CloudTrail Event history doesn't record data events.
Additional charges apply for data events. For more information about CloudTrail pricing, see
Amazon CloudTrail Pricing
You can log data events for the Amazon AppConfig resource types by using the CloudTrail console, Amazon CLI, or CloudTrail API operations. The table in this section shows the resource types available for Amazon AppConfig.
-
To log data events using the CloudTrail console, create a trail or event data store to log data events, or update an existing trail or event data store to log data events.
-
Choose Data events to log data events.
-
From the Data event type list, choose Amazon AppConfig.
-
Choose the log selector template you want to use. You can log all data events for the resource type, log all
readOnly
events, log allwriteOnly
events, or create a custom log selector template to filter on thereadOnly
,eventName
, andresources.ARN
fields. -
For Selector name, enter AppConfigDataEvents. For information about enabling Amazon CloudWatch Logs for your data event trail, see Logging metrics for Amazon AppConfig data plane calls.
-
-
To log data events using the Amazon CLI, configure the
--advanced-event-selectors
parameter to set theeventCategory
field equal toData
and theresources.type
field equal to the resource type value (see table). You can add conditions to filter on the values of thereadOnly
,eventName
, andresources.ARN
fields.-
To configure a trail to log data events, run the put-event-selectors command. For more information, see Logging data events for trails with the Amazon CLI.
-
To configure an event data store to log data events, run the create-event-data-store command to create a new event data store to log data events, or run the update-event-data-store command to update an existing event data store. For more information, see Logging data events for event data stores with the Amazon CLI.
-
The following table lists the Amazon AppConfig resource types. The Data
event type (console) column shows the value to choose from the Data
event type list on the CloudTrail console. The resources.type
value column shows the resources.type
value, which you would specify
when configuring advanced event selectors using the Amazon CLI or CloudTrail APIs. The Data APIs logged to CloudTrail column shows the API calls logged to CloudTrail
for the resource type.
Data event type (console) | resources.type value | Data APIs logged to CloudTrail* |
---|---|---|
Amazon AppConfig |
AWS::AppConfig::Configuration
|
*You can configure advanced event selectors to filter on the eventName
,
readOnly
, and resources.ARN
fields to log only those events that
are important to you. For more information about these fields, see AdvancedFieldSelector.
Amazon AppConfig management events in CloudTrail
Amazon AppConfig logs all Amazon AppConfig control plane operations as management events. For a list of the Amazon AppConfig control plane operations that Amazon AppConfig logs to CloudTrail, see the Amazon AppConfig API Reference.
Amazon AppConfig event examples
An event represents a single request from any source and includes information about the requested API operation, the date and time of the operation, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so events don't appear in any specific order.
The following example shows a CloudTrail event that demonstrates the StartConfigurationSession operation.
{ "eventVersion": "1.09", "userIdentity": { "type": "IAMUser", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::123456789012:user/Administrator", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": {}, "attributes": { "creationDate": "2024-01-11T14:37:02Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-01-11T14:45:15Z", "eventSource": "appconfig.amazonaws.com", "eventName": "StartConfigurationSession", "awsRegion": "us-east-1", "sourceIPAddress": "203.0.113.0", "userAgent": "Boto3/1.34.11 md/Botocore#1.34.11 ua/2.0 os/macos#22.6.0 md/arch#x86_64 lang/python#3.11.4 md/pyimpl#CPython cfg/retry-mode#legacy Botocore/1.34.11", "requestParameters": { "applicationIdentifier": "rrfexample", "environmentIdentifier": "mexampleqe0", "configurationProfileIdentifier": "3eexampleu1" }, "responseElements": null, "requestID": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE", "eventID": "a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE", "readOnly": false, "resources": [ { "accountId": "123456789012", "type": "AWS::AppConfig::Configuration", "ARN": "arn:aws:appconfig:us-east-1:123456789012:application/rrfexample/environment/mexampleqe0/configuration/3eexampleu1" } ], "eventType": "AwsApiCall", "managementEvent": false, "recipientAccountId": "123456789012", "eventCategory": "Data", "tlsDetails": { "tlsVersion": "TLSv1.3", "cipherSuite": "TLS_AES_128_GCM_SHA256", "clientProvidedHostHeader": "appconfigdata.us-east-1.amazonaws.com" } }
For information about CloudTrail record contents, see CloudTrail record contents in the Amazon CloudTrail User Guide.