Package software.amazon.awscdk.services.config

Interface CfnConfigurationRecorder.RecordingGroupProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigurationRecorder.RecordingGroupProperty.Jsii$Proxy

Enclosing class:

CfnConfigurationRecorder

@Stability(Stable)
public static interface CfnConfigurationRecorder.RecordingGroupProperty
extends software.amazon.jsii.JsiiSerializable

Specifies which resource types AWS Config records for configuration changes.

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 globally recorded 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, 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 ).

Aurora global clusters are automatically globally recorded

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 the EXCLUSION_BY_RESOURCE_TYPES or INCLUSION_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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigurationRecorder.RecordingGroupProperty.Builder	A builder for CfnConfigurationRecorder.RecordingGroupProperty
static final class	CfnConfigurationRecorder.RecordingGroupProperty.Jsii$Proxy	An implementation for CfnConfigurationRecorder.RecordingGroupProperty

Method Summary

Modifier and Type	Method	Description
static CfnConfigurationRecorder.RecordingGroupProperty.Builder	builder()
default Object	getAllSupported()	Specifies whether AWS Config records configuration changes for all supported regionally recorded resource types.
default Object	getExclusionByResourceTypes()	An object that specifies how AWS Config excludes resource types from being recorded by the configuration recorder.
default Object	getIncludeGlobalResourceTypes()	A legacy field which only applies to the globally recorded IAM resource types : IAM users, groups, roles, and customer managed policies.
default Object	getRecordingStrategy()	An object that specifies the recording strategy for the configuration recorder.
default List<String>	getResourceTypes()	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

@Stability(Stable)
@Nullable
default Object getAllSupported()

Specifies whether AWS Config records configuration changes for all supported regionally recorded resource types.

If you set this field to true , when AWS Config adds support for a new regionally recorded 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 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 AWS Region where you set up AWS Config .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-allsupported

getExclusionByResourceTypes

@Stability(Stable)
@Nullable
default Object 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 to EXCLUSION_BY_RESOURCE_TYPES .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-exclusionbyresourcetypes

getIncludeGlobalResourceTypes

@Stability(Stable)
@Nullable
default Object getIncludeGlobalResourceTypes()

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 AWS Config regions where AWS 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 AWS 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 AWS Config developer guide . > Required and optional fields

Before you set this field to true , set the allSupported field of AWS::Config::ConfigurationRecorder RecordingGroup to true . Optionally, you can set the useOnly field of AWS::Config::ConfigurationRecorder 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 AWS::Config::ConfigurationRecorder RecordingGroup , AWS 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 globally recorded IAM resource types, make sure to not list them in the resourceTypes field in addition to setting the includeGlobalResourceTypes field to false.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-includeglobalresourcetypes

getRecordingStrategy

@Stability(Stable)
@Nullable
default Object getRecordingStrategy()

An object that specifies the recording strategy for the configuration recorder.

• If you set the useOnly field of AWS::Config::ConfigurationRecorder RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES , AWS Config records configuration changes for all supported regionally recorded resource types. You also must set the allSupported field of AWS::Config::ConfigurationRecorder RecordingGroup to true . When AWS Config adds support for a new regionally recorded resource, AWS Config automatically starts recording resources of that type.
• If you set the useOnly field of AWS::Config::ConfigurationRecorder RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES , AWS Config records configuration changes for only the resource types you specify in the resourceTypes field of AWS::Config::ConfigurationRecorder RecordingGroup .
• If you set the useOnly field of AWS::Config::ConfigurationRecorder RecordingStrategy to EXCLUSION_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 the resourceTypes field of AWS::Config::ConfigurationRecorder ExclusionByResourceTypes .

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of AWS::Config::ConfigurationRecorder RecordingGroup to true .

The recordingStrategy field is optional when you list resource types in the resourceTypes field of AWS::Config::ConfigurationRecorder RecordingGroup .

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of AWS::Config::ConfigurationRecorder 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, global 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 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.

In addition, 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 automatically in all enabled AWS Config Regions where AWS 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)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-recordingstrategy

getResourceTypes

@Stability(Stable)
@Nullable
default List<String> getResourceTypes()

A comma-separated list that specifies which resource types AWS Config records.

Optionally, you can set the useOnly field of AWS::Config::ConfigurationRecorder RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES .

To record all configuration changes, set the allSupported field of AWS::Config::ConfigurationRecorder 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 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.

For a list of valid resourceTypes values, see the Resource Type Value column in Supported AWS resource Types in the AWS Config developer guide .

Region Availability

Before 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-resourcetypes

builder

@Stability(Stable)
static CfnConfigurationRecorder.RecordingGroupProperty.Builder builder()

Returns:

a CfnConfigurationRecorder.RecordingGroupProperty.Builder of CfnConfigurationRecorder.RecordingGroupProperty