Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
Documentation
data RecordingGroup Source #
Specifies which Amazon Web Services resource types Config records for configuration changes. In the recording group, you specify whether you want to record all supported resource types or only specific types of resources.
By default, Config records the configuration changes for all supported types of regional resources that Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.
You can also have Config record supported types of global resources. Global resources are not tied to a specific region and can be used in all regions. The global resource types that Config supports include IAM users, groups, roles, and customer managed policies.
Global resource types onboarded to Config recording after February 2022 will only be recorded in the service's home region for the commercial partition and Amazon Web Services GovCloud (US) West for the GovCloud partition. You can view the Configuration Items for these new global resource types only in their home region and Amazon Web Services GovCloud (US) West.
Supported global resource types onboarded before February 2022 such as
AWS::IAM::Group
, AWS::IAM::Policy
, AWS::IAM::Role
,
AWS::IAM::User
remain unchanged, and they will continue to deliver
Configuration Items in all supported regions in Config. The change will
only affect new global resource types onboarded after February 2022.
To record global resource types onboarded after February 2022, enable All Supported Resource Types in the home region of the global resource type you want to record.
If you don't want Config to record all resources, you can specify which
types of resources it will record with the resourceTypes
parameter.
For a list of supported resource types, see Supported Resource Types.
For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see Selecting Which Resources Config Records.
See: newRecordingGroup
smart constructor.
RecordingGroup' | |
|
Instances
newRecordingGroup :: RecordingGroup Source #
Create a value of RecordingGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allSupported:RecordingGroup'
, recordingGroup_allSupported
- Specifies whether Config records configuration changes for every
supported type of regional resource.
If you set this option to true
, when Config adds support for a new
type of regional resource, it starts recording resources of that type
automatically.
If you set this option to true
, you cannot enumerate a list of
resourceTypes
.
$sel:includeGlobalResourceTypes:RecordingGroup'
, recordingGroup_includeGlobalResourceTypes
- Specifies whether Config includes all supported types of global
resources (for example, IAM resources) with the resources that it
records.
Before you can set this option to true
, you must set the
allSupported
option to true
.
If you set this option to true
, when Config adds support for a new
type of global resource, it starts recording resources of that type
automatically.
The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.
$sel:resourceTypes:RecordingGroup'
, recordingGroup_resourceTypes
- A comma-separated list that specifies the types of Amazon Web Services
resources for which Config records configuration changes (for example,
AWS::EC2::Instance
or AWS::CloudTrail::Trail
).
To record all configuration changes, you must set the allSupported
option to true
.
If you set this option to false
, 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 __resourceType
Value__ column in
Supported Amazon Web Services resource Types.
recordingGroup_allSupported :: Lens' RecordingGroup (Maybe Bool) Source #
Specifies whether Config records configuration changes for every supported type of regional resource.
If you set this option to true
, when Config adds support for a new
type of regional resource, it starts recording resources of that type
automatically.
If you set this option to true
, you cannot enumerate a list of
resourceTypes
.
recordingGroup_includeGlobalResourceTypes :: Lens' RecordingGroup (Maybe Bool) Source #
Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
Before you can set this option to true
, you must set the
allSupported
option to true
.
If you set this option to true
, when Config adds support for a new
type of global resource, it starts recording resources of that type
automatically.
The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.
recordingGroup_resourceTypes :: Lens' RecordingGroup (Maybe [ResourceType]) Source #
A comma-separated list that specifies the types of Amazon Web Services
resources for which Config records configuration changes (for example,
AWS::EC2::Instance
or AWS::CloudTrail::Trail
).
To record all configuration changes, you must set the allSupported
option to true
.
If you set this option to false
, 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 __resourceType
Value__ column in
Supported Amazon Web Services resource Types.