aws-cdk-lib 2.147.3__py3-none-any.whl → 2.148.1__py3-none-any.whl

aws_cdk/aws_ssm/__init__.py

@@ -1,4 +1,4 @@
-'''
+r'''
 # AWS Systems Manager Construct Library
 
 This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
@@ -136,6 +136,37 @@ list_parameter = ssm.StringListParameter(self, "StringListParameter",
 When specifying an `allowedPattern`, the values provided as string literals
 are validated against the pattern and an exception is raised if a value
 provided does not comply.
+
+## Using Tokens in parameter name
+
+When using [CDK Tokens](https://docs.aws.amazon.com/cdk/v2/guide/tokens.html) in parameter name,
+you need to explicitly set the `simpleName` property. Setting `simpleName` to an incorrect boolean
+value may result in unexpected behaviours, such as having duplicate '/' in the parameter ARN
+or missing a '/' in the parameter ARN.
+
+`simpleName` is used to indicates whether the parameter name is a simple name. A parameter name
+without any '/' is considered a simple name, thus you should set `simpleName` to `true`.
+If the parameter name includes '/', set `simpleName` to `false`.
+
+```python
+import aws_cdk.aws_lambda as lambda_
+
+# func: lambda.IFunction
+
+
+simple_parameter = ssm.StringParameter(self, "StringParameter",
+    # the parameter name doesn't contain any '/'
+    parameter_name="parameter",
+    string_value="SOME_VALUE",
+    simple_name=True
+)
+non_simple_parameter = ssm.StringParameter(self, "StringParameter",
+    # the parameter name contains '/'
+    parameter_name=f"/{func.functionName}/my/app/param",
+    string_value="SOME_VALUE",
+    simple_name=False
+)
+```
 '''
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
@@ -6358,7 +6389,7 @@ class CfnResourceDataSync(
         '''
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
-        :param sync_name: 
+        :param sync_name: A name for the resource data sync.
         :param bucket_name: The name of the S3 bucket where the aggregated data is stored.
         :param bucket_prefix: An Amazon S3 prefix for the bucket.
         :param bucket_region: The AWS Region with the S3 bucket targeted by the resource data sync.
@@ -6433,6 +6464,7 @@ class CfnResourceDataSync(
     @builtins.property
     @jsii.member(jsii_name="syncName")
     def sync_name(self) -> builtins.str:
+        '''A name for the resource data sync.'''
         return typing.cast(builtins.str, jsii.get(self, "syncName"))
 
     @sync_name.setter
@@ -6917,7 +6949,7 @@ class CfnResourceDataSyncProps:
     ) -> None:
         '''Properties for defining a ``CfnResourceDataSync``.
 
-        :param sync_name: 
+        :param sync_name: A name for the resource data sync.
         :param bucket_name: The name of the S3 bucket where the aggregated data is stored.
         :param bucket_prefix: An Amazon S3 prefix for the bucket.
         :param bucket_region: The AWS Region with the S3 bucket targeted by the resource data sync.
@@ -7003,7 +7035,8 @@ class CfnResourceDataSyncProps:
 
     @builtins.property
     def sync_name(self) -> builtins.str:
-        '''
+        '''A name for the resource data sync.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname
         '''
         result = self._values.get("sync_name")
@@ -7320,7 +7353,7 @@ class CommonStringParameterAttributes:
         '''Common attributes for string parameters.
 
         :param parameter_name: The name of the parameter store value. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
 
         :exampleMetadata: fixture=_generated
 
@@ -7360,7 +7393,12 @@ class CommonStringParameterAttributes:
 
     @builtins.property
     def simple_name(self) -> typing.Optional[builtins.bool]:
-        '''Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
+        '''Indicates whether the parameter name is a simple name.
+
+        A parameter name
+        without any "/" is considered a simple name. If the parameter name includes
+        "/", setting simpleName to true might cause unintended issues such
+        as duplicate "/" in the resulting ARN.
 
         This is required only if ``parameterName`` is a token, which means we
         are unable to detect if the name is simple or "path-like" for the purpose
@@ -7595,7 +7633,7 @@ class ListParameterAttributes(CommonStringParameterAttributes):
         '''Attributes for parameters of string list type.
 
         :param parameter_name: The name of the parameter store value. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         :param element_type: The type of the string list parameter value. Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account. Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING Default: ParameterValueType.STRING
         :param version: The version number of the value you wish to retrieve. Default: The latest version will be retrieved.
 
@@ -7646,7 +7684,12 @@ class ListParameterAttributes(CommonStringParameterAttributes):
 
     @builtins.property
     def simple_name(self) -> typing.Optional[builtins.bool]:
-        '''Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
+        '''Indicates whether the parameter name is a simple name.
+
+        A parameter name
+        without any "/" is considered a simple name. If the parameter name includes
+        "/", setting simpleName to true might cause unintended issues such
+        as duplicate "/" in the resulting ARN.
 
         This is required only if ``parameterName`` is a token, which means we
         are unable to detect if the name is simple or "path-like" for the purpose
@@ -7736,7 +7779,7 @@ class ParameterOptions:
         :param allowed_pattern: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ``^\\d+$`` Default: no validation is performed
         :param description: Information about the parameter that you want to add to the system. Default: none
         :param parameter_name: The name of the parameter. Default: - a name will be generated by CloudFormation
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         :param tier: The tier of the string parameter. Default: - undefined
 
         :exampleMetadata: fixture=_generated
@@ -7806,7 +7849,12 @@ class ParameterOptions:
 
     @builtins.property
     def simple_name(self) -> typing.Optional[builtins.bool]:
-        '''Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
+        '''Indicates whether the parameter name is a simple name.
+
+        A parameter name
+        without any "/" is considered a simple name. If the parameter name includes
+        "/", setting simpleName to true might cause unintended issues such
+        as duplicate "/" in the resulting ARN.
 
         This is required only if ``parameterName`` is a token, which means we
         are unable to detect if the name is simple or "path-like" for the purpose
@@ -7963,7 +8011,7 @@ class SecureStringParameterAttributes(CommonStringParameterAttributes):
         '''Attributes for secure string parameters.
 
         :param parameter_name: The name of the parameter store value. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         :param encryption_key: The encryption key that is used to encrypt this parameter. Default: - default master key
         :param version: The version number of the value you wish to retrieve. Default: - AWS CloudFormation uses the latest version of the parameter
 
@@ -8025,7 +8073,12 @@ class SecureStringParameterAttributes(CommonStringParameterAttributes):
 
     @builtins.property
     def simple_name(self) -> typing.Optional[builtins.bool]:
-        '''Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
+        '''Indicates whether the parameter name is a simple name.
+
+        A parameter name
+        without any "/" is considered a simple name. If the parameter name includes
+        "/", setting simpleName to true might cause unintended issues such
+        as duplicate "/" in the resulting ARN.
 
         This is required only if ``parameterName`` is a token, which means we
         are unable to detect if the name is simple or "path-like" for the purpose
@@ -8105,7 +8158,7 @@ class StringListParameter(
         :param allowed_pattern: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ``^\\d+$`` Default: no validation is performed
         :param description: Information about the parameter that you want to add to the system. Default: none
         :param parameter_name: The name of the parameter. Default: - a name will be generated by CloudFormation
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         :param tier: The tier of the string parameter. Default: - undefined
         '''
         if __debug__:
@@ -8142,7 +8195,7 @@ class StringListParameter(
         :param element_type: The type of the string list parameter value. Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account. Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING Default: ParameterValueType.STRING
         :param version: The version number of the value you wish to retrieve. Default: The latest version will be retrieved.
         :param parameter_name: The name of the parameter store value. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__b477545ed5d53e5b666f41087db25aa6bdc347c4cead18a586bd16678f612801)
@@ -8292,7 +8345,7 @@ class StringListParameterProps(ParameterOptions):
         :param allowed_pattern: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ``^\\d+$`` Default: no validation is performed
         :param description: Information about the parameter that you want to add to the system. Default: none
         :param parameter_name: The name of the parameter. Default: - a name will be generated by CloudFormation
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         :param tier: The tier of the string parameter. Default: - undefined
         :param string_list_value: The values of the parameter. It may not reference another parameter and ``{{}}`` cannot be used in the value.
 
@@ -8371,7 +8424,12 @@ class StringListParameterProps(ParameterOptions):
 
     @builtins.property
     def simple_name(self) -> typing.Optional[builtins.bool]:
-        '''Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
+        '''Indicates whether the parameter name is a simple name.
+
+        A parameter name
+        without any "/" is considered a simple name. If the parameter name includes
+        "/", setting simpleName to true might cause unintended issues such
+        as duplicate "/" in the resulting ARN.
 
         This is required only if ``parameterName`` is a token, which means we
         are unable to detect if the name is simple or "path-like" for the purpose
@@ -8458,7 +8516,7 @@ class StringParameter(
         :param allowed_pattern: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ``^\\d+$`` Default: no validation is performed
         :param description: Information about the parameter that you want to add to the system. Default: none
         :param parameter_name: The name of the parameter. Default: - a name will be generated by CloudFormation
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         :param tier: The tier of the string parameter. Default: - undefined
         '''
         if __debug__:
@@ -8497,7 +8555,7 @@ class StringParameter(
         :param encryption_key: The encryption key that is used to encrypt this parameter. Default: - default master key
         :param version: The version number of the value you wish to retrieve. Default: - AWS CloudFormation uses the latest version of the parameter
         :param parameter_name: The name of the parameter store value. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__ef716b2d64b7c95b87119e190e88504880c3f46c45b769e05e9f4f805b08c63d)
@@ -8535,7 +8593,7 @@ class StringParameter(
         :param value_type: The type of the string parameter value. Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account. Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING Default: ParameterValueType.STRING
         :param version: The version number of the value you wish to retrieve. Default: The latest version will be retrieved.
         :param parameter_name: The name of the parameter store value. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__e612c2654654e8b8bb7821bcd1e47680b025862a2a411467ffa6334e46371b05)
@@ -8777,7 +8835,7 @@ class StringParameterAttributes(CommonStringParameterAttributes):
         '''Attributes for parameters of various types of string.
 
         :param parameter_name: The name of the parameter store value. This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         :param force_dynamic_reference: Use a dynamic reference as the representation in CloudFormation template level. By default, CDK tries to deduce an appropriate representation based on the parameter value (a CfnParameter or a dynamic reference). Use this flag to override the representation when it does not work. Default: false
         :param type: (deprecated) The type of the string parameter. Default: ParameterType.STRING
         :param value_type: The type of the string parameter value. Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account. Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING Default: ParameterValueType.STRING
@@ -8848,7 +8906,12 @@ class StringParameterAttributes(CommonStringParameterAttributes):
 
     @builtins.property
     def simple_name(self) -> typing.Optional[builtins.bool]:
-        '''Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
+        '''Indicates whether the parameter name is a simple name.
+
+        A parameter name
+        without any "/" is considered a simple name. If the parameter name includes
+        "/", setting simpleName to true might cause unintended issues such
+        as duplicate "/" in the resulting ARN.
 
         This is required only if ``parameterName`` is a token, which means we
         are unable to detect if the name is simple or "path-like" for the purpose
@@ -8958,7 +9021,7 @@ class StringParameterProps(ParameterOptions):
         :param allowed_pattern: A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ``^\\d+$`` Default: no validation is performed
         :param description: Information about the parameter that you want to add to the system. Default: none
         :param parameter_name: The name of the parameter. Default: - a name will be generated by CloudFormation
-        :param simple_name: Indicates if the parameter name is a simple name (i.e. does not include "/" separators). This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
+        :param simple_name: Indicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if ``parameterName`` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If ``parameterName`` is not specified, ``simpleName`` must be ``true`` (or undefined) since the name generated by AWS CloudFormation is always a simple name. Default: - auto-detect based on ``parameterName``
         :param tier: The tier of the string parameter. Default: - undefined
         :param string_value: The value of the parameter. It may not reference another parameter and ``{{}}`` cannot be used in the value.
         :param data_type: The data type of the parameter, such as ``text`` or ``aws:ec2:image``. Default: ParameterDataType.TEXT
@@ -8968,21 +9031,22 @@ class StringParameterProps(ParameterOptions):
 
         Example::
 
-            # Grant read access to some Role
-            # role: iam.IRole
-            # Create a new SSM Parameter holding a String
-            param = ssm.StringParameter(self, "StringParameter",
-                # description: 'Some user-friendly description',
-                # name: 'ParameterName',
-                string_value="Initial parameter value"
-            )
-            param.grant_read(role)
+            import aws_cdk.aws_lambda as lambda_
             
-            # Create a new SSM Parameter holding a StringList
-            list_parameter = ssm.StringListParameter(self, "StringListParameter",
-                # description: 'Some user-friendly description',
-                # name: 'ParameterName',
-                string_list_value=["Initial parameter value A", "Initial parameter value B"]
+            # func: lambda.IFunction
+            
+            
+            simple_parameter = ssm.StringParameter(self, "StringParameter",
+                # the parameter name doesn't contain any '/'
+                parameter_name="parameter",
+                string_value="SOME_VALUE",
+                simple_name=True
+            )
+            non_simple_parameter = ssm.StringParameter(self, "StringParameter",
+                # the parameter name contains '/'
+                parameter_name=f"/{func.functionName}/my/app/param",
+                string_value="SOME_VALUE",
+                simple_name=False
             )
         '''
         if __debug__:
@@ -9045,7 +9109,12 @@ class StringParameterProps(ParameterOptions):
 
     @builtins.property
     def simple_name(self) -> typing.Optional[builtins.bool]:
-        '''Indicates if the parameter name is a simple name (i.e. does not include "/" separators).
+        '''Indicates whether the parameter name is a simple name.
+
+        A parameter name
+        without any "/" is considered a simple name. If the parameter name includes
+        "/", setting simpleName to true might cause unintended issues such
+        as duplicate "/" in the resulting ARN.
 
         This is required only if ``parameterName`` is a token, which means we
         are unable to detect if the name is simple or "path-like" for the purpose

aws_cdk/aws_ssmcontacts/__init__.py

@@ -1,4 +1,4 @@
-'''
+r'''
 # AWS::SSMContacts Construct Library
 
 This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

aws_cdk/aws_ssmincidents/__init__.py

@@ -1,4 +1,4 @@
-'''
+r'''
 # AWS::SSMIncidents Construct Library
 
 This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

aws_cdk/aws_sso/__init__.py

@@ -1,4 +1,4 @@
-'''
+r'''
 # AWS::SSO Construct Library
 
 This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

aws_cdk/aws_stepfunctions/__init__.py

@@ -1,4 +1,4 @@
-'''
+r'''
 # AWS Step Functions Construct Library
 
 The `aws-cdk-lib/aws-stepfunctions` package contains constructs for building