Class: Aws::ConfigService::Types::RecordingStrategy

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-configservice/types.rb

Overview

Specifies the recording strategy of the configuration recorder.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#use_onlyString

The recording strategy for the configuration recorder.

  • If you set this option to ‘ALL_SUPPORTED_RESOURCE_TYPES`, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the `allSupported` field of [RecordingGroup] to `true`. When Config adds support for a new 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 the `resourceTypes` 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 the `resourceTypes` field of [ExclusionByResourceTypes].

<note markdown=“1”> **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].

</note>

<note markdown=“1”> **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 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`.

</note>

<note markdown=“1”> **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.

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 in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

* Asia Pacific (Hyderabad)
  • Asia Pacific (Melbourne)

  • Canada West (Calgary)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

</note>

[1]: docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html [2]: docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources [3]: docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html

Returns:

  • (String)


8058
8059
8060
8061
8062
# File 'lib/aws-sdk-configservice/types.rb', line 8058

class RecordingStrategy < Struct.new(
  :use_only)
  SENSITIVE = []
  include Aws::Structure
end