public static interface RecordingGroup.Builder extends SdkPojo, CopyableBuilder<RecordingGroup.Builder,RecordingGroup>
| Modifier and Type | Method and Description |
|---|---|
RecordingGroup.Builder |
allSupported(Boolean allSupported)
Specifies whether Config records configuration changes for all supported regionally recorded resource types.
|
default RecordingGroup.Builder |
exclusionByResourceTypes(Consumer<ExclusionByResourceTypes.Builder> exclusionByResourceTypes)
An object that specifies how Config excludes resource types from being recorded by the configuration
recorder.
|
RecordingGroup.Builder |
exclusionByResourceTypes(ExclusionByResourceTypes exclusionByResourceTypes)
An object that specifies how Config excludes resource types from being recorded by the configuration
recorder.
|
RecordingGroup.Builder |
includeGlobalResourceTypes(Boolean includeGlobalResourceTypes)
A legacy field which only applies to the globally recorded IAM resource types: IAM users, groups,
roles, and customer managed policies.
|
default RecordingGroup.Builder |
recordingStrategy(Consumer<RecordingStrategy.Builder> recordingStrategy)
An object that specifies the recording strategy for the configuration recorder.
|
RecordingGroup.Builder |
recordingStrategy(RecordingStrategy recordingStrategy)
An object that specifies the recording strategy for the configuration recorder.
|
RecordingGroup.Builder |
resourceTypes(Collection<ResourceType> resourceTypes)
A comma-separated list that specifies which resource types Config records.
|
RecordingGroup.Builder |
resourceTypes(ResourceType... resourceTypes)
A comma-separated list that specifies which resource types Config records.
|
RecordingGroup.Builder |
resourceTypesWithStrings(Collection<String> resourceTypes)
A comma-separated list that specifies which resource types Config records.
|
RecordingGroup.Builder |
resourceTypesWithStrings(String... resourceTypes)
A comma-separated list that specifies which resource types Config records.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildRecordingGroup.Builder allSupported(Boolean allSupported)
Specifies whether Config records configuration changes for all supported regionally recorded resource types.
If you set this field to true, when Config adds support for a new regionally recorded resource
type, 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 Amazon Web Services Region where you set up Config.
allSupported - Specifies whether Config records configuration changes for all supported regionally recorded resource
types.
If you set this field to true, when Config adds support for a new regionally recorded
resource type, 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 Amazon Web Services Region where you set up Config.
RecordingGroup.Builder includeGlobalResourceTypes(Boolean includeGlobalResourceTypes)
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 Config regions where 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 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 Config developer guide.
Required and optional fields
Before you set this field to true, set the allSupported field of RecordingGroup to
true. Optionally, you can set the useOnly field of 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 RecordingGroup,
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 the globally recorded 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 the includeGlobalResourceTypes field to false.
includeGlobalResourceTypes - 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 Config regions where 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 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 Config developer guide.
Required and optional fields
Before you set this field to true, set the allSupported field of RecordingGroup to true. Optionally, you can set the useOnly field of
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 RecordingGroup, 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 the globally recorded 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 the includeGlobalResourceTypes
field to false.
RecordingGroup.Builder resourceTypesWithStrings(Collection<String> resourceTypes)
A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of 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 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 Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
resourceTypes - A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of 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 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 Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
RecordingGroup.Builder resourceTypesWithStrings(String... resourceTypes)
A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of 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 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 Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
resourceTypes - A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of 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 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 Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
RecordingGroup.Builder resourceTypes(Collection<ResourceType> resourceTypes)
A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of 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 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 Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
resourceTypes - A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of 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 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 Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
RecordingGroup.Builder resourceTypes(ResourceType... resourceTypes)
A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of 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 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 Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
resourceTypes - A comma-separated list that specifies which resource types Config records.
Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.
To record all configuration changes, set the allSupported field of 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 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 Amazon Web Services resource Types in the Config developer guide.
Region Availability
Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.
RecordingGroup.Builder exclusionByResourceTypes(ExclusionByResourceTypes exclusionByResourceTypes)
An object that specifies how Config excludes resource types from being recorded by the configuration recorder.
To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.
exclusionByResourceTypes - An object that specifies how Config excludes resource types from being recorded by the configuration
recorder.
To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.
default RecordingGroup.Builder exclusionByResourceTypes(Consumer<ExclusionByResourceTypes.Builder> exclusionByResourceTypes)
An object that specifies how Config excludes resource types from being recorded by the configuration recorder.
To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.
ExclusionByResourceTypes.Builder
avoiding the need to create one manually via ExclusionByResourceTypes.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to exclusionByResourceTypes(ExclusionByResourceTypes).
exclusionByResourceTypes - a consumer that will call methods on ExclusionByResourceTypes.BuilderexclusionByResourceTypes(ExclusionByResourceTypes)RecordingGroup.Builder recordingStrategy(RecordingStrategy recordingStrategy)
An object that specifies the recording strategy for the configuration recorder.
If you set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for
all supported regionally recorded resource types. You also must set the allSupported field of RecordingGroup to
true. When Config adds support for a new regionally recorded resource type, Config automatically
starts recording resources of that type.
If you set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for
only the resource types you specify in the resourceTypes field of RecordingGroup.
If you set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES, 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 ExclusionByResourceTypes.
Required and optional fields
The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to
true.
The recordingStrategy field is optional when you list resource types in the
resourceTypes field of RecordingGroup.
The recordingStrategy field is required if you list resource types to exclude from recording in
the resourceTypes field of 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, globally recorded IAM 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 resources types and the resource exclusion recording strategy
By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds
support for a new resource type in the Region where you set up the configuration recorder, including global
resource types, 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 Config Regions were the configuration recorder is enabled. IAM users, groups,
roles, and customer managed policies will be recorded automatically in all enabled Config Regions where
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)
recordingStrategy - An object that specifies the recording strategy for the configuration recorder.
If you set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration
changes for all supported regionally recorded resource types. You also must set the
allSupported field of RecordingGroup to true. When Config adds support for a new regionally recorded
resource type, Config automatically starts recording resources of that type.
If you set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES, Config records configuration
changes for only the resource types you specify in the resourceTypes field of RecordingGroup.
If you set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES, 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 ExclusionByResourceTypes.
Required and optional fields
The recordingStrategy field is optional when you set the allSupported field
of RecordingGroup
to true.
The recordingStrategy field is optional when you list resource types in the
resourceTypes field of RecordingGroup.
The recordingStrategy field is required if you list resource types to exclude from
recording in the resourceTypes field of 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, globally recorded IAM
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 resources types and the resource exclusion recording strategy
By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config
adds support for a new resource type in the Region where you set up the configuration recorder,
including global resource types, 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 Config Regions were the configuration recorder is enabled. IAM
users, groups, roles, and customer managed policies will be recorded automatically in all enabled
Config Regions where 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)
default RecordingGroup.Builder recordingStrategy(Consumer<RecordingStrategy.Builder> recordingStrategy)
An object that specifies the recording strategy for the configuration recorder.
If you set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for
all supported regionally recorded resource types. You also must set the allSupported field of RecordingGroup to
true. When Config adds support for a new regionally recorded resource type, Config automatically
starts recording resources of that type.
If you set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for
only the resource types you specify in the resourceTypes field of RecordingGroup.
If you set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES, 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 ExclusionByResourceTypes.
Required and optional fields
The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to
true.
The recordingStrategy field is optional when you list resource types in the
resourceTypes field of RecordingGroup.
The recordingStrategy field is required if you list resource types to exclude from recording in
the resourceTypes field of 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, globally recorded IAM 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 resources types and the resource exclusion recording strategy
By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds
support for a new resource type in the Region where you set up the configuration recorder, including global
resource types, 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 Config Regions were the configuration recorder is enabled. IAM users, groups,
roles, and customer managed policies will be recorded automatically in all enabled Config Regions where
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)
RecordingStrategy.Builder
avoiding the need to create one manually via RecordingStrategy.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to recordingStrategy(RecordingStrategy).
recordingStrategy - a consumer that will call methods on RecordingStrategy.BuilderrecordingStrategy(RecordingStrategy)Copyright © 2023. All rights reserved.