aws_config_recorder
account_id
Type: STRING
name
Type: STRING
Provider name: name
Description: The name of the configuration recorder. 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.
recording_group
Type: STRUCT
Provider name: recordingGroup
Description: Specifies which resource types Config records for configuration changes. High Number of Config Evaluations You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record. If you are running ephemeral workloads, you may see increased activity from 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 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 Config turned off to avoid increased configuration recording and rule evaluations.
all_supported
Type: BOOLEAN
Provider name: allSupported
Description: Specifies whether Config records configuration changes for all supported regionally recorded resource types. If you set this field to true
, when Config adds support for a new regionally recorded resource type, Config starts recording resources of that type automatically. If you set this field to true
, you cannot enumerate specific resource types to record in the resourceTypes
field of RecordingGroup, or to exclude in the resourceTypes
field of ExclusionByResourceTypes. Region Availability Check Resource Coverage by Region Availability to see if a resource type is supported in the Amazon Web Services Region where you set up Config.
exclusion_by_resource_types
Type: STRUCT
Provider name: exclusionByResourceTypes
Description: An object that specifies how Config excludes resource types from being recorded by the configuration recorder. To use this option, you must set the useOnly
field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES
.
resource_types
Type: UNORDERED_LIST_STRING
Provider name: resourceTypes
Description: A comma-separated list of resource types to exclude from recording by the configuration recorder.
include_global_resource_types
Type: BOOLEAN
Provider name: includeGlobalResourceTypes
Description: A legacy field which only applies to the globally recorded IAM resource types: IAM users, groups, roles, and customer managed policies. If you select this option, these resource types will be recorded in all enabled Config regions where Config was available before February 2022. This list does not include the following Regions:- Asia Pacific (Hyderabad)
- Asia Pacific (Melbourne)
- Europe (Spain)
- Europe (Zurich)
- Israel (Tel Aviv)
- Middle East (UAE)
Aurora global clusters are automatically globally recorded The AWS::RDS::GlobalCluster
resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes
is not set to true
. includeGlobalResourceTypes
is a legacy field which only applies to IAM users, groups, roles, and customer managed policies. If you do not want to record AWS::RDS::GlobalCluster
in all enabled Regions, use one of the following recording strategies:- Record all current and future resource types with exclusions (
EXCLUSION_BY_RESOURCE_TYPES
), or - Record specific resource types (
INCLUSION_BY_RESOURCE_TYPES
).
For more information, see Selecting Which Resources are Recorded in the Config developer guide. Required and optional fields Before you set this field to true
, set the allSupported
field of RecordingGroup to true
. Optionally, you can set the useOnly
field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES
. Overriding fields If you set this field to false
but list globally recorded IAM resource types in the resourceTypes
field of RecordingGroup, Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes
field to false. If you do not want to record configuration changes to the globally recorded IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the resourceTypes
field in addition to setting the includeGlobalResourceTypes
field to false.
recording_strategy
Type: STRUCT
Provider name: recordingStrategy
Description: An object that specifies the recording strategy for the configuration recorder.- If you set the
useOnly
field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES
, Config records configuration changes for all supported regionally recorded resource types. You also must set the allSupported
field of RecordingGroup to true
. When Config adds support for a new regionally recorded resource type, Config automatically starts recording resources of that type. - If you set the
useOnly
field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for only the resource types you specify in the resourceTypes
field of RecordingGroup. - If you set the
useOnly
field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the resourceTypes
field of ExclusionByResourceTypes.
Required and optional fields The recordingStrategy
field is optional when you set the allSupported
field of RecordingGroup to true
. The recordingStrategy
field is optional when you list resource types in the resourceTypes
field of RecordingGroup. The recordingStrategy
field is required if you list resource types to exclude from recording in the resourceTypes
field of ExclusionByResourceTypes. Overriding fields If you choose EXCLUSION_BY_RESOURCE_TYPES
for the recording strategy, the exclusionByResourceTypes
field will override other properties in the request. For example, even if you set includeGlobalResourceTypes
to false, globally recorded IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes
field of exclusionByResourceTypes
. Global resources types and the resource exclusion recording strategy By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES
recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically. In addition, unless specifically listed as exclusions, AWS::RDS::GlobalCluster
will be recorded automatically in all supported Config Regions were the configuration recorder is enabled. IAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled Config Regions where Config was available before February 2022. This list does not include the following Regions:- Asia Pacific (Hyderabad)
- Asia Pacific (Melbourne)
- Europe (Spain)
- Europe (Zurich)
- Israel (Tel Aviv)
- Middle East (UAE)
use_only
Type: STRING
Provider name: useOnly
Description: The recording strategy for the configuration recorder.- If you set this option to
ALL_SUPPORTED_RESOURCE_TYPES
, Config records configuration changes for all supported regionally recorded resource types. You also must set the allSupported
field of RecordingGroup to true
. When Config adds support for a new regionally recorded resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide. - If you set this option to
INCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for only the resource types that you specify in the resourceTypes
field of RecordingGroup. - If you set this option to
EXCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the resourceTypes
field of ExclusionByResourceTypes.
Required and optional fields The recordingStrategy
field is optional when you set the allSupported
field of RecordingGroup to true
. The recordingStrategy
field is optional when you list resource types in the resourceTypes
field of RecordingGroup. The recordingStrategy
field is required if you list resource types to exclude from recording in the resourceTypes
field of ExclusionByResourceTypes. Overriding fields If you choose EXCLUSION_BY_RESOURCE_TYPES
for the recording strategy, the exclusionByResourceTypes
field will override other properties in the request. For example, even if you set includeGlobalResourceTypes
to false, globally recorded IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes
field of exclusionByResourceTypes
. Global resource types and the exclusion recording strategy By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES
recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically. In addition, unless specifically listed as exclusions, AWS::RDS::GlobalCluster
will be recorded automatically in all supported Config Regions were the configuration recorder is enabled. IAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled Config Regions where Config was available before February 2022. This list does not include the following Regions:- Asia Pacific (Hyderabad)
- Asia Pacific (Melbourne)
- Europe (Spain)
- Europe (Zurich)
- Israel (Tel Aviv)
- Middle East (UAE)
resource_types
Type: UNORDERED_LIST_STRING
Provider name: resourceTypes
Description: A comma-separated list that specifies which resource types Config records. Optionally, you can set the useOnly
field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES
. To record all configuration changes, set the allSupported
field of RecordingGroup to true
, and either omit this field or don’t specify any resource types in this field. If you set the allSupported
field to false
and specify values for resourceTypes
, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group. For a list of valid resourceTypes
values, see the Resource Type Value column in Supported Amazon Web Services resource Types in the Config developer guide. Region Availability Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
role_arn
Type: STRING
Provider name: roleARN
Description: Amazon Resource Name (ARN) of the IAM role assumed by Config and used by 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. Pre-existing Config role If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected. For example, if Control Tower has an IAM role that allows 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 Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see Identity and Access Management for Config in the Config Developer Guide.
Type: UNORDERED_LIST_STRING