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.

In the recording group, you specify whether you want to record all supported resource types or to include or exclude specific types of resources.

By default, AWS Config records configuration changes for all supported types of Regional resources that AWS Config discovers in the AWS 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 Amazon EC2 instances and Amazon EBS volumes.

You can also have AWS Config record supported types of globally recorded resources . Globally recorded resource types are not tied to a specific Region and can be used in all Regions. The globally recorded resource types that AWS Config supports are IAM users, groups, roles, and customer managed policies. These resource types are recorded in all enabled AWS Config regions. AWS Config also supports some global resources types for Amazon Elastic Container Registry Public, AWS Global Accelerator , and Amazon Route 53; however, these resource types are not globally recorded in all enabled AWS Config regions.

Global resource types onboarded to AWS Config recording after February 2022 will be recorded only in the service's home Region for the commercial partition and AWS GovCloud (US-West) for the AWS GovCloud (US) partition. You can view the Configuration Items for these new global resource types only in their home Region and AWS GovCloud (US-West).

If you don't want AWS Config to record all resources, you can specify which types of resources AWS Config records with the resourceTypes parameter.

For a list of supported resource types, see Supported Resource Types in the AWS Config developer guide .

For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see Selecting Which Resources AWS Config Records in the AWS Config developer guide .

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)
         .includeGlobalResourceTypes(false)
         .resourceTypes(List.of("resourceTypes"))
         .build();

  • Method Details

    • getAllSupported

      @Stability(Stable) @Nullable default Object getAllSupported()
      Specifies whether AWS Config records configuration changes for all supported regional resource types.

      If you set this field to true , when AWS Config adds support for a new type of regional resource, 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 .

    • getIncludeGlobalResourceTypes

      @Stability(Stable) @Nullable default Object getIncludeGlobalResourceTypes()
      Specifies whether AWS 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 AWS 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 AWS Config in only one region to record global resources.

    • getResourceTypes

      @Stability(Stable) @Nullable default List<String> getResourceTypes()
      A comma-separated list that specifies the types of AWS resources for which AWS 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 false .

      If you set the AllSupported option to false and populate the ResourceTypes option with values, 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 resourceType Value column in Supported AWS Resource Types .

    • builder

      @Stability(Stable) static CfnConfigurationRecorder.RecordingGroupProperty.Builder builder()
      Returns:
      a CfnConfigurationRecorder.RecordingGroupProperty.Builder of CfnConfigurationRecorder.RecordingGroupProperty