aws-cdk-lib 2.96.2__py3-none-any.whl → 2.97.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +246 -62
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.96.2.jsii.tgz → aws-cdk-lib@2.97.1.jsii.tgz} +0 -0
- aws_cdk/aws_apigatewayv2/__init__.py +1 -1
- aws_cdk/aws_appflow/__init__.py +205 -7
- aws_cdk/aws_appstream/__init__.py +33 -28
- aws_cdk/aws_appsync/__init__.py +555 -71
- aws_cdk/aws_autoscaling/__init__.py +5 -11
- aws_cdk/aws_billingconductor/__init__.py +145 -1
- aws_cdk/aws_cleanrooms/__init__.py +1198 -86
- aws_cdk/aws_cloudformation/__init__.py +221 -55
- aws_cdk/aws_cloudwatch/__init__.py +325 -2
- aws_cdk/aws_cognito/__init__.py +9 -13
- aws_cdk/aws_config/__init__.py +68 -73
- aws_cdk/aws_connect/__init__.py +909 -164
- aws_cdk/aws_customerprofiles/__init__.py +44 -0
- aws_cdk/aws_dms/__init__.py +198 -0
- aws_cdk/aws_ec2/__init__.py +593 -73
- aws_cdk/aws_ecr/__init__.py +7 -2
- aws_cdk/aws_ecs/__init__.py +2 -2
- aws_cdk/aws_efs/__init__.py +237 -0
- aws_cdk/aws_emr/__init__.py +232 -0
- aws_cdk/aws_entityresolution/__init__.py +1702 -0
- aws_cdk/aws_events/__init__.py +13 -18
- aws_cdk/aws_fms/__init__.py +3 -3
- aws_cdk/aws_gamelift/__init__.py +10 -15
- aws_cdk/aws_grafana/__init__.py +9 -5
- aws_cdk/aws_guardduty/__init__.py +272 -205
- aws_cdk/aws_iam/__init__.py +20 -18
- aws_cdk/aws_iotwireless/__init__.py +38 -54
- aws_cdk/aws_lakeformation/__init__.py +18 -6
- aws_cdk/aws_lambda/__init__.py +1 -1
- aws_cdk/aws_lightsail/__init__.py +225 -0
- aws_cdk/aws_lookoutequipment/__init__.py +4 -4
- aws_cdk/aws_macie/__init__.py +5 -3
- aws_cdk/aws_mediapackagev2/__init__.py +3227 -0
- aws_cdk/aws_pcaconnectorad/__init__.py +6785 -0
- aws_cdk/aws_quicksight/__init__.py +189 -116
- aws_cdk/aws_rds/__init__.py +316 -9
- aws_cdk/aws_resiliencehub/__init__.py +38 -21
- aws_cdk/aws_route53resolver/__init__.py +429 -0
- aws_cdk/aws_sagemaker/__init__.py +34 -34
- aws_cdk/aws_stepfunctions/__init__.py +111 -14
- aws_cdk/aws_transfer/__init__.py +2 -2
- aws_cdk/aws_vpclattice/__init__.py +128 -120
- aws_cdk/aws_workspacesweb/__init__.py +3790 -0
- aws_cdk/region_info/__init__.py +49 -0
- {aws_cdk_lib-2.96.2.dist-info → aws_cdk_lib-2.97.1.dist-info}/METADATA +2 -2
- {aws_cdk_lib-2.96.2.dist-info → aws_cdk_lib-2.97.1.dist-info}/RECORD +53 -49
- {aws_cdk_lib-2.96.2.dist-info → aws_cdk_lib-2.97.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.96.2.dist-info → aws_cdk_lib-2.97.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.96.2.dist-info → aws_cdk_lib-2.97.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.96.2.dist-info → aws_cdk_lib-2.97.1.dist-info}/top_level.txt +0 -0
aws_cdk/aws_cognito/__init__.py
CHANGED
|
@@ -10600,7 +10600,7 @@ class CfnUserPoolUser(
|
|
|
10600
10600
|
:param force_alias_creation: This parameter is used only if the ``phone_number_verified`` or ``email_verified`` attribute is set to ``True`` . Otherwise, it is ignored. If this parameter is set to ``True`` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. If this parameter is set to ``False`` , the API throws an ``AliasExistsException`` error if the alias already exists. The default value is ``False`` .
|
|
10601
10601
|
:param message_action: Set to ``RESEND`` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to ``SUPPRESS`` to suppress sending the message. You can specify only one value.
|
|
10602
10602
|
:param user_attributes: The user attributes and attribute values to be set for the user to be created. These are name-value pairs You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (in ` <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ or in the *Attributes* tab of the console) must be supplied either by you (in your call to ``AdminCreateUser`` ) or by the user (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . (You can also do this by calling ` <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ .) - *email* : The email address of the user to whom the message that contains the code and user name will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and user name will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
10603
|
-
:param username: The username
|
|
10603
|
+
:param username: The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. - The username can't be a duplicate of another username in the same user pool. - You can't change the value of a username after you create it. - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
|
|
10604
10604
|
:param validation_data: The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. The user's validation data isn't persisted.
|
|
10605
10605
|
'''
|
|
10606
10606
|
if __debug__:
|
|
@@ -10757,7 +10757,7 @@ class CfnUserPoolUser(
|
|
|
10757
10757
|
@builtins.property
|
|
10758
10758
|
@jsii.member(jsii_name="username")
|
|
10759
10759
|
def username(self) -> typing.Optional[builtins.str]:
|
|
10760
|
-
'''The
|
|
10760
|
+
'''The value that you want to set as the username sign-in attribute.'''
|
|
10761
10761
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "username"))
|
|
10762
10762
|
|
|
10763
10763
|
@username.setter
|
|
@@ -10891,7 +10891,7 @@ class CfnUserPoolUserProps:
|
|
|
10891
10891
|
:param force_alias_creation: This parameter is used only if the ``phone_number_verified`` or ``email_verified`` attribute is set to ``True`` . Otherwise, it is ignored. If this parameter is set to ``True`` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. If this parameter is set to ``False`` , the API throws an ``AliasExistsException`` error if the alias already exists. The default value is ``False`` .
|
|
10892
10892
|
:param message_action: Set to ``RESEND`` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to ``SUPPRESS`` to suppress sending the message. You can specify only one value.
|
|
10893
10893
|
:param user_attributes: The user attributes and attribute values to be set for the user to be created. These are name-value pairs You can create a user without specifying any attributes other than ``Username`` . However, any attributes that you specify as required (in ` <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html>`_ or in the *Attributes* tab of the console) must be supplied either by you (in your call to ``AdminCreateUser`` ) or by the user (when they sign up in response to your welcome message). For custom attributes, you must prepend the ``custom:`` prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the *Users* tab of the Amazon Cognito console for managing your user pools. In your call to ``AdminCreateUser`` , you can set the ``email_verified`` attribute to ``True`` , and you can set the ``phone_number_verified`` attribute to ``True`` . (You can also do this by calling ` <https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html>`_ .) - *email* : The email address of the user to whom the message that contains the code and user name will be sent. Required if the ``email_verified`` attribute is set to ``True`` , or if ``"EMAIL"`` is specified in the ``DesiredDeliveryMediums`` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and user name will be sent. Required if the ``phone_number_verified`` attribute is set to ``True`` , or if ``"SMS"`` is specified in the ``DesiredDeliveryMediums`` parameter.
|
|
10894
|
-
:param username: The username
|
|
10894
|
+
:param username: The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. - The username can't be a duplicate of another username in the same user pool. - You can't change the value of a username after you create it. - You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
|
|
10895
10895
|
:param validation_data: The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up AWS Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. The user's validation data isn't persisted.
|
|
10896
10896
|
|
|
10897
10897
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html
|
|
@@ -11045,9 +11045,13 @@ class CfnUserPoolUserProps:
|
|
|
11045
11045
|
|
|
11046
11046
|
@builtins.property
|
|
11047
11047
|
def username(self) -> typing.Optional[builtins.str]:
|
|
11048
|
-
'''The
|
|
11048
|
+
'''The value that you want to set as the username sign-in attribute.
|
|
11049
11049
|
|
|
11050
|
-
|
|
11050
|
+
The following conditions apply to the username parameter.
|
|
11051
|
+
|
|
11052
|
+
- The username can't be a duplicate of another username in the same user pool.
|
|
11053
|
+
- You can't change the value of a username after you create it.
|
|
11054
|
+
- You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see `Customizing sign-in attributes <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases>`_ .
|
|
11051
11055
|
|
|
11052
11056
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluser.html#cfn-cognito-userpooluser-username
|
|
11053
11057
|
'''
|
|
@@ -11091,14 +11095,6 @@ class CfnUserPoolUserToGroupAttachment(
|
|
|
11091
11095
|
):
|
|
11092
11096
|
'''Adds the specified user to the specified group.
|
|
11093
11097
|
|
|
11094
|
-
.. epigraph::
|
|
11095
|
-
|
|
11096
|
-
Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
|
|
11097
|
-
|
|
11098
|
-
**Learn more** - `Signing AWS API Requests <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html>`_
|
|
11099
|
-
|
|
11100
|
-
- `Using the Amazon Cognito user pools API and user pool endpoints <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html>`_
|
|
11101
|
-
|
|
11102
11098
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolusertogroupattachment.html
|
|
11103
11099
|
:exampleMetadata: fixture=_generated
|
|
11104
11100
|
|
aws_cdk/aws_config/__init__.py
CHANGED
|
@@ -930,13 +930,11 @@ class CfnConfigRule(
|
|
|
930
930
|
policy_runtime: typing.Optional[builtins.str] = None,
|
|
931
931
|
policy_text: typing.Optional[builtins.str] = None,
|
|
932
932
|
) -> None:
|
|
933
|
-
'''Provides the
|
|
934
|
-
|
|
935
|
-
You can specify the following CustomPolicyDetails parameter values only for AWS Config Custom Policy rules.
|
|
933
|
+
'''Provides the CustomPolicyDetails, the rule owner ( ``AWS`` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.
|
|
936
934
|
|
|
937
|
-
:param enable_debug_log_delivery:
|
|
935
|
+
:param enable_debug_log_delivery: The boolean expression for enabling debug logging for your AWS Config Custom Policy rule. The default value is ``false`` .
|
|
938
936
|
:param policy_runtime: The runtime system for your AWS Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by AWS Config Custom Policy rules. For more information about Guard, see the `Guard GitHub Repository <https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard>`_ .
|
|
939
|
-
:param policy_text:
|
|
937
|
+
:param policy_text: The policy definition containing the logic for your AWS Config Custom Policy rule.
|
|
940
938
|
|
|
941
939
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html
|
|
942
940
|
:exampleMetadata: fixture=_generated
|
|
@@ -970,7 +968,9 @@ class CfnConfigRule(
|
|
|
970
968
|
def enable_debug_log_delivery(
|
|
971
969
|
self,
|
|
972
970
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
973
|
-
'''
|
|
971
|
+
'''The boolean expression for enabling debug logging for your AWS Config Custom Policy rule.
|
|
972
|
+
|
|
973
|
+
The default value is ``false`` .
|
|
974
974
|
|
|
975
975
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html#cfn-config-configrule-custompolicydetails-enabledebuglogdelivery
|
|
976
976
|
'''
|
|
@@ -990,7 +990,7 @@ class CfnConfigRule(
|
|
|
990
990
|
|
|
991
991
|
@builtins.property
|
|
992
992
|
def policy_text(self) -> typing.Optional[builtins.str]:
|
|
993
|
-
'''
|
|
993
|
+
'''The policy definition containing the logic for your AWS Config Custom Policy rule.
|
|
994
994
|
|
|
995
995
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html#cfn-config-configrule-custompolicydetails-policytext
|
|
996
996
|
'''
|
|
@@ -1310,7 +1310,7 @@ class CfnConfigRule(
|
|
|
1310
1310
|
'''Provides the CustomPolicyDetails, the rule owner ( ``AWS`` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.
|
|
1311
1311
|
|
|
1312
1312
|
:param owner: Indicates whether AWS or the customer owns and manages the AWS Config rule. AWS Config Managed Rules are predefined rules owned by AWS . For more information, see `AWS Config Managed Rules <https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html>`_ in the *AWS Config developer guide* . AWS Config Custom Rules are rules that you can develop either with Guard ( ``CUSTOM_POLICY`` ) or AWS Lambda ( ``CUSTOM_LAMBDA`` ). For more information, see `AWS Config Custom Rules <https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html>`_ in the *AWS Config developer guide* .
|
|
1313
|
-
:param custom_policy_details:
|
|
1313
|
+
:param custom_policy_details: Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to ``CUSTOM_POLICY`` .
|
|
1314
1314
|
:param source_details: Provides the source and the message types that cause AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. If the owner is set to ``CUSTOM_POLICY`` , the only acceptable values for the AWS Config rule trigger message type are ``ConfigurationItemChangeNotification`` and ``OversizedConfigurationItemChangeNotification`` .
|
|
1315
1315
|
:param source_identifier: For AWS Config Managed rules, a predefined identifier from a list. For example, ``IAM_PASSWORD_POLICY`` is a managed rule. To reference a managed rule, see `List of AWS Config Managed Rules <https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html>`_ . For AWS Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as ``arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name`` . For AWS Config Custom Policy rules, this field will be ignored.
|
|
1316
1316
|
|
|
@@ -1376,7 +1376,9 @@ class CfnConfigRule(
|
|
|
1376
1376
|
def custom_policy_details(
|
|
1377
1377
|
self,
|
|
1378
1378
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigRule.CustomPolicyDetailsProperty"]]:
|
|
1379
|
-
'''
|
|
1379
|
+
'''Provides the runtime system, policy definition, and whether debug logging is enabled.
|
|
1380
|
+
|
|
1381
|
+
Required when owner is set to ``CUSTOM_POLICY`` .
|
|
1380
1382
|
|
|
1381
1383
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html#cfn-config-configrule-source-custompolicydetails
|
|
1382
1384
|
'''
|
|
@@ -2414,59 +2416,27 @@ class CfnConfigurationRecorder(
|
|
|
2414
2416
|
) -> None:
|
|
2415
2417
|
'''Specifies which resource types AWS Config records for configuration changes.
|
|
2416
2418
|
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
- ***Regional resources*** - By default, AWS Config records configuration changes for all current and future supported types of *Regional resources* that AWS Config discovers in the AWS Region where it is running. When AWS Config adds support for a new type of Regional resource, AWS Config starts recording resources of that type automatically.
|
|
2420
|
-
|
|
2421
|
-
Regional resources are tied to a Region and can be used only in that Region. You create them in a specified AWS Region , and then they exist in that Region. To see or interact with those resources, you must direct your operations to that Region. For example, to create an Amazon EC2 instance with the AWS Management Console , you `choose the AWS Region <https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/select-region.html>`_ that you want to create the instance in. If you use the AWS Command Line Interface ( AWS CLI ) to create the instance, then you include the ``--region`` parameter. The AWS SDKs each have their own equivalent mechanism to specify the Region that the operation uses.
|
|
2422
|
-
|
|
2423
|
-
There are several reasons for using Regional resources. One reason is to ensure that the resources, and the service endpoints that you use to access them, are as close to the customer as possible. This improves performance by minimizing latency. Another reason is to provide an isolation boundary. This lets you create independent copies of resources in multiple Regions to distribute the load and improve scalability. At the same time, it isolates the resources from each other to improve availability.
|
|
2424
|
-
|
|
2425
|
-
If you specify a different AWS Region in the console or in an AWS CLI command, then you can no longer see or interact with the resources you could see in the previous Region.
|
|
2426
|
-
|
|
2427
|
-
When you look at the `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ for a Regional resource, the Region that contains the resource is specified as the fourth field in the ARN. For example, an Amazon EC2 instance is a Regional resource. The following is an example of an ARN for a Amazon Virtual Private Cloud ( Amazon VPC ) that exists in the ``us-east-1`` Region:
|
|
2428
|
-
|
|
2429
|
-
``arn:aws:ec2:us-east-1:123456789012:instance/i-0a6f30921424d3eee`` .
|
|
2430
|
-
|
|
2431
|
-
- ***Global resources*** - Some AWS services resources are *global resources* , meaning that you can use the resource from **anywhere** . You don't specify an AWS Region in a global service's console. To access a global resource, you don't specify a ``--region`` parameter when using the service's AWS CLI and AWS SDK operations.
|
|
2419
|
+
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 globally recorded IAM resource types: IAM users, groups, roles, and customer managed policies).
|
|
2432
2420
|
|
|
2433
|
-
|
|
2421
|
+
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 <https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources>`_ in the *AWS Config developer guide* .
|
|
2434
2422
|
|
|
2435
|
-
|
|
2423
|
+
If you don't want AWS Config to record all current and future supported resource types, use one of the following recording strategies:
|
|
2436
2424
|
|
|
2437
|
-
|
|
2425
|
+
- *Record all current and future resource types with exclusions* ( ``EXCLUSION_BY_RESOURCE_TYPES`` ), or
|
|
2426
|
+
- *Record specific resource types* ( ``INCLUSION_BY_RESOURCE_TYPES`` ).
|
|
2438
2427
|
|
|
2439
|
-
``arn:aws:rds::123456789012:global-cluster:test-global-cluster`` .
|
|
2440
2428
|
.. epigraph::
|
|
2441
2429
|
|
|
2442
|
-
|
|
2430
|
+
*Aurora global clusters are automatically globally recorded unless specifically excluded*
|
|
2443
2431
|
|
|
2444
|
-
|
|
2432
|
+
The ``AWS::RDS::GlobalCluster`` resource type will be recorded in all supported AWS Config Regions where the configuration recorder is enabled.
|
|
2445
2433
|
|
|
2446
|
-
|
|
2434
|
+
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.
|
|
2447
2435
|
|
|
2448
|
-
|
|
2449
|
-
|
|
2450
|
-
*Aurora global clusters*
|
|
2451
|
-
|
|
2452
|
-
``AWS::RDS::GlobalCluster`` is a globally recorded resource type. It is recorded in all supported Amazon RDS Regions where the configuration recorder is enabled.
|
|
2453
|
-
|
|
2454
|
-
*IAM resources*
|
|
2455
|
-
|
|
2456
|
-
The following IAM resource types are also globally recorded: IAM users, groups, roles, and customer managed policies. However, these resource types are only recorded in all supported Amazon RDS Regions where the configuration recorder is enabled and that were supported by AWS Config ; *before* February 2022. This list does not include the following Regions: Asia Pacific (Hyderabad), Asia Pacific (Melbourne), Europe (Spain), Europe (Zurich), Israel (Tel Aviv), and Middle East (UAE).
|
|
2457
|
-
.. epigraph::
|
|
2458
|
-
|
|
2459
|
-
When you select *Include globally recorded resource types* in the AWS Config console, or input ``includeGlobalResourceTypes=true`` using the API or CLI, this option only applies to globally recorded resources. This option does *not* apply to global resources recorded only in a home Region.
|
|
2460
|
-
|
|
2461
|
-
For a list of supported resource types, see `Supported Resource Types <https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources>`_ in the *AWS Config developer guide* .
|
|
2462
|
-
.. epigraph::
|
|
2463
|
-
|
|
2464
|
-
If you don't want AWS Config to record all resources, you can specify which types of resources AWS Config records with the ``resourceTypes`` parameter.
|
|
2465
|
-
|
|
2466
|
-
:param all_supported: Specifies whether AWS Config records configuration changes for all supported regional resource types. If you set this field to ``true`` , when AWS Config adds support for a new type of regional resource, 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 <https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html>`_ , or to exclude in the ``resourceTypes`` field of `ExclusionByResourceTypes <https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html>`_ .
|
|
2436
|
+
:param all_supported: Specifies whether AWS Config records configuration changes for all supported regionally recorded resource types. If you set this field to ``true`` , when AWS Config adds support for a new regionally recorded 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 <https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html>`_ , or to exclude in the ``resourceTypes`` field of `ExclusionByResourceTypes <https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html>`_ . .. 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 .
|
|
2467
2437
|
:param 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 <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``EXCLUSION_BY_RESOURCE_TYPES`` .
|
|
2468
|
-
:param include_global_resource_types:
|
|
2469
|
-
:param recording_strategy: An object that specifies the recording strategy for the configuration recorder. - If you set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``ALL_SUPPORTED_RESOURCE_TYPES`` , AWS Config records configuration changes for all supported
|
|
2438
|
+
:param include_global_resource_types: 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 AWS Config regions where AWS 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) .. epigraph:: *Aurora global clusters are automatically globally recorded unless specifically excluded* 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 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 <https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all>`_ in the *AWS Config developer guide* . > *Required and optional fields* Before you set this field to ``true`` , set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . Optionally, you can set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ 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 `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ , 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 globally recorded IAM resource types, make sure to not list them in the ``resourceTypes`` field in addition to setting the ``includeGlobalResourceTypes`` field to false.
|
|
2439
|
+
:param recording_strategy: An object that specifies the recording strategy for the configuration recorder. - If you set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``ALL_SUPPORTED_RESOURCE_TYPES`` , AWS Config records configuration changes for all supported regionally recorded resource types. You also must set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . When AWS Config adds support for a new regionally recorded resource, AWS Config automatically starts recording resources of that type. - If you set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``INCLUSION_BY_RESOURCE_TYPES`` , AWS Config records configuration changes for only the resource types you specify in the ``resourceTypes`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ . - If you set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ 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 `AWS::Config::ConfigurationRecorder ExclusionByResourceTypes <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html>`_ . .. epigraph:: *Required and optional fields* The ``recordingStrategy`` field is optional when you set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . The ``recordingStrategy`` field is optional when you list resource types in the ``resourceTypes`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ . The ``recordingStrategy`` field is required if you list resource types to exclude from recording in the ``resourceTypes`` field of `AWS::Config::ConfigurationRecorder ExclusionByResourceTypes <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html>`_ . > *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 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. In addition, 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 automatically in all enabled AWS Config Regions where AWS 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)
|
|
2470
2440
|
:param resource_types: A comma-separated list that specifies which resource types AWS Config records. Optionally, you can set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``INCLUSION_BY_RESOURCE_TYPES`` . To record all configuration changes, set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-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. For a list of valid ``resourceTypes`` values, see the *Resource Type Value* column in `Supported AWS resource Types <https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources>`_ in the *AWS Config developer guide* . .. epigraph:: *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 .
|
|
2471
2441
|
|
|
2472
2442
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html
|
|
@@ -2513,11 +2483,16 @@ class CfnConfigurationRecorder(
|
|
|
2513
2483
|
def all_supported(
|
|
2514
2484
|
self,
|
|
2515
2485
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
2516
|
-
'''Specifies whether AWS Config records configuration changes for all supported
|
|
2486
|
+
'''Specifies whether AWS Config records configuration changes for all supported regionally recorded resource types.
|
|
2517
2487
|
|
|
2518
|
-
If you set this field to ``true`` , when AWS Config adds support for a new
|
|
2488
|
+
If you set this field to ``true`` , when AWS Config adds support for a new regionally recorded resource type, AWS Config starts recording resources of that type automatically.
|
|
2519
2489
|
|
|
2520
2490
|
If you set this field to ``true`` , you cannot enumerate specific resource types to record in the ``resourceTypes`` field of `RecordingGroup <https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html>`_ , or to exclude in the ``resourceTypes`` field of `ExclusionByResourceTypes <https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html>`_ .
|
|
2491
|
+
.. epigraph::
|
|
2492
|
+
|
|
2493
|
+
*Region Availability*
|
|
2494
|
+
|
|
2495
|
+
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 .
|
|
2521
2496
|
|
|
2522
2497
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-allsupported
|
|
2523
2498
|
'''
|
|
@@ -2541,9 +2516,9 @@ class CfnConfigurationRecorder(
|
|
|
2541
2516
|
def include_global_resource_types(
|
|
2542
2517
|
self,
|
|
2543
2518
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
2544
|
-
'''
|
|
2519
|
+
'''A legacy field which *only applies to the globally recorded IAM resource types* : IAM users, groups, roles, and customer managed policies.
|
|
2545
2520
|
|
|
2546
|
-
If you select this option,
|
|
2521
|
+
If you select this option, these resource types will be recorded in all enabled AWS Config regions where AWS Config was available before February 2022. This list does not include the following Regions:
|
|
2547
2522
|
|
|
2548
2523
|
- Asia Pacific (Hyderabad)
|
|
2549
2524
|
- Asia Pacific (Melbourne)
|
|
@@ -2552,14 +2527,24 @@ class CfnConfigurationRecorder(
|
|
|
2552
2527
|
- Israel (Tel Aviv)
|
|
2553
2528
|
- Middle East (UAE)
|
|
2554
2529
|
|
|
2555
|
-
Before you set this field to ``true`` , set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . Optionally, you can set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``ALL_SUPPORTED_RESOURCE_TYPES`` .
|
|
2556
|
-
|
|
2557
|
-
If you set this field to ``true`` , when AWS Config adds support for a new type of global resource in the Region where you set up the configuration recorder, AWS Config starts recording resources of that type automatically.
|
|
2558
2530
|
.. epigraph::
|
|
2559
2531
|
|
|
2560
|
-
|
|
2532
|
+
*Aurora global clusters are automatically globally recorded unless specifically excluded*
|
|
2533
|
+
|
|
2534
|
+
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 not set to ``true`` . ``includeGlobalResourceTypes`` is a legacy field which only applies to IAM users, groups, roles, and customer managed policies.
|
|
2535
|
+
|
|
2536
|
+
If you do not want to record ``AWS::RDS::GlobalCluster`` in all enabled Regions, use one of the following recording strategies:
|
|
2561
2537
|
|
|
2562
|
-
|
|
2538
|
+
- *Record all current and future resource types with exclusions* ( ``EXCLUSION_BY_RESOURCE_TYPES`` ), or
|
|
2539
|
+
- *Record specific resource types* ( ``INCLUSION_BY_RESOURCE_TYPES`` ).
|
|
2540
|
+
|
|
2541
|
+
For more information, see `Selecting Which Resources are Recorded <https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all>`_ in the *AWS Config developer guide* . > *Required and optional fields*
|
|
2542
|
+
|
|
2543
|
+
Before you set this field to ``true`` , set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . Optionally, you can set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``ALL_SUPPORTED_RESOURCE_TYPES`` . > *Overriding fields*
|
|
2544
|
+
|
|
2545
|
+
If you set this field to ``false`` but list globally recorded IAM resource types in the ``resourceTypes`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ , AWS Config will still record configuration changes for those specified resource types *regardless* of if you set the ``includeGlobalResourceTypes`` field to false.
|
|
2546
|
+
|
|
2547
|
+
If you do not want to record configuration changes to globally recorded IAM resource types, make sure to not list them in the ``resourceTypes`` field in addition to setting the ``includeGlobalResourceTypes`` field to false.
|
|
2563
2548
|
|
|
2564
2549
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html#cfn-config-configurationrecorder-recordinggroup-includeglobalresourcetypes
|
|
2565
2550
|
'''
|
|
@@ -2572,7 +2557,7 @@ class CfnConfigurationRecorder(
|
|
|
2572
2557
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationRecorder.RecordingStrategyProperty"]]:
|
|
2573
2558
|
'''An object that specifies the recording strategy for the configuration recorder.
|
|
2574
2559
|
|
|
2575
|
-
- If you set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``ALL_SUPPORTED_RESOURCE_TYPES`` , AWS Config records configuration changes for all supported
|
|
2560
|
+
- If you set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``ALL_SUPPORTED_RESOURCE_TYPES`` , AWS Config records configuration changes for all supported regionally recorded resource types. You also must set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . When AWS Config adds support for a new regionally recorded resource, AWS Config automatically starts recording resources of that type.
|
|
2576
2561
|
- If you set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ to ``INCLUSION_BY_RESOURCE_TYPES`` , AWS Config records configuration changes for only the resource types you specify in the ``resourceTypes`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ .
|
|
2577
2562
|
- If you set the ``useOnly`` field of `AWS::Config::ConfigurationRecorder RecordingStrategy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html>`_ 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 `AWS::Config::ConfigurationRecorder ExclusionByResourceTypes <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html>`_ .
|
|
2578
2563
|
|
|
@@ -2648,7 +2633,7 @@ class CfnConfigurationRecorder(
|
|
|
2648
2633
|
|
|
2649
2634
|
Valid values include: ``ALL_SUPPORTED_RESOURCE_TYPES`` , ``INCLUSION_BY_RESOURCE_TYPES`` , and ``EXCLUSION_BY_RESOURCE_TYPES`` .
|
|
2650
2635
|
|
|
2651
|
-
:param 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
|
|
2636
|
+
:param 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 regionally recorded resource types. You also must set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . When AWS Config adds support for a new regionally recorded resource, AWS Config automatically starts recording resources of that type. For a list of supported resource types, see `Supported Resource Types <https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources>`_ 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 [AWS::Config::ConfigurationRecorder RecordingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conew type of regional resourcenfigurationrecorder-recordinggroup.html) . - 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 `AWS::Config::ConfigurationRecorder ExclusionByResourceTypes <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html>`_ . .. epigraph:: *Required and optional fields* The ``recordingStrategy`` field is optional when you set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . The ``recordingStrategy`` field is optional when you list resource types in the ``resourceTypes`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ . The ``recordingStrategy`` field is required if you list resource types to exclude from recording in the ``resourceTypes`` field of `AWS::Config::ConfigurationRecorder ExclusionByResourceTypes <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html>`_ . > *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 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. In addition, 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 automatically in all enabled AWS Config Regions where AWS 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)
|
|
2652
2637
|
|
|
2653
2638
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordingstrategy.html
|
|
2654
2639
|
:exampleMetadata: fixture=_generated
|
|
@@ -2674,11 +2659,8 @@ class CfnConfigurationRecorder(
|
|
|
2674
2659
|
def use_only(self) -> builtins.str:
|
|
2675
2660
|
'''The recording strategy for the configuration recorder.
|
|
2676
2661
|
|
|
2677
|
-
- If you set this option to ``ALL_SUPPORTED_RESOURCE_TYPES`` , AWS Config records configuration changes for all supported
|
|
2678
|
-
|
|
2679
|
-
When AWS Config adds support for a new type of regional resource, AWS Config automatically starts recording resources of that type. For a list of supported resource types, see `Supported Resource Types <https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources>`_ in the *AWS Config developer guide* .
|
|
2680
|
-
|
|
2681
|
-
- 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 `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ .
|
|
2662
|
+
- If you set this option to ``ALL_SUPPORTED_RESOURCE_TYPES`` , AWS Config records configuration changes for all supported regionally recorded resource types. You also must set the ``allSupported`` field of `AWS::Config::ConfigurationRecorder RecordingGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-recordinggroup.html>`_ to ``true`` . When AWS Config adds support for a new regionally recorded resource, AWS Config automatically starts recording resources of that type. For a list of supported resource types, see `Supported Resource Types <https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources>`_ in the *AWS Config developer guide* .
|
|
2663
|
+
- 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 [AWS::Config::ConfigurationRecorder RecordingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conew type of regional resourcenfigurationrecorder-recordinggroup.html) .
|
|
2682
2664
|
- 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 `AWS::Config::ConfigurationRecorder ExclusionByResourceTypes <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configurationrecorder-exclusionbyresourcetypes.html>`_ .
|
|
2683
2665
|
|
|
2684
2666
|
.. epigraph::
|
|
@@ -3147,10 +3129,14 @@ class CfnConformancePack(
|
|
|
3147
3129
|
document_name: typing.Optional[builtins.str] = None,
|
|
3148
3130
|
document_version: typing.Optional[builtins.str] = None,
|
|
3149
3131
|
) -> None:
|
|
3150
|
-
'''
|
|
3132
|
+
'''This API allows you to create a conformance pack template with an AWS Systems Manager document (SSM document).
|
|
3133
|
+
|
|
3134
|
+
To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the ``DocumentName`` in the `PutConformancePack API <https://docs.aws.amazon.com/config/latest/APIReference/API_PutConformancePack.html>`_ . You can also provide the ``DocumentVersion`` .
|
|
3135
|
+
|
|
3136
|
+
The ``TemplateSSMDocumentDetails`` object contains the name of the SSM document and the version of the SSM document.
|
|
3151
3137
|
|
|
3152
|
-
:param document_name:
|
|
3153
|
-
:param document_version:
|
|
3138
|
+
:param document_name: The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.
|
|
3139
|
+
:param document_version: The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version. .. epigraph:: This field is optional.
|
|
3154
3140
|
|
|
3155
3141
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html
|
|
3156
3142
|
:exampleMetadata: fixture=_generated
|
|
@@ -3178,7 +3164,10 @@ class CfnConformancePack(
|
|
|
3178
3164
|
|
|
3179
3165
|
@builtins.property
|
|
3180
3166
|
def document_name(self) -> typing.Optional[builtins.str]:
|
|
3181
|
-
'''
|
|
3167
|
+
'''The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.
|
|
3168
|
+
|
|
3169
|
+
If you use the document name, AWS Config checks only your account and AWS Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.
|
|
3170
|
+
|
|
3182
3171
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html#cfn-config-conformancepack-templatessmdocumentdetails-documentname
|
|
3183
3172
|
'''
|
|
3184
3173
|
result = self._values.get("document_name")
|
|
@@ -3186,7 +3175,13 @@ class CfnConformancePack(
|
|
|
3186
3175
|
|
|
3187
3176
|
@builtins.property
|
|
3188
3177
|
def document_version(self) -> typing.Optional[builtins.str]:
|
|
3189
|
-
'''
|
|
3178
|
+
'''The version of the SSM document to use to create a conformance pack.
|
|
3179
|
+
|
|
3180
|
+
By default, AWS Config uses the latest version.
|
|
3181
|
+
.. epigraph::
|
|
3182
|
+
|
|
3183
|
+
This field is optional.
|
|
3184
|
+
|
|
3190
3185
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html#cfn-config-conformancepack-templatessmdocumentdetails-documentversion
|
|
3191
3186
|
'''
|
|
3192
3187
|
result = self._values.get("document_version")
|