CfnConfigurationRecorderPropsMixin

class aws_cdk.mixins_preview.aws_config.mixins.CfnConfigurationRecorderPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Config::ConfigurationRecorder resource type describes the AWS resource types that AWS Config records for configuration changes.

The configuration recorder stores the configuration changes of the specified resources in your account as configuration items. .. epigraph:

To enable AWS Config , you must create a configuration recorder and a delivery channel.

AWS Config uses the delivery channel to deliver the configuration changes to your Amazon S3 bucket or Amazon  topic. For more information, see `AWS::Config::DeliveryChannel <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html>`_ .

AWS CloudFormation starts the recorder as soon as the delivery channel is available.

To stop the recorder and delete it, delete the configuration recorder from your stack. To stop the recorder without deleting it, call the StopConfigurationRecorder action of the AWS Config API directly.

For more information, see Configuration Recorder in the AWS Config Developer Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html
CloudformationResource:: AWS::Config::ConfigurationRecorder
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

cfn_configuration_recorder_props_mixin = config_mixins.CfnConfigurationRecorderPropsMixin(config_mixins.CfnConfigurationRecorderMixinProps(
    name="name",
    recording_group=config_mixins.CfnConfigurationRecorderPropsMixin.RecordingGroupProperty(
        all_supported=False,
        exclusion_by_resource_types=config_mixins.CfnConfigurationRecorderPropsMixin.ExclusionByResourceTypesProperty(
            resource_types=["resourceTypes"]
        ),
        include_global_resource_types=False,
        recording_strategy=config_mixins.CfnConfigurationRecorderPropsMixin.RecordingStrategyProperty(
            use_only="useOnly"
        ),
        resource_types=["resourceTypes"]
    ),
    recording_mode=config_mixins.CfnConfigurationRecorderPropsMixin.RecordingModeProperty(
        recording_frequency="recordingFrequency",
        recording_mode_overrides=[config_mixins.CfnConfigurationRecorderPropsMixin.RecordingModeOverrideProperty(
            description="description",
            recording_frequency="recordingFrequency",
            resource_types=["resourceTypes"]
        )]
    ),
    role_arn="roleArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Config::ConfigurationRecorder.

Parameters:

props (Union[CfnConfigurationRecorderMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['name', 'recordingGroup', 'recordingMode', 'roleArn']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ExclusionByResourceTypesProperty

class CfnConfigurationRecorderPropsMixin.ExclusionByResourceTypesProperty(*, resource_types=None)

Bases: object

Specifies whether the configuration recorder excludes certain resource types from being recorded.

Use the ResourceTypes field to enter a comma-separated list of resource types you want to exclude from recording.

By default, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, AWS Config starts recording resources of that type automatically. .. epigraph:

*How to use the exclusion recording strategy*

To use this option, you must set the ``useOnly`` field of `RecordingStrategy <https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html>`_ to ``EXCLUSION_BY_RESOURCE_TYPES`` .

AWS Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.

*Global resource types and the exclusion recording strategy*

Unless specifically listed as exclusions, ``AWS::RDS::GlobalCluster`` will be recorded automatically in all supported AWS 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 AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS 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)

Parameters:: resource_types (Optional[Sequence[str]]) – A comma-separated list of resource types to exclude from recording by the configuration recorder.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

exclusion_by_resource_types_property = config_mixins.CfnConfigurationRecorderPropsMixin.ExclusionByResourceTypesProperty(
    resource_types=["resourceTypes"]
)

Attributes

resource_types

A comma-separated list of resource types to exclude from recording by the configuration recorder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html#cfn-config-configurationrecorder-exclusionbyresourcetypes-resourcetypes

RecordingGroupProperty

class CfnConfigurationRecorderPropsMixin.RecordingGroupProperty(*, all_supported=None, exclusion_by_resource_types=None, include_global_resource_types=None, recording_strategy=None, resource_types=None)

Bases: object

Specifies which resource types AWS Config records for configuration changes.

By default, AWS Config records configuration changes for all current and future supported resource types in the AWS Region where you have enabled AWS Config , excluding the global IAM resource types: IAM users, groups, roles, and customer managed policies.

In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types. For a list of supported resource types, see Supported Resource Types in the AWS Config developer guide .

If you don’t want AWS Config to record all current and future supported resource types (excluding the global IAM resource types), 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 ).

If you use the recording strategy to Record all current and future resource types ( ALL_SUPPORTED_RESOURCE_TYPES ), you can use the flag IncludeGlobalResourceTypes to include the global IAM resource types in your recording. .. epigraph:

*Aurora global clusters are recorded in all enabled Regions*

The ``AWS::RDS::GlobalCluster`` resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled.

If you do not want to record ``AWS::RDS::GlobalCluster`` in all enabled Regions, use the ``EXCLUSION_BY_RESOURCE_TYPES`` or ``INCLUSION_BY_RESOURCE_TYPES`` recording strategy.

Parameters:

all_supported (Union[bool, IResolvable, None]) – Specifies whether AWS Config records configuration changes for all supported resource types, excluding the global IAM resource types. If you set this field to true , when AWS Config adds support for a new resource type, 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 . .. epigraph:: Region availability Check Resource Coverage by Region Availability to see if a resource type is supported in the AWS Region where you set up AWS Config .
exclusion_by_resource_types (Union[IResolvable, ExclusionByResourceTypesProperty, Dict[str, Any], None]) – An object that specifies how AWS Config excludes resource types from being recorded by the configuration recorder. To use this option, you must set the useOnly field of AWS::Config::ConfigurationRecorder RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES .
include_global_resource_types (Union[bool, IResolvable, None]) –
This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by AWS Config in Regions where AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS 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) .. epigraph:: Aurora global clusters are recorded in all enabled Regions The AWS::RDS::GlobalCluster resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled, even if IncludeGlobalResourceTypes is set to false . The IncludeGlobalResourceTypes option is a bundle 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 AWS Config developer guide . > IncludeGlobalResourceTypes and the exclusion recording strategy The IncludeGlobalResourceTypes field has no impact on the EXCLUSION_BY_RESOURCE_TYPES recording strategy. This means that the global IAM resource types ( IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions for ExclusionByResourceTypes when IncludeGlobalResourceTypes is set to false . The IncludeGlobalResourceTypes field should only be used to modify the AllSupported field, as the default for the AllSupported field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types when AllSupported is set to true , make sure to set IncludeGlobalResourceTypes to true . To exclude the global IAM resource types for the EXCLUSION_BY_RESOURCE_TYPES recording strategy, you need to manually add them to the ResourceTypes field of ExclusionByResourceTypes . > 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 global IAM resource types in the ResourceTypes field of RecordingGroup , AWS 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 global 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.
recording_strategy (Union[IResolvable, RecordingStrategyProperty, Dict[str, Any], None]) –
An object that specifies the recording strategy for the configuration recorder. - If you set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES , AWS 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 AWS Config adds support for a new resource type, AWS Config automatically starts recording resources of that type. - If you set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES , AWS 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 , AWS 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 . .. epigraph:: 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, 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 . > Global resources types and the resource exclusion recording strategy By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, AWS Config starts recording resources of that type automatically. Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported AWS 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 AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS 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)
resource_types (Optional[Sequence[str]]) –
A comma-separated list that specifies which resource types AWS Config records. For a list of valid ResourceTypes values, see the Resource Type Value column in Supported AWS resource Types in the AWS Config developer guide . .. epigraph:: Required and optional fields 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 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. > Region availability Before specifying a resource type for AWS Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the AWS Region where you set up AWS Config . If a resource type is supported by AWS Config in at least one Region, you can enable the recording of that resource type in all Regions supported by AWS Config , even if the specified resource type is not supported in the AWS Region where you set up AWS Config .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

recording_group_property = config_mixins.CfnConfigurationRecorderPropsMixin.RecordingGroupProperty(
    all_supported=False,
    exclusion_by_resource_types=config_mixins.CfnConfigurationRecorderPropsMixin.ExclusionByResourceTypesProperty(
        resource_types=["resourceTypes"]
    ),
    include_global_resource_types=False,
    recording_strategy=config_mixins.CfnConfigurationRecorderPropsMixin.RecordingStrategyProperty(
        use_only="useOnly"
    ),
    resource_types=["resourceTypes"]
)

Attributes

all_supported

Specifies whether AWS Config records configuration changes for all supported resource types, excluding the global IAM resource types.

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

*Region availability*

Check `Resource Coverage by Region Availability <https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html>`_ to see if a resource type is supported in the AWS Region where you set up AWS Config .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-allsupported

exclusion_by_resource_types

An object that specifies how AWS Config excludes resource types from being recorded by the configuration recorder.

To use this option, you must set the useOnly field of AWS::Config::ConfigurationRecorder RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-exclusionbyresourcetypes

include_global_resource_types

IAM users, groups, roles, and customer managed policies.

These global IAM resource types can only be recorded by AWS Config in Regions where AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS 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)

