Menu
AWS OpsWorks
User Guide (API Version 2013-02-18)

Logging AWS OpsWorks for Puppet Enterprise API Calls with AWS CloudTrail

AWS OpsWorks for Puppet Enterprise is integrated with CloudTrail, a service that captures all of the AWS OpsWorks for Puppet Enterprise API calls and delivers the log files to an Amazon S3 bucket that you specify. CloudTrail captures API calls from the AWS OpsWorks for Puppet Enterprise console, or from your code to the AWS OpsWorks for Puppet Enterprise APIs. Using the information collected by CloudTrail, you can determine the request that was made to AWS OpsWorks for Puppet Enterprise, the source IP address from which the request was made, who made the request, when it was made, and so on.

To learn more about CloudTrail, including how to configure and enable it, see the AWS CloudTrail User Guide.

AWS OpsWorks for Puppet Enterprise Information in CloudTrail

When CloudTrail logging is enabled in your AWS account, API calls made to AWS OpsWorks for Puppet Enterprise actions are tracked in CloudTrail log files, where they are written with other AWS service records. CloudTrail determines when to create and write to a new file based on a time period and file size.

All AWS OpsWorks for Puppet Enterprise actions are logged by CloudTrail and are documented in the AWS OpsWorks for Puppet Enterprise API Reference. For example, calls to the CreateServer, CreateBackup, and DescribeServers APIs generate entries in the CloudTrail log files.

Every log entry contains information about who generated the request. The user identity information in the log entry helps you determine the following:

  • Whether the request was made with root or IAM user credentials

  • Whether the request was made with temporary security credentials for a role or federated user

  • Whether the request was made by another AWS service

For more information, see the CloudTrail userIdentity Element.

You can store your log files in your Amazon S3 bucket for as long as you want, but you can also define Amazon S3 lifecycle rules to archive or delete log files automatically. By default, your log files are encrypted with Amazon S3 server-side encryption (SSE).

If you want to be notified about log file delivery, you can configure CloudTrail to publish Amazon SNS notifications when new log files are delivered. For more information, see Configuring Amazon SNS Notifications for CloudTrail.

You can also aggregate AWS OpsWorks for Puppet Enterprise log files from multiple AWS regions and multiple AWS accounts into a single Amazon S3 bucket.

For more information, see Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts.

Understanding AWS OpsWorks for Puppet Enterprise Log File Entries

CloudTrail log files can contain one or more log entries. Each entry lists multiple JSON-formatted events. A log entry represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. Log entries are not an ordered stack trace of the public API calls, so they do not appear in any specific order.

The following example shows a CloudTrail log entry for an AWS OpsWorks for Puppet Enterprise CreateServer action.

Copy
{"eventVersion":"1.05", "userIdentity":{ "type":"AssumedRole", "principalId":"ID number:OpsWorksCMUser", "arn":"arn:aws:sts::831000000000:assumed-role/Admin/OpsWorksCMUser", "accountId":"831000000000","accessKeyId":"ID number", "sessionContext":{ "attributes":{ "mfaAuthenticated":"false", "creationDate":"2017-01-05T22:03:47Z" }, "sessionIssuer":{ "type":"Role", "principalId":"ID number", "arn":"arn:aws:iam::831000000000:role/Admin", "accountId":"831000000000", "userName":"Admin" } } }, "eventTime":"2017-01-05T22:18:23Z", "eventSource":"opsworks-cm.amazonaws.com", "eventName":"CreateServer", "awsRegion":"us-west-2", "sourceIPAddress":"101.25.190.51", "userAgent":"console.amazonaws.com", "requestParameters":{ "serverName":"test-puppet-server", "engineModel":"Single", "engine":"Puppet", "instanceProfileArn":"arn:aws:iam::831000000000:instance-profile/aws-opsworks-cm-ec2-role", "backupRetentionCount":3,"serviceRoleArn":"arn:aws:iam::831000000000:role/service-role/aws-opsworks-cm-service-role", "engineVersion":"12", "preferredMaintenanceWindow":"Fri:21:00", "instanceType":"t2.medium", "subnetIds":["subnet-1e111f11"], "preferredBackupWindow":"Wed:08:00" }, "responseElements":{ "server":{ "endpoint":"test-puppet-server-xxxx8u4390xo6pd9.us-west-2.opsworks-cm.io", "createdAt":"Jan 5, 2017 10:18:22 PM", "serviceRoleArn":"arn:aws:iam::831000000000:role/service-role/aws-opsworks-cm-service-role", "preferredBackupWindow":"Wed:08:00", "status":"CREATING", "subnetIds":["subnet-1e111f11"], "engine":"Puppet", "instanceType":"t2.medium", "serverName":"test-puppet-server", "serverArn":"arn:aws:opsworks-cm:us-west-2:831000000000:server/test-puppet-server/8ezz7f6z-e91f-4z10-89z5-8c6219zzz09f", "engineModel":"Single", "backupRetentionCount":3, "engineAttributes":[ {"name":"PUPPET_ADMIN_PASSWORD","value":"*** Redacted ***"}, {"name":"PUPPET_API_CA_CERT","value":"*** Redacted ***"}, ], "engineVersion":"12.11.1", "instanceProfileArn":"arn:aws:iam::831000000000:instance-profile/aws-opsworks-cm-ec2-role", "preferredMaintenanceWindow":"Fri:21:00" } }, "requestID":"de7z64z9-d394-12ug-8081-7zz0386fbcb6", "eventID":"8z7z18dz-6z90-47bz-87cf-e8346428zzz3", "eventType":"AwsApiCall", "recipientAccountId":"831000000000" }