ConfigurationRecorder
Records configuration changes to specified resource types. For more information about the configuration recorder, see Managing the Configuration Recorder in the AWS Config Developer Guide.
Contents
- name
-
The name of the configuration recorder. AWS Config automatically assigns the name of "default" when creating the configuration recorder.
You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- recordingGroup
-
Specifies which resource types AWS Config records for configuration changes.
Note
High Number of AWS Config Evaluations
You may notice increased activity in your account during your initial month recording with AWS Config when compared to subsequent months. During the initial bootstrapping process, AWS Config runs evaluations on all the resources in your account that you have selected for AWS Config to record.
If you are running ephemeral workloads, you may see increased activity from AWS 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 AWS Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with AWS Config turned off to avoid increased configuration recording and rule evaluations.
Type: RecordingGroup object
Required: No
- roleARN
-
Amazon Resource Name (ARN) of the IAM role assumed by AWS Config and used by the configuration recorder.
Note
While the API model does not require this field, the server will reject a request without a defined
roleARNfor the configuration recorder.Note
Pre-existing AWS Config role
If you have used an AWS service that uses AWS Config, such as AWS Security Hub or AWS Control Tower, and an AWS Config role has already been created, make sure that the IAM role that you use when setting up AWS Config keeps the same minimum permissions as the already created AWS Config role. You must do this so that the other AWS service continues to run as expected.
For example, if AWS Control Tower has an IAM role that allows AWS Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up AWS Config. Otherwise, it may interfere with how AWS Control Tower operates. For more information about IAM roles for AWS Config, see Identity and Access Management for AWS Config in the AWS Config Developer Guide.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
