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(value=Stable)
public static interface CfnConfigurationRecorder.RecordingGroupProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the types of AWS resource for which AWS Config records configuration changes.

In the recording group, you specify whether all supported types or specific types of resources are recorded.

By default, AWS Config records configuration changes for all supported types of regional resources that AWS 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 AWS Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions.

The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.

If you don't want AWS 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, see Selecting Which Resources AWS Config Records .

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnConfigurationRecorder.RecordingGroupProperty.Builder	builder()
default Object	getAllSupported() Specifies whether AWS Config records configuration changes for every supported type of regional resource.
default Object	getIncludeGlobalResourceTypes() Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
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` ).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllSupported

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

Specifies whether AWS Config records configuration changes for every supported type of regional resource.

If you set this option to true , when AWS 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 .

getIncludeGlobalResourceTypes

@Stability(value=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(value=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 this option to true , 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(value=Stable)
static CfnConfigurationRecorder.RecordingGroupProperty.Builder builder()

Returns:

a CfnConfigurationRecorder.RecordingGroupProperty.Builder of CfnConfigurationRecorder.RecordingGroupProperty