Interface RecordingStrategy.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RecordingStrategy.Builder,
,RecordingStrategy> SdkBuilder<RecordingStrategy.Builder,
,RecordingStrategy> SdkPojo
- Enclosing class:
RecordingStrategy
-
Method Summary
Modifier and TypeMethodDescriptionThe recording strategy for the configuration recorder.useOnly
(RecordingStrategyType useOnly) The recording strategy for the configuration recorder.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
useOnly
The recording strategy for the configuration recorder.
-
If you set this option to
ALL_SUPPORTED_RESOURCE_TYPES
, Config records configuration changes for all supported regionally recorded resource types. You also must set theallSupported
field of RecordingGroup totrue
. When Config adds support for a new regionally recorded resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide. -
If you set this option to
INCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for only the resource types that you specify in theresourceTypes
field of RecordingGroup. -
If you set this option 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 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 fields
If 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, globally recorded 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 resource types and the 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)
- Parameters:
useOnly
- The recording strategy for the configuration recorder.-
If you set this option to
ALL_SUPPORTED_RESOURCE_TYPES
, Config records configuration changes for all supported regionally recorded resource types. You also must set theallSupported
field of RecordingGroup totrue
. When Config adds support for a new regionally recorded resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide. -
If you set this option to
INCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for only the resource types that you specify in theresourceTypes
field of RecordingGroup. -
If you set this option 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 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 fields
If 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, globally recorded 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 resource types and the 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)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
useOnly
The recording strategy for the configuration recorder.
-
If you set this option to
ALL_SUPPORTED_RESOURCE_TYPES
, Config records configuration changes for all supported regionally recorded resource types. You also must set theallSupported
field of RecordingGroup totrue
. When Config adds support for a new regionally recorded resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide. -
If you set this option to
INCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for only the resource types that you specify in theresourceTypes
field of RecordingGroup. -
If you set this option 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 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 fields
If 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, globally recorded 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 resource types and the 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)
- Parameters:
useOnly
- The recording strategy for the configuration recorder.-
If you set this option to
ALL_SUPPORTED_RESOURCE_TYPES
, Config records configuration changes for all supported regionally recorded resource types. You also must set theallSupported
field of RecordingGroup totrue
. When Config adds support for a new regionally recorded resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide. -
If you set this option to
INCLUSION_BY_RESOURCE_TYPES
, Config records configuration changes for only the resource types that you specify in theresourceTypes
field of RecordingGroup. -
If you set this option 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 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 fields
If 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, globally recorded 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 resource types and the 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)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-