Interface CfnConfigurationRecorder.RecordingGroupProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConfigurationRecorder.RecordingGroupProperty.Jsii$Proxy
- Enclosing class:
CfnConfigurationRecorder
By default, AWS Config records configuration changes for all current and future supported resource types in the AWS Region where you have enabled AWS Config , excluding the global IAM resource types: IAM users, groups, roles, and customer managed policies.
In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types. For a list of supported resource types, see Supported Resource Types in the AWS Config developer guide .
If you don't want AWS Config to record all current and future supported resource types (excluding the global IAM resource types), 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
).
If you use the recording strategy to Record all current and future resource types ( ALL_SUPPORTED_RESOURCE_TYPES
), you can use the flag IncludeGlobalResourceTypes
to include the global IAM resource types in your recording.
Aurora global clusters are recorded in all enabled Regions
The
AWS::RDS::GlobalCluster
resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled.If you do not want to record
AWS::RDS::GlobalCluster
in all enabled Regions, use theEXCLUSION_BY_RESOURCE_TYPES
orINCLUSION_BY_RESOURCE_TYPES
recording strategy.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.config.*; RecordingGroupProperty recordingGroupProperty = RecordingGroupProperty.builder() .allSupported(false) .exclusionByResourceTypes(ExclusionByResourceTypesProperty.builder() .resourceTypes(List.of("resourceTypes")) .build()) .includeGlobalResourceTypes(false) .recordingStrategy(RecordingStrategyProperty.builder() .useOnly("useOnly") .build()) .resourceTypes(List.of("resourceTypes")) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnConfigurationRecorder.RecordingGroupProperty
static final class
An implementation forCfnConfigurationRecorder.RecordingGroupProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Specifies whether AWS Config records configuration changes for all supported resource types, excluding the global IAM resource types.default Object
An object that specifies how AWS Config excludes resource types from being recorded by the configuration recorder.default Object
This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies.default Object
An object that specifies the recording strategy for the configuration recorder.A comma-separated list that specifies which resource types AWS Config records.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAllSupported
Specifies whether AWS Config records configuration changes for all supported resource types, excluding the global IAM resource types.If you set this field to
true
, when AWS Config adds support for a new resource type, AWS Config starts recording resources of that type automatically.If you set this field to
true
, you cannot enumerate specific resource types to record in theresourceTypes
field of RecordingGroup , or to exclude in theresourceTypes
field of ExclusionByResourceTypes .Region availability
Check Resource Coverage by Region Availability to see if a resource type is supported in the AWS Region where you set up AWS Config .
- See Also:
-
getExclusionByResourceTypes
An object that specifies how AWS Config excludes resource types from being recorded by the configuration recorder.To use this option, you must set the
useOnly
field of AWS::Config::ConfigurationRecorder RecordingStrategy toEXCLUSION_BY_RESOURCE_TYPES
.- See Also:
-
getIncludeGlobalResourceTypes
This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies.These global IAM resource types can only be recorded by AWS Config in Regions where AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:
- Asia Pacific (Hyderabad)
- Asia Pacific (Melbourne)
- Canada West (Calgary)
- Europe (Spain)
- Europe (Zurich)
- Israel (Tel Aviv)
- Middle East (UAE)
Aurora global clusters are recorded in all enabled Regions
The
AWS::RDS::GlobalCluster
resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled, even ifIncludeGlobalResourceTypes
is set tofalse
. TheIncludeGlobalResourceTypes
option is a bundle 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 AWS Config developer guide . > IncludeGlobalResourceTypes and the exclusion recording strategy
The
IncludeGlobalResourceTypes
field has no impact on theEXCLUSION_BY_RESOURCE_TYPES
recording strategy. This means that the global IAM resource types ( IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions forExclusionByResourceTypes
whenIncludeGlobalResourceTypes
is set tofalse
.The
IncludeGlobalResourceTypes
field should only be used to modify theAllSupported
field, as the default for theAllSupported
field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types whenAllSupported
is set totrue
, make sure to setIncludeGlobalResourceTypes
totrue
.To exclude the global IAM resource types for the
EXCLUSION_BY_RESOURCE_TYPES
recording strategy, you need to manually add them to theResourceTypes
field ofExclusionByResourceTypes
. > Required and optional fieldsBefore you set this field to
true
, set theAllSupported
field of RecordingGroup totrue
. Optionally, you can set theuseOnly
field of RecordingStrategy toALL_SUPPORTED_RESOURCE_TYPES
. > Overriding fieldsIf you set this field to
false
but list global IAM resource types in theResourceTypes
field of RecordingGroup , AWS Config will still record configuration changes for those specified resource types regardless of if you set theIncludeGlobalResourceTypes
field to false.If you do not want to record configuration changes to the global 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 theIncludeGlobalResourceTypes
field to false.- See Also:
-
getRecordingStrategy
An object that specifies the recording strategy for the configuration recorder.- If you set the
useOnly
field of RecordingStrategy toALL_SUPPORTED_RESOURCE_TYPES
, AWS Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set theAllSupported
field of RecordingGroup totrue
. When AWS Config adds support for a new resource type, AWS Config automatically starts recording resources of that type. - If you set the
useOnly
field of RecordingStrategy toINCLUSION_BY_RESOURCE_TYPES
, AWS Config records configuration changes for only the resource types you specify in theResourceTypes
field of RecordingGroup . - If you set the
useOnly
field of RecordingStrategy toEXCLUSION_BY_RESOURCE_TYPES
, AWS Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in theResourceTypes
field of ExclusionByResourceTypes .
Required and optional fields
The
recordingStrategy
field is optional when you set theAllSupported
field of RecordingGroup totrue
.The
recordingStrategy
field is optional when you list resource types in theResourceTypes
field of RecordingGroup .The
recordingStrategy
field is required if you list resource types to exclude from recording in theResourceTypes
field of ExclusionByResourceTypes . > Overriding fieldsIf you choose
EXCLUSION_BY_RESOURCE_TYPES
for the recording strategy, theExclusionByResourceTypes
field will override other properties in the request.For example, even if you set
IncludeGlobalResourceTypes
to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in theResourceTypes
field ofExclusionByResourceTypes
. > Global resources types and the resource exclusion recording strategyBy default, if you choose the
EXCLUSION_BY_RESOURCE_TYPES
recording strategy, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, AWS Config starts recording resources of that type automatically.Unless specifically listed as exclusions,
AWS::RDS::GlobalCluster
will be recorded automatically in all supported AWS Config Regions were the configuration recorder is enabled.IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:
- Asia Pacific (Hyderabad)
- Asia Pacific (Melbourne)
- Canada West (Calgary)
- Europe (Spain)
- Europe (Zurich)
- Israel (Tel Aviv)
- Middle East (UAE)
- See Also:
- If you set the
-
getResourceTypes
A comma-separated list that specifies which resource types AWS Config records.For a list of valid
ResourceTypes
values, see the Resource Type Value column in Supported AWS resource Types in the AWS Config developer guide .Required and optional fields
Optionally, you can set the
useOnly
field of RecordingStrategy toINCLUSION_BY_RESOURCE_TYPES
.To record all configuration changes, set the
AllSupported
field of RecordingGroup totrue
, and either omit this field or don't specify any resource types in this field. If you set theAllSupported
field tofalse
and specify values forResourceTypes
, when AWS 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. > Region availabilityBefore specifying a resource type for AWS Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the AWS Region where you set up AWS Config . If a resource type is supported by AWS Config in at least one Region, you can enable the recording of that resource type in all Regions supported by AWS Config , even if the specified resource type is not supported in the AWS Region where you set up AWS Config .
- See Also:
-
builder
-