Aurora global clusters are recorded in all enabled Regions

The AWS::RDS::GlobalCluster resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled, even if IncludeGlobalResourceTypes is set to false . The IncludeGlobalResourceTypes option is a bundle 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 AWS Config developer guide . > IncludeGlobalResourceTypes and the exclusion recording strategy

The IncludeGlobalResourceTypes field has no impact on the EXCLUSION_BY_RESOURCE_TYPES recording strategy. This means that the global IAM resource types ( IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions for ExclusionByResourceTypes when IncludeGlobalResourceTypes is set to false .

The IncludeGlobalResourceTypes field should only be used to modify the AllSupported field, as the default for the AllSupported field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types when AllSupported is set to true , make sure to set IncludeGlobalResourceTypes to true .

To exclude the global IAM resource types for the EXCLUSION_BY_RESOURCE_TYPES recording strategy, you need to manually add them to the ResourceTypes field of ExclusionByResourceTypes . > 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 global IAM resource types in the ResourceTypes field of RecordingGroup , AWS 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 global 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-includeglobalresourcetypes
Type:: This option is a bundle which only applies to the global IAM resource types

recording_strategy

An object that specifies the recording strategy for the configuration recorder.

If you set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES , AWS 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 AWS Config adds support for a new resource type, AWS Config automatically starts recording resources of that type.
If you set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES , AWS 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 , AWS 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, 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 . > Global resources types and the resource exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, AWS Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported AWS 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 AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS 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)

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-recordingstrategy

