ConfigurationRecorder - Amazon Config
ContentsSee Also
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).

ConfigurationRecorder

Records configuration changes to the resource types in scope.

For more information about the configuration recorder, see Working with the Configuration Recorder in the Amazon Config Developer Guide.

Contents

arn

The Amazon Resource Name (ARN) of the specified configuration recorder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

name

The name of the configuration recorder.

For customer managed configuration recorders, Amazon Config automatically assigns the name of "default" when creating a configuration recorder if you do not specify a name at creation time.

For service-linked configuration recorders, Amazon Config automatically assigns a name that has the prefix "AWS" to a new service-linked configuration recorder.

Note

Changing the name of a configuration recorder

To change the name of the customer managed configuration recorder, you must delete it and create a new customer managed configuration recorder with a new name.

You cannot change the name of a service-linked configuration recorder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

recordingGroup

Specifies which resource types are in scope for the configuration recorder to record.

Note

High Number of Amazon Config Evaluations

You might notice increased activity in your account during your initial month recording with Amazon Config when compared to subsequent months. During the initial bootstrapping process, Amazon Config runs evaluations on all the resources in your account that you have selected for Amazon Config to record.

If you are running ephemeral workloads, you may see increased activity from Amazon Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Amazon Auto Scaling.

If you want to avoid the increased activity from running ephemeral workloads, you can set up the configuration recorder to exclude these resource types from being recorded, or run these types of workloads in a separate account with Amazon Config turned off to avoid increased configuration recording and rule evaluations.

Type: RecordingGroup object

Required: No

recordingMode

Specifies the default recording frequency for the configuration recorder. Amazon Config supports Continuous recording and Daily recording.

  • Continuous recording allows you to record configuration changes continuously whenever a change occurs.

  • Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Note

Some resource types require continuous recording

Amazon Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

Type: RecordingMode object

Required: No

recordingScope

Specifies whether the ConfigurationItems in scope for the specified configuration recorder are recorded for free (INTERNAL) or if it impacts the costs to your bill (PAID).

Type: String

Valid Values: INTERNAL | PAID

Required: No

roleARN

The Amazon Resource Name (ARN) of the IAM role assumed by Amazon Config and used by the specified configuration recorder.

Note

The server will reject a request without a defined roleARN for the configuration recorder

While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.

Policies and compliance results

IAM policies and other policies managed in Amazon Organizations can impact whether Amazon Config has permissions to record configuration changes for your resources. Additionally, rules directly evaluate the configuration of a resource and rules don't take into account these policies when running evaluations. Make sure that the policies in effect align with how you intend to use Amazon Config.

Keep Minimum Permisions When Reusing an IAM role

If you use an Amazon service that uses Amazon Config, such as Amazon Security Hub or Amazon Control Tower, and an IAM role has already been created, make sure that the IAM role that you use when setting up Amazon Config keeps the same minimum permissions as the pre-existing IAM role. You must do this to ensure that the other Amazon service continues to run as expected.

For example, if Amazon Control Tower has an IAM role that allows Amazon Config to read S3 objects, make sure that the same permissions are granted to the IAM role you use when setting up Amazon Config. Otherwise, it may interfere with how Amazon Control Tower operates.

The service-linked IAM role for Amazon Config must be used for service-linked configuration recorders

For service-linked configuration recorders, you must use the service-linked IAM role for Amazon Config: AWSServiceRoleForConfig.

Type: String

Required: No

servicePrincipal

For service-linked configuration recorders, specifies the linked Amazon Web Services service for the configuration recorder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: