aws-cdk-lib 2.149.0__tar.gz → 2.151.0__tar.gz

{aws-cdk-lib-2.149.0/src/aws_cdk_lib.egg-info → aws-cdk-lib-2.151.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk-lib
-Version: 2.149.0
+Version: 2.151.0
 Summary: Version 2 of the AWS Cloud Development Kit library
 Home-page: https://github.com/aws/aws-cdk
 Author: Amazon Web Services

{aws-cdk-lib-2.149.0 → aws-cdk-lib-2.151.0}/setup.py

@@ -5,7 +5,7 @@ kwargs = json.loads(
     """
 {
     "name": "aws-cdk-lib",
-    "version": "2.149.0",
+    "version": "2.151.0",
     "description": "Version 2 of the AWS Cloud Development Kit library",
     "license": "Apache-2.0",
     "url": "https://github.com/aws/aws-cdk",
@@ -307,7 +307,7 @@ kwargs = json.loads(
     ],
     "package_data": {
         "aws_cdk._jsii": [
-            "aws-cdk-lib@2.149.0.jsii.tgz"
+            "aws-cdk-lib@2.151.0.jsii.tgz"
         ],
         "aws_cdk": [
             "py.typed"

{aws-cdk-lib-2.149.0 → aws-cdk-lib-2.151.0}/src/aws_cdk/__init__.py

@@ -20011,9 +20011,6 @@ class Stack(
         remove the reference from the consuming stack. After that, you can remove
         the resource and the manual export.
 
-
-        Example
-
         Here is how the process works. Let's say there are two stacks,
         ``producerStack`` and ``consumerStack``, and ``producerStack`` has a bucket
         called ``bucket``, which is referenced by ``consumerStack`` (perhaps because
@@ -20024,8 +20021,7 @@ class Stack(
 
         Instead, the process takes two deployments:
 
-
-        Deployment 1: break the relationship
+        **Deployment 1: break the relationship**:
 
         - Make sure ``consumerStack`` no longer references ``bucket.bucketName`` (maybe the consumer
           stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just
@@ -20035,9 +20031,7 @@ class Stack(
           between the two stacks is being broken.
         - Deploy (this will effectively only change the ``consumerStack``, but it's safe to deploy both).
 
-
-
-        Deployment 2: remove the bucket resource
+        **Deployment 2: remove the bucket resource**:
 
         - You are now free to remove the ``bucket`` resource from ``producerStack``.
         - Don't forget to remove the ``exportValue()`` call as well.
@@ -30122,7 +30116,7 @@ class CfnStackSet(
         ) -> None:
             '''The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
 
-            :param account_filter_type: Limit deployment targets to individual accounts or include additional accounts with provided OUs. The following is a list of possible values for the ``AccountFilterType`` operation. - ``INTERSECTION`` : StackSets deploys to the accounts specified in ``Accounts`` parameter. - ``DIFFERENCE`` : StackSets excludes the accounts specified in ``Accounts`` parameter. This enables user to avoid certain accounts within an OU such as suspended accounts. - ``UNION`` : StackSets includes additional accounts deployment targets. This is the default value if ``AccountFilterType`` is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests. - ``NONE`` : Deploys to all the accounts in specified organizational units (OU).
+            :param account_filter_type: Limit deployment targets to individual accounts or include additional accounts with provided OUs. The following is a list of possible values for the ``AccountFilterType`` operation. - ``INTERSECTION`` : StackSet deploys to the accounts specified in the ``Accounts`` parameter. - ``DIFFERENCE`` : StackSet deploys to the OU, excluding the accounts specified in the ``Accounts`` parameter. - ``UNION`` StackSet deploys to the OU, and the accounts specified in the ``Accounts`` parameter. ``UNION`` is not supported for create operations when using StackSet as a resource.
             :param accounts: The names of one or more AWS accounts for which you want to deploy stack set updates. *Pattern* : ``^[0-9]{12}$``
             :param accounts_url: Returns the value of the ``AccountsUrl`` property.
             :param organizational_unit_ids: The organization root ID or organizational unit (OU) IDs to which StackSets deploys. *Pattern* : ``^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$``
@@ -30165,13 +30159,9 @@ class CfnStackSet(
 
             The following is a list of possible values for the ``AccountFilterType`` operation.
 
-            - ``INTERSECTION`` : StackSets deploys to the accounts specified in ``Accounts`` parameter.
-            - ``DIFFERENCE`` : StackSets excludes the accounts specified in ``Accounts`` parameter. This enables user to avoid certain accounts within an OU such as suspended accounts.
-            - ``UNION`` : StackSets includes additional accounts deployment targets.
-
-            This is the default value if ``AccountFilterType`` is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests.
-
-            - ``NONE`` : Deploys to all the accounts in specified organizational units (OU).
+            - ``INTERSECTION`` : StackSet deploys to the accounts specified in the ``Accounts`` parameter.
+            - ``DIFFERENCE`` : StackSet deploys to the OU, excluding the accounts specified in the ``Accounts`` parameter.
+            - ``UNION`` StackSet deploys to the OU, and the accounts specified in the ``Accounts`` parameter. ``UNION`` is not supported for create operations when using StackSet as a resource.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountfiltertype
             '''

{aws-cdk-lib-2.149.0 → aws-cdk-lib-2.151.0}/src/aws_cdk/_jsii/__init__.py

@@ -19,7 +19,7 @@ import aws_cdk.asset_node_proxy_agent_v6._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "aws-cdk-lib", "2.149.0", __name__[0:-6], "aws-cdk-lib@2.149.0.jsii.tgz"
+    "aws-cdk-lib", "2.151.0", __name__[0:-6], "aws-cdk-lib@2.151.0.jsii.tgz"
 )
 
 __all__ = [

{aws-cdk-lib-2.149.0 → aws-cdk-lib-2.151.0}/src/aws_cdk/aws_apigatewayv2/__init__.py

@@ -138,7 +138,8 @@ Use `HttpStage` to create a Stage resource for HTTP APIs. The following code set
 
 apigwv2.HttpStage(self, "Stage",
     http_api=api,
-    stage_name="beta"
+    stage_name="beta",
+    description="My Stage"
 )
 ```
 
@@ -383,6 +384,7 @@ web_socket_api = apigwv2.WebSocketApi(self, "mywsapi",
 apigwv2.WebSocketStage(self, "mystage",
     web_socket_api=web_socket_api,
     stage_name="dev",
+    description="My Stage",
     auto_deploy=True
 )
 ```
@@ -12454,6 +12456,7 @@ class StageAttributes:
     jsii_struct_bases=[],
     name_mapping={
         "auto_deploy": "autoDeploy",
+        "description": "description",
         "domain_mapping": "domainMapping",
         "throttle": "throttle",
     },
@@ -12463,6 +12466,7 @@ class StageOptions:
         self,
         *,
         auto_deploy: typing.Optional[builtins.bool] = None,
+        description: typing.Optional[builtins.str] = None,
         domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         throttle: typing.Optional[typing.Union["ThrottleSettings", typing.Dict[builtins.str, typing.Any]]] = None,
     ) -> None:
@@ -12471,6 +12475,7 @@ class StageOptions:
         Options that are common between HTTP and Websocket APIs.
 
         :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
+        :param description: The description for the API stage. Default: - no description
         :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
         :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
 
@@ -12486,6 +12491,7 @@ class StageOptions:
             
             stage_options = apigatewayv2.StageOptions(
                 auto_deploy=False,
+                description="description",
                 domain_mapping=apigatewayv2.DomainMappingOptions(
                     domain_name=domain_name,
             
@@ -12505,11 +12511,14 @@ class StageOptions:
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__7d1ab9a2efdde27ab3aff279b986e4a558573396d5100c22c5a48bcbee4f320a)
             check_type(argname="argument auto_deploy", value=auto_deploy, expected_type=type_hints["auto_deploy"])
+            check_type(argname="argument description", value=description, expected_type=type_hints["description"])
             check_type(argname="argument domain_mapping", value=domain_mapping, expected_type=type_hints["domain_mapping"])
             check_type(argname="argument throttle", value=throttle, expected_type=type_hints["throttle"])
         self._values: typing.Dict[builtins.str, typing.Any] = {}
         if auto_deploy is not None:
             self._values["auto_deploy"] = auto_deploy
+        if description is not None:
+            self._values["description"] = description
         if domain_mapping is not None:
             self._values["domain_mapping"] = domain_mapping
         if throttle is not None:
@@ -12524,6 +12533,15 @@ class StageOptions:
         result = self._values.get("auto_deploy")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def description(self) -> typing.Optional[builtins.str]:
+        '''The description for the API stage.
+
+        :default: - no description
+        '''
+        result = self._values.get("description")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def domain_mapping(self) -> typing.Optional[DomainMappingOptions]:
         '''The options for custom domain and api mapping.
@@ -14967,22 +14985,18 @@ class WebSocketStage(
 
         from aws_cdk.aws_apigatewayv2_integrations import WebSocketLambdaIntegration
         
-        # connect_handler: lambda.Function
-        # disconnect_handler: lambda.Function
-        # default_handler: lambda.Function
-        
+        # message_handler: lambda.Function
         
-        web_socket_api = apigwv2.WebSocketApi(self, "mywsapi",
-            connect_route_options=apigwv2.WebSocketRouteOptions(integration=WebSocketLambdaIntegration("ConnectIntegration", connect_handler)),
-            disconnect_route_options=apigwv2.WebSocketRouteOptions(integration=WebSocketLambdaIntegration("DisconnectIntegration", disconnect_handler)),
-            default_route_options=apigwv2.WebSocketRouteOptions(integration=WebSocketLambdaIntegration("DefaultIntegration", default_handler))
-        )
         
+        web_socket_api = apigwv2.WebSocketApi(self, "mywsapi")
         apigwv2.WebSocketStage(self, "mystage",
             web_socket_api=web_socket_api,
             stage_name="dev",
             auto_deploy=True
         )
+        web_socket_api.add_route("sendMessage",
+            integration=WebSocketLambdaIntegration("SendMessageIntegration", message_handler)
+        )
     '''
 
     def __init__(
@@ -14993,6 +15007,7 @@ class WebSocketStage(
         stage_name: builtins.str,
         web_socket_api: IWebSocketApi,
         auto_deploy: typing.Optional[builtins.bool] = None,
+        description: typing.Optional[builtins.str] = None,
         domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
     ) -> None:
@@ -15002,6 +15017,7 @@ class WebSocketStage(
         :param stage_name: The name of the stage.
         :param web_socket_api: The WebSocket API to which this stage is associated.
         :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
+        :param description: The description for the API stage. Default: - no description
         :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
         :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
         '''
@@ -15013,6 +15029,7 @@ class WebSocketStage(
             stage_name=stage_name,
             web_socket_api=web_socket_api,
             auto_deploy=auto_deploy,
+            description=description,
             domain_mapping=domain_mapping,
             throttle=throttle,
         )
@@ -15200,6 +15217,7 @@ class WebSocketStageAttributes(StageAttributes):
     jsii_struct_bases=[StageOptions],
     name_mapping={
         "auto_deploy": "autoDeploy",
+        "description": "description",
         "domain_mapping": "domainMapping",
         "throttle": "throttle",
         "stage_name": "stageName",
@@ -15211,6 +15229,7 @@ class WebSocketStageProps(StageOptions):
         self,
         *,
         auto_deploy: typing.Optional[builtins.bool] = None,
+        description: typing.Optional[builtins.str] = None,
         domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
         stage_name: builtins.str,
@@ -15219,6 +15238,7 @@ class WebSocketStageProps(StageOptions):
         '''Properties to initialize an instance of ``WebSocketStage``.
 
         :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
+        :param description: The description for the API stage. Default: - no description
         :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
         :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
         :param stage_name: The name of the stage.
@@ -15230,22 +15250,18 @@ class WebSocketStageProps(StageOptions):
 
             from aws_cdk.aws_apigatewayv2_integrations import WebSocketLambdaIntegration
             
-            # connect_handler: lambda.Function
-            # disconnect_handler: lambda.Function
-            # default_handler: lambda.Function
-            
+            # message_handler: lambda.Function
             
-            web_socket_api = apigwv2.WebSocketApi(self, "mywsapi",
-                connect_route_options=apigwv2.WebSocketRouteOptions(integration=WebSocketLambdaIntegration("ConnectIntegration", connect_handler)),
-                disconnect_route_options=apigwv2.WebSocketRouteOptions(integration=WebSocketLambdaIntegration("DisconnectIntegration", disconnect_handler)),
-                default_route_options=apigwv2.WebSocketRouteOptions(integration=WebSocketLambdaIntegration("DefaultIntegration", default_handler))
-            )
             
+            web_socket_api = apigwv2.WebSocketApi(self, "mywsapi")
             apigwv2.WebSocketStage(self, "mystage",
                 web_socket_api=web_socket_api,
                 stage_name="dev",
                 auto_deploy=True
             )
+            web_socket_api.add_route("sendMessage",
+                integration=WebSocketLambdaIntegration("SendMessageIntegration", message_handler)
+            )
         '''
         if isinstance(domain_mapping, dict):
             domain_mapping = DomainMappingOptions(**domain_mapping)
@@ -15254,6 +15270,7 @@ class WebSocketStageProps(StageOptions):
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__42c328a8780899b5d1949986febb2d9e9b3f4f2f6b8e4f03561cb02e5b407e77)
             check_type(argname="argument auto_deploy", value=auto_deploy, expected_type=type_hints["auto_deploy"])
+            check_type(argname="argument description", value=description, expected_type=type_hints["description"])
             check_type(argname="argument domain_mapping", value=domain_mapping, expected_type=type_hints["domain_mapping"])
             check_type(argname="argument throttle", value=throttle, expected_type=type_hints["throttle"])
             check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
@@ -15264,6 +15281,8 @@ class WebSocketStageProps(StageOptions):
         }
         if auto_deploy is not None:
             self._values["auto_deploy"] = auto_deploy
+        if description is not None:
+            self._values["description"] = description
         if domain_mapping is not None:
             self._values["domain_mapping"] = domain_mapping
         if throttle is not None:
@@ -15278,6 +15297,15 @@ class WebSocketStageProps(StageOptions):
         result = self._values.get("auto_deploy")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def description(self) -> typing.Optional[builtins.str]:
+        '''The description for the API stage.
+
+        :default: - no description
+        '''
+        result = self._values.get("description")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def domain_mapping(self) -> typing.Optional[DomainMappingOptions]:
         '''The options for custom domain and api mapping.
@@ -16011,6 +16039,7 @@ class HttpApi(
         *,
         stage_name: typing.Optional[builtins.str] = None,
         auto_deploy: typing.Optional[builtins.bool] = None,
+        description: typing.Optional[builtins.str] = None,
         domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
     ) -> "HttpStage":
@@ -16019,6 +16048,7 @@ class HttpApi(
         :param id: -
         :param stage_name: The name of the stage. See ``StageName`` class for more details. Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.
         :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
+        :param description: The description for the API stage. Default: - no description
         :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
         :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
         '''
@@ -16028,6 +16058,7 @@ class HttpApi(
         options = HttpStageOptions(
             stage_name=stage_name,
             auto_deploy=auto_deploy,
+            description=description,
             domain_mapping=domain_mapping,
             throttle=throttle,
         )
@@ -16674,6 +16705,7 @@ class HttpStageAttributes(StageAttributes):
     jsii_struct_bases=[StageOptions],
     name_mapping={
         "auto_deploy": "autoDeploy",
+        "description": "description",
         "domain_mapping": "domainMapping",
         "throttle": "throttle",
         "stage_name": "stageName",
@@ -16684,6 +16716,7 @@ class HttpStageOptions(StageOptions):
         self,
         *,
         auto_deploy: typing.Optional[builtins.bool] = None,
+        description: typing.Optional[builtins.str] = None,
         domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
         stage_name: typing.Optional[builtins.str] = None,
@@ -16691,6 +16724,7 @@ class HttpStageOptions(StageOptions):
         '''The options to create a new Stage for an HTTP API.
 
         :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
+        :param description: The description for the API stage. Default: - no description
         :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
         :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
         :param stage_name: The name of the stage. See ``StageName`` class for more details. Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.
@@ -16720,12 +16754,15 @@ class HttpStageOptions(StageOptions):
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__70c0bb0779b1636661ab1c2d695953c6dda7a5247d18a4bd7e045cc96d717a8a)
             check_type(argname="argument auto_deploy", value=auto_deploy, expected_type=type_hints["auto_deploy"])
+            check_type(argname="argument description", value=description, expected_type=type_hints["description"])
             check_type(argname="argument domain_mapping", value=domain_mapping, expected_type=type_hints["domain_mapping"])
             check_type(argname="argument throttle", value=throttle, expected_type=type_hints["throttle"])
             check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
         self._values: typing.Dict[builtins.str, typing.Any] = {}
         if auto_deploy is not None:
             self._values["auto_deploy"] = auto_deploy
+        if description is not None:
+            self._values["description"] = description
         if domain_mapping is not None:
             self._values["domain_mapping"] = domain_mapping
         if throttle is not None:
@@ -16742,6 +16779,15 @@ class HttpStageOptions(StageOptions):
         result = self._values.get("auto_deploy")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def description(self) -> typing.Optional[builtins.str]:
+        '''The description for the API stage.
+
+        :default: - no description
+        '''
+        result = self._values.get("description")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def domain_mapping(self) -> typing.Optional[DomainMappingOptions]:
         '''The options for custom domain and api mapping.
@@ -16788,6 +16834,7 @@ class HttpStageOptions(StageOptions):
     jsii_struct_bases=[HttpStageOptions],
     name_mapping={
         "auto_deploy": "autoDeploy",
+        "description": "description",
         "domain_mapping": "domainMapping",
         "throttle": "throttle",
         "stage_name": "stageName",
@@ -16799,6 +16846,7 @@ class HttpStageProps(HttpStageOptions):
         self,
         *,
         auto_deploy: typing.Optional[builtins.bool] = None,
+        description: typing.Optional[builtins.str] = None,
         domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
         stage_name: typing.Optional[builtins.str] = None,
@@ -16807,6 +16855,7 @@ class HttpStageProps(HttpStageOptions):
         '''Properties to initialize an instance of ``HttpStage``.
 
         :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
+        :param description: The description for the API stage. Default: - no description
         :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
         :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
         :param stage_name: The name of the stage. See ``StageName`` class for more details. Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.
@@ -16821,7 +16870,8 @@ class HttpStageProps(HttpStageOptions):
             
             apigwv2.HttpStage(self, "Stage",
                 http_api=api,
-                stage_name="beta"
+                stage_name="beta",
+                description="My Stage"
             )
         '''
         if isinstance(domain_mapping, dict):
@@ -16831,6 +16881,7 @@ class HttpStageProps(HttpStageOptions):
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__77d8b0adbb783021a6c7e33999d2a3a80e2414824d202954599bb4ad7f291721)
             check_type(argname="argument auto_deploy", value=auto_deploy, expected_type=type_hints["auto_deploy"])
+            check_type(argname="argument description", value=description, expected_type=type_hints["description"])
             check_type(argname="argument domain_mapping", value=domain_mapping, expected_type=type_hints["domain_mapping"])
             check_type(argname="argument throttle", value=throttle, expected_type=type_hints["throttle"])
             check_type(argname="argument stage_name", value=stage_name, expected_type=type_hints["stage_name"])
@@ -16840,6 +16891,8 @@ class HttpStageProps(HttpStageOptions):
         }
         if auto_deploy is not None:
             self._values["auto_deploy"] = auto_deploy
+        if description is not None:
+            self._values["description"] = description
         if domain_mapping is not None:
             self._values["domain_mapping"] = domain_mapping
         if throttle is not None:
@@ -16856,6 +16909,15 @@ class HttpStageProps(HttpStageOptions):
         result = self._values.get("auto_deploy")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def description(self) -> typing.Optional[builtins.str]:
+        '''The description for the API stage.
+
+        :default: - no description
+        '''
+        result = self._values.get("description")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def domain_mapping(self) -> typing.Optional[DomainMappingOptions]:
         '''The options for custom domain and api mapping.
@@ -17716,7 +17778,8 @@ class HttpStage(
         
         apigwv2.HttpStage(self, "Stage",
             http_api=api,
-            stage_name="beta"
+            stage_name="beta",
+            description="My Stage"
         )
     '''
 
@@ -17728,6 +17791,7 @@ class HttpStage(
         http_api: IHttpApi,
         stage_name: typing.Optional[builtins.str] = None,
         auto_deploy: typing.Optional[builtins.bool] = None,
+        description: typing.Optional[builtins.str] = None,
         domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
     ) -> None:
@@ -17737,6 +17801,7 @@ class HttpStage(
         :param http_api: The HTTP API to which this stage is associated.
         :param stage_name: The name of the stage. See ``StageName`` class for more details. Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.
         :param auto_deploy: Whether updates to an API automatically trigger a new deployment. Default: false
+        :param description: The description for the API stage. Default: - no description
         :param domain_mapping: The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration
         :param throttle: Throttle settings for the routes of this stage. Default: - no throttling configuration
         '''
@@ -17748,6 +17813,7 @@ class HttpStage(
             http_api=http_api,
             stage_name=stage_name,
             auto_deploy=auto_deploy,
+            description=description,
             domain_mapping=domain_mapping,
             throttle=throttle,
         )
@@ -19936,6 +20002,7 @@ def _typecheckingstub__6e40657661365d1f987be571ab8023633c7e4116f50e9a7122d3a476e
 def _typecheckingstub__7d1ab9a2efdde27ab3aff279b986e4a558573396d5100c22c5a48bcbee4f320a(
     *,
     auto_deploy: typing.Optional[builtins.bool] = None,
+    description: typing.Optional[builtins.str] = None,
     domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
 ) -> None:
@@ -20259,6 +20326,7 @@ def _typecheckingstub__64b576b4eaac9e08a38566f9968efb8de351df1daf6fe46d0fe7787da
     stage_name: builtins.str,
     web_socket_api: IWebSocketApi,
     auto_deploy: typing.Optional[builtins.bool] = None,
+    description: typing.Optional[builtins.str] = None,
     domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
 ) -> None:
@@ -20307,6 +20375,7 @@ def _typecheckingstub__66ef15ad422b243bd7d761fe83ba5889c94c75b085fc8898f13f5fdbd
 def _typecheckingstub__42c328a8780899b5d1949986febb2d9e9b3f4f2f6b8e4f03561cb02e5b407e77(
     *,
     auto_deploy: typing.Optional[builtins.bool] = None,
+    description: typing.Optional[builtins.str] = None,
     domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
     stage_name: builtins.str,
@@ -20418,6 +20487,7 @@ def _typecheckingstub__f8917ad3a680cbc2c8ade65728d8549bf69f03ea4c9d0752e5dae7263
     *,
     stage_name: typing.Optional[builtins.str] = None,
     auto_deploy: typing.Optional[builtins.bool] = None,
+    description: typing.Optional[builtins.str] = None,
     domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
 ) -> None:
@@ -20486,6 +20556,7 @@ def _typecheckingstub__14605c3383d1d699194e37511d84f3f4da8c64b724b0eacc42f7bff95
 def _typecheckingstub__70c0bb0779b1636661ab1c2d695953c6dda7a5247d18a4bd7e045cc96d717a8a(
     *,
     auto_deploy: typing.Optional[builtins.bool] = None,
+    description: typing.Optional[builtins.str] = None,
     domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
     stage_name: typing.Optional[builtins.str] = None,
@@ -20496,6 +20567,7 @@ def _typecheckingstub__70c0bb0779b1636661ab1c2d695953c6dda7a5247d18a4bd7e045cc96
 def _typecheckingstub__77d8b0adbb783021a6c7e33999d2a3a80e2414824d202954599bb4ad7f291721(
     *,
     auto_deploy: typing.Optional[builtins.bool] = None,
+    description: typing.Optional[builtins.str] = None,
     domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
     stage_name: typing.Optional[builtins.str] = None,
@@ -20560,6 +20632,7 @@ def _typecheckingstub__4573d7530f36463b1b12875197f2c49f968925d114c4ed7ac6b9ab04e
     http_api: IHttpApi,
     stage_name: typing.Optional[builtins.str] = None,
     auto_deploy: typing.Optional[builtins.bool] = None,
+    description: typing.Optional[builtins.str] = None,
     domain_mapping: typing.Optional[typing.Union[DomainMappingOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     throttle: typing.Optional[typing.Union[ThrottleSettings, typing.Dict[builtins.str, typing.Any]]] = None,
 ) -> None:

{aws-cdk-lib-2.149.0 → aws-cdk-lib-2.151.0}/src/aws_cdk/aws_appconfig/__init__.py

@@ -9785,7 +9785,7 @@ class SourcedConfiguration(
         :param scope: -
         :param id: -
         :param location: The location where the configuration is stored.
-        :param retrieval_role: The IAM role to retrieve the configuration. Default: - A role is generated.
+        :param retrieval_role: The IAM role to retrieve the configuration. Default: - Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.
         :param version_number: The version number of the sourced configuration to deploy. If this is not specified, then there will be no deployment. Default: - None.
         :param application: The application associated with the configuration.
         :param deployment_key: The deployment key of the configuration. Default: - None.
@@ -10458,7 +10458,7 @@ class SourcedConfigurationProps(ConfigurationProps):
         :param validators: The validators for the configuration. Default: - No validators.
         :param application: The application associated with the configuration.
         :param location: The location where the configuration is stored.
-        :param retrieval_role: The IAM role to retrieve the configuration. Default: - A role is generated.
+        :param retrieval_role: The IAM role to retrieve the configuration. Default: - Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.
         :param version_number: The version number of the sourced configuration to deploy. If this is not specified, then there will be no deployment. Default: - None.
 
         :exampleMetadata: infused
@@ -10603,7 +10603,7 @@ class SourcedConfigurationProps(ConfigurationProps):
     def retrieval_role(self) -> typing.Optional[_IRole_235f5d8e]:
         '''The IAM role to retrieve the configuration.
 
-        :default: - A role is generated.
+        :default: - Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.
         '''
         result = self._values.get("retrieval_role")
         return typing.cast(typing.Optional[_IRole_235f5d8e], result)

{aws-cdk-lib-2.149.0 → aws-cdk-lib-2.151.0}/src/aws_cdk/aws_backup/__init__.py

@@ -3451,7 +3451,7 @@ class CfnBackupVault(
         '''
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
-        :param backup_vault_name: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
+        :param backup_vault_name: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
         :param access_policy: A resource-based policy that is used to manage access permissions on the target backup vault.
         :param backup_vault_tags: The tags to assign to the backup vault.
         :param encryption_key_arn: A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management; for example, ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default. To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see `Encryption for backups in AWS Backup <https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html>`_
@@ -3845,7 +3845,7 @@ class CfnBackupVaultProps:
     ) -> None:
         '''Properties for defining a ``CfnBackupVault``.
 
-        :param backup_vault_name: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
+        :param backup_vault_name: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
         :param access_policy: A resource-based policy that is used to manage access permissions on the target backup vault.
         :param backup_vault_tags: The tags to assign to the backup vault.
         :param encryption_key_arn: A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management; for example, ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default. To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see `Encryption for backups in AWS Backup <https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html>`_
@@ -3911,7 +3911,7 @@ class CfnBackupVaultProps:
     def backup_vault_name(self) -> builtins.str:
         '''The name of a logical container where backups are stored.
 
-        Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
+        Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaultname
         '''