resource_types

A comma-separated list that specifies which resource types AWS Config records.

For a list of valid ResourceTypes values, see the Resource Type Value column in Supported AWS resource Types in the AWS Config developer guide . .. epigraph:

*Required and optional fields*

Optionally, you can set the ``useOnly`` field of `RecordingStrategy <https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html>`_ to ``INCLUSION_BY_RESOURCE_TYPES`` .

To record all configuration changes, set the ``AllSupported`` field of `RecordingGroup <https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html>`_ 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 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. > *Region availability*

Before specifying a resource type for AWS Config to track, check `Resource Coverage by Region Availability <https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html>`_ to see if the resource type is supported in the AWS Region where you set up AWS Config . If a resource type is supported by AWS Config in at least one Region, you can enable the recording of that resource type in all Regions supported by AWS Config , even if the specified resource type is not supported in the AWS Region where you set up AWS Config .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-resourcetypes

RecordingModeOverrideProperty

class CfnConfigurationRecorderPropsMixin.RecordingModeOverrideProperty(*, description=None, recording_frequency=None, resource_types=None)

Bases: object

An object for you to specify your overrides for the recording mode.

Parameters:

description (Optional[str]) – A description that you provide for the override.
recording_frequency (Optional[str]) – The recording frequency that will be applied to all the resource types specified in the override. - Continuous recording allows you to record configuration changes continuously whenever a change occurs. - Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. .. epigraph:: AWS Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.
resource_types (Optional[Sequence[str]]) – A comma-separated list that specifies which resource types AWS Config includes in the override. .. epigraph:: Daily recording cannot be specified for the following resource types: - AWS::Config::ResourceCompliance - AWS::Config::ConformancePackCompliance - AWS::Config::ConfigurationRecorder

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmodeoverride.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

recording_mode_override_property = config_mixins.CfnConfigurationRecorderPropsMixin.RecordingModeOverrideProperty(
    description="description",
    recording_frequency="recordingFrequency",
    resource_types=["resourceTypes"]
)

Attributes

description

A description that you provide for the override.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmodeoverride.html#cfn-config-configurationrecorder-recordingmodeoverride-description

recording_frequency

The recording frequency that will be applied to all the resource types specified in the override.

Continuous recording allows you to record configuration changes continuously whenever a change occurs.
Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

AWS Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmodeoverride.html#cfn-config-configurationrecorder-recordingmodeoverride-recordingfrequency

resource_types

A comma-separated list that specifies which resource types AWS Config includes in the override.

Daily recording cannot be specified for the following resource types:

AWS::Config::ResourceCompliance

AWS::Config::ConformancePackCompliance

AWS::Config::ConfigurationRecorder

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmodeoverride.html#cfn-config-configurationrecorder-recordingmodeoverride-resourcetypes

RecordingModeProperty

class CfnConfigurationRecorderPropsMixin.RecordingModeProperty(*, recording_frequency=None, recording_mode_overrides=None)

Bases: object

Specifies the default recording frequency that AWS Config uses to record configuration changes.

AWS Config supports Continuous recording and Daily recording .

Continuous recording allows you to record configuration changes continuously whenever a change occurs.
Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

AWS Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

Parameters:

recording_frequency (Optional[str]) – The default recording frequency that AWS Config uses to record configuration changes. .. epigraph:: Daily recording cannot be specified for the following resource types: - AWS::Config::ResourceCompliance - AWS::Config::ConformancePackCompliance - AWS::Config::ConfigurationRecorder For the allSupported ( ALL_SUPPORTED_RESOURCE_TYPES ) recording strategy, these resource types will be set to Continuous recording.
recording_mode_overrides (Union[IResolvable, Sequence[Union[IResolvable, RecordingModeOverrideProperty, Dict[str, Any]]], None]) – An array of recordingModeOverride objects for you to specify your overrides for the recording mode. The recordingModeOverride object in the recordingModeOverrides array consists of three fields: a description , the new recordingFrequency , and an array of resourceTypes to override.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmode.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

recording_mode_property = config_mixins.CfnConfigurationRecorderPropsMixin.RecordingModeProperty(
    recording_frequency="recordingFrequency",
    recording_mode_overrides=[config_mixins.CfnConfigurationRecorderPropsMixin.RecordingModeOverrideProperty(
        description="description",
        recording_frequency="recordingFrequency",
        resource_types=["resourceTypes"]
    )]
)

Attributes

recording_frequency

The default recording frequency that AWS Config uses to record configuration changes.

Daily recording cannot be specified for the following resource types:

AWS::Config::ResourceCompliance

AWS::Config::ConformancePackCompliance

AWS::Config::ConfigurationRecorder

For the allSupported ( ALL_SUPPORTED_RESOURCE_TYPES ) recording strategy, these resource types will be set to Continuous recording.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmode.html#cfn-config-configurationrecorder-recordingmode-recordingfrequency

recording_mode_overrides

An array of recordingModeOverride objects for you to specify your overrides for the recording mode.

The recordingModeOverride object in the recordingModeOverrides array consists of three fields: a description , the new recordingFrequency , and an array of resourceTypes to override.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingmode.html#cfn-config-configurationrecorder-recordingmode-recordingmodeoverrides

RecordingStrategyProperty

class CfnConfigurationRecorderPropsMixin.RecordingStrategyProperty(*, use_only=None)

Bases: object

Specifies the recording strategy of the configuration recorder.

Valid values include: ALL_SUPPORTED_RESOURCE_TYPES , INCLUSION_BY_RESOURCE_TYPES , and EXCLUSION_BY_RESOURCE_TYPES .

Parameters:

use_only (Optional[str]) –

The recording strategy for the configuration recorder. - If you set this option to ALL_SUPPORTED_RESOURCE_TYPES , AWS 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 AWS Config adds support for a new resource type, AWS Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the AWS Config developer guide . - If you set this option to INCLUSION_BY_RESOURCE_TYPES , AWS 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 , AWS 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 . .. epigraph:: 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, 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 . > Global resource types and the exclusion recording strategy By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, AWS Config starts recording resources of that type automatically. Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported AWS 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 AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS 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)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

recording_strategy_property = config_mixins.CfnConfigurationRecorderPropsMixin.RecordingStrategyProperty(
    use_only="useOnly"
)

Attributes

use_only

The recording strategy for the configuration recorder.

If you set this option to ALL_SUPPORTED_RESOURCE_TYPES , AWS 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 AWS Config adds support for a new resource type, AWS Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the AWS Config developer guide .
If you set this option to INCLUSION_BY_RESOURCE_TYPES , AWS 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 , AWS 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, 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 . > Global resource types and the exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when AWS Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, AWS Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported AWS 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 AWS Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by AWS 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)

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html#cfn-config-configurationrecorder-recordingstrategy-useonly