aws-cdk-lib 2.75.1__py3-none-any.whl → 2.76.0__py3-none-any.whl

aws_cdk/aws_ssm/__init__.py

@@ -9,7 +9,8 @@ You can reference existing SSM Parameter Store values that you want to use in
 your CDK app by using `ssm.StringParameter.fromStringParameterAttributes`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
+parameter_version = Token.as_number({"Ref": "MyParameter"})
+
 # Retrieve the latest value of the non-secret parameter
 # with name "/My/String/Parameter".
 string_value = ssm.StringParameter.from_string_parameter_attributes(self, "MyValue",
@@ -38,15 +39,13 @@ You can also reference an existing SSM Parameter Store value that matches an
 [AWS specific parameter type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-specific-parameter-types):
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-ssm.StringParameter.value_for_typed_string_parameter_v2(stack, "/My/Public/Parameter", ssm.ParameterValueType.AWS_EC2_IMAGE_ID)
+ssm.StringParameter.value_for_typed_string_parameter_v2(self, "/My/Public/Parameter", ssm.ParameterValueType.AWS_EC2_IMAGE_ID)
 ```
 
 To do the same for a SSM Parameter Store value that is stored as a list:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-ssm.StringListParameter.value_for_typed_list_parameter(stack, "/My/Public/Parameter", ssm.ParameterValueType.AWS_EC2_IMAGE_ID)
+ssm.StringListParameter.value_for_typed_list_parameter(self, "/My/Public/Parameter", ssm.ParameterValueType.AWS_EC2_IMAGE_ID)
 ```
 
 ### Lookup existing parameters
@@ -55,8 +54,7 @@ You can also use an existing parameter by looking up the parameter from the AWS
 This method uses AWS API calls to lookup the value from SSM during synthesis.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-string_value = ssm.StringParameter.value_from_lookup(stack, "/My/Public/Parameter")
+string_value = ssm.StringParameter.value_from_lookup(self, "/My/Public/Parameter")
 ```
 
 When using `valueFromLookup` an initial value of 'dummy-value-for-${parameterName}'
@@ -117,19 +115,18 @@ ssm.StringParameter(self, "Parameter",
 ```
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
+# Grant read access to some Role
+# role: iam.IRole
 # Create a new SSM Parameter holding a String
-param = ssm.StringParameter(stack, "StringParameter",
+param = ssm.StringParameter(self, "StringParameter",
     # description: 'Some user-friendly description',
     # name: 'ParameterName',
     string_value="Initial parameter value"
 )
-
-# Grant read access to some Role
 param.grant_read(role)
 
 # Create a new SSM Parameter holding a StringList
-list_parameter = ssm.StringListParameter(stack, "StringListParameter",
+list_parameter = ssm.StringListParameter(self, "StringListParameter",
     # description: 'Some user-friendly description',
     # name: 'ParameterName',
     string_list_value=["Initial parameter value A", "Initial parameter value B"]
@@ -8226,8 +8223,7 @@ class ParameterValueType(enum.Enum):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
-        ssm.StringParameter.value_for_typed_string_parameter_v2(stack, "/My/Public/Parameter", ssm.ParameterValueType.AWS_EC2_IMAGE_ID)
+        ssm.StringParameter.value_for_typed_string_parameter_v2(self, "/My/Public/Parameter", ssm.ParameterValueType.AWS_EC2_IMAGE_ID)
     '''
 
     STRING = "STRING"
@@ -8284,7 +8280,8 @@ class SecureStringParameterAttributes(CommonStringParameterAttributes):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
+            parameter_version = Token.as_number({"Ref": "MyParameter"})
+            
             # Retrieve the latest value of the non-secret parameter
             # with name "/My/String/Parameter".
             string_value = ssm.StringParameter.from_string_parameter_attributes(self, "MyValue",
@@ -8395,8 +8392,7 @@ class StringListParameter(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
-        ssm.StringListParameter.value_for_typed_list_parameter(stack, "/My/Public/Parameter", ssm.ParameterValueType.AWS_EC2_IMAGE_ID)
+        ssm.StringListParameter.value_for_typed_list_parameter(self, "/My/Public/Parameter", ssm.ParameterValueType.AWS_EC2_IMAGE_ID)
     '''
 
     def __init__(
@@ -8613,19 +8609,18 @@ class StringListParameterProps(ParameterOptions):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
+            # Grant read access to some Role
+            # role: iam.IRole
             # Create a new SSM Parameter holding a String
-            param = ssm.StringParameter(stack, "StringParameter",
+            param = ssm.StringParameter(self, "StringParameter",
                 # description: 'Some user-friendly description',
                 # name: 'ParameterName',
                 string_value="Initial parameter value"
             )
-            
-            # Grant read access to some Role
             param.grant_read(role)
             
             # Create a new SSM Parameter holding a StringList
-            list_parameter = ssm.StringListParameter(stack, "StringListParameter",
+            list_parameter = ssm.StringListParameter(self, "StringListParameter",
                 # description: 'Some user-friendly description',
                 # name: 'ParameterName',
                 string_list_value=["Initial parameter value A", "Initial parameter value B"]
@@ -9096,7 +9091,8 @@ class StringParameterAttributes(CommonStringParameterAttributes):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
+            parameter_version = Token.as_number({"Ref": "MyParameter"})
+            
             # Retrieve the latest value of the non-secret parameter
             # with name "/My/String/Parameter".
             string_value = ssm.StringParameter.from_string_parameter_attributes(self, "MyValue",

aws_cdk/aws_ssmcontacts/__init__.py

@@ -108,7 +108,7 @@ class CfnContact(
         :param id: - scoped id of the resource.
         :param alias: The unique and identifiable alias of the contact or escalation plan.
         :param display_name: The full name of the contact or escalation plan.
-        :param type: Refers to the type of contact. A single contact is type ``PERSONAL`` and an escalation plan is type ``ESCALATION`` .
+        :param type: Refers to the type of contact:. - ``PERSONAL`` : A single, individual contact. - ``ESCALATION`` : An escalation plan. - ``ONCALL_SCHEDULE`` : An on-call schedule.
         :param plan: A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
         '''
         if __debug__:
@@ -200,9 +200,11 @@ class CfnContact(
     @builtins.property
     @jsii.member(jsii_name="type")
     def type(self) -> builtins.str:
-        '''Refers to the type of contact.
+        '''Refers to the type of contact:.
 
-        A single contact is type ``PERSONAL`` and an escalation plan is type ``ESCALATION`` .
+        - ``PERSONAL`` : A single, individual contact.
+        - ``ESCALATION`` : An escalation plan.
+        - ``ONCALL_SCHEDULE`` : An on-call schedule.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-type
         '''
@@ -914,7 +916,7 @@ class CfnContactProps:
 
         :param alias: The unique and identifiable alias of the contact or escalation plan.
         :param display_name: The full name of the contact or escalation plan.
-        :param type: Refers to the type of contact. A single contact is type ``PERSONAL`` and an escalation plan is type ``ESCALATION`` .
+        :param type: Refers to the type of contact:. - ``PERSONAL`` : A single, individual contact. - ``ESCALATION`` : An escalation plan. - ``ONCALL_SCHEDULE`` : An on-call schedule.
         :param plan: A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html
@@ -985,9 +987,11 @@ class CfnContactProps:
 
     @builtins.property
     def type(self) -> builtins.str:
-        '''Refers to the type of contact.
+        '''Refers to the type of contact:.
 
-        A single contact is type ``PERSONAL`` and an escalation plan is type ``ESCALATION`` .
+        - ``PERSONAL`` : A single, individual contact.
+        - ``ESCALATION`` : An escalation plan.
+        - ``ONCALL_SCHEDULE`` : An on-call schedule.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-type
         '''

aws_cdk/aws_stepfunctions/__init__.py

@@ -554,8 +554,6 @@ Tasks are executed using the State Machine's execution role. In some cases, e.g.
 This can be achieved by providing the optional `credentials` property which allows using a fixed role or a json expression to resolve the role at runtime from the task's inputs.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-import aws_cdk.aws_iam as iam
 import aws_cdk.aws_lambda as lambda_
 
 # submit_lambda: lambda.Function
@@ -879,9 +877,9 @@ In addition, the StateMachine can be imported via the `StateMachine.fromStateMac
 ```python
 app = App()
 stack = Stack(app, "MyStack")
-sfn.StateMachine.from_state_machine_arn(stack, "ViaArnImportedStateMachine", "arn:aws:states:us-east-1:123456789012:stateMachine:StateMachine2E01A3A5-N5TJppzoevKQ")
+sfn.StateMachine.from_state_machine_arn(self, "ViaArnImportedStateMachine", "arn:aws:states:us-east-1:123456789012:stateMachine:StateMachine2E01A3A5-N5TJppzoevKQ")
 
-sfn.StateMachine.from_state_machine_name(stack, "ViaResourceNameImportedStateMachine", "StateMachine2E01A3A5-N5TJppzoevKQ")
+sfn.StateMachine.from_state_machine_name(self, "ViaResourceNameImportedStateMachine", "StateMachine2E01A3A5-N5TJppzoevKQ")
 ```
 '''
 import abc
@@ -3472,8 +3470,6 @@ class Credentials:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
-            import aws_cdk.aws_iam as iam
             import aws_cdk.aws_lambda as lambda_
             
             # submit_lambda: lambda.Function
@@ -6813,7 +6809,6 @@ class StateMachine(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         import aws_cdk.aws_stepfunctions as stepfunctions
         
         
@@ -7566,7 +7561,6 @@ class StateMachineProps:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             import aws_cdk.aws_stepfunctions as stepfunctions
             
             
@@ -8455,8 +8449,6 @@ class TaskRole(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
-        import aws_cdk.aws_iam as iam
         import aws_cdk.aws_lambda as lambda_
         
         # submit_lambda: lambda.Function
@@ -8500,8 +8492,7 @@ class TaskRole(
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
-            TaskRole.from_role_arn_json_path("$.RoleArn")
+            sfn.TaskRole.from_role_arn_json_path("$.RoleArn")
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__8f0576900770ad89340628b613309cb0873d7789836eb9f1f1a5eb5eea3129f9)

aws_cdk/aws_stepfunctions_tasks/__init__.py

@@ -180,8 +180,7 @@ tasks.CallApiGatewayRestApiEndpoint(self, "Endpoint",
 The `CallApiGatewayHttpApiEndpoint` calls the HTTP API endpoint.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-import aws_cdk.aws_apigatewayv2 as apigatewayv2
+import aws_cdk.aws_apigatewayv2_alpha as apigatewayv2
 
 http_api = apigatewayv2.HttpApi(self, "MyHttpApi")
 
@@ -315,7 +314,7 @@ The [SubmitJob](https://docs.aws.amazon.com/batch/latest/APIReference/API_Submit
 
 ```python
 # Example automatically generated from non-compiling source. May contain errors.
-import aws_cdk.aws_batch as batch
+import aws_cdk.aws_batch_alpha as batch
 # batch_job_definition: batch.JobDefinition
 # batch_queue: batch.JobQueue
 
@@ -3594,7 +3593,7 @@ class BatchSubmitJob(
     Example::
 
         # Example automatically generated from non-compiling source. May contain errors.
-        import aws_cdk.aws_batch as batch
+        import aws_cdk.aws_batch_alpha as batch
         # batch_job_definition: batch.JobDefinition
         # batch_queue: batch.JobQueue
         
@@ -3769,7 +3768,7 @@ class BatchSubmitJobProps(_TaskStateBaseProps_3a62b6d0):
         Example::
 
             # Example automatically generated from non-compiling source. May contain errors.
-            import aws_cdk.aws_batch as batch
+            import aws_cdk.aws_batch_alpha as batch
             # batch_job_definition: batch.JobDefinition
             # batch_queue: batch.JobQueue
             
@@ -4465,8 +4464,7 @@ class CallApiGatewayHttpApiEndpoint(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
-        import aws_cdk.aws_apigatewayv2 as apigatewayv2
+        import aws_cdk.aws_apigatewayv2_alpha as apigatewayv2
         
         http_api = apigatewayv2.HttpApi(self, "MyHttpApi")
         
@@ -4664,8 +4662,7 @@ class CallApiGatewayHttpApiEndpointProps(CallApiGatewayEndpointBaseProps):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
-            import aws_cdk.aws_apigatewayv2 as apigatewayv2
+            import aws_cdk.aws_apigatewayv2_alpha as apigatewayv2
             
             http_api = apigatewayv2.HttpApi(self, "MyHttpApi")
             
@@ -4981,7 +4978,6 @@ class CallApiGatewayRestApiEndpoint(
     in the headers field ``WAIT_FOR_TASK_TOKEN`` integration, use
     ``JsonPath.array()`` to wrap the token in an array::
 
-       # Example automatically generated from non-compiling source. May contain errors.
        import aws_cdk.aws_apigateway as apigateway
        # api: apigateway.RestApi
 
@@ -20731,8 +20727,7 @@ class HttpMethod(enum.Enum):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
-        import aws_cdk.aws_apigatewayv2 as apigatewayv2
+        import aws_cdk.aws_apigatewayv2_alpha as apigatewayv2
         
         http_api = apigatewayv2.HttpApi(self, "MyHttpApi")
         

aws_cdk/aws_timestream/__init__.py

@@ -2302,9 +2302,8 @@ class CfnTable(
             *,
             s3_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnTable.S3ConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
         ) -> None:
-            '''The location to write error reports for records rejected, asynchronously, during magnetic store writes.
-
-            :param s3_configuration: Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
+            '''
+            :param s3_configuration: ``CfnTable.MagneticStoreRejectedDataLocationProperty.S3Configuration``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html
             :exampleMetadata: fixture=_generated
@@ -2337,7 +2336,7 @@ class CfnTable(
         def s3_configuration(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTable.S3ConfigurationProperty"]]:
-            '''Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.
+            '''``CfnTable.MagneticStoreRejectedDataLocationProperty.S3Configuration``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html#cfn-timestream-table-magneticstorerejecteddatalocation-s3configuration
             '''
@@ -2370,10 +2369,9 @@ class CfnTable(
             enable_magnetic_store_writes: typing.Union[builtins.bool, _IResolvable_da3f097b],
             magnetic_store_rejected_data_location: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnTable.MagneticStoreRejectedDataLocationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
         ) -> None:
-            '''The set of properties on a table for configuring magnetic store writes.
-
-            :param enable_magnetic_store_writes: A flag to enable magnetic store writes.
-            :param magnetic_store_rejected_data_location: The location to write error reports for records rejected asynchronously during magnetic store writes.
+            '''
+            :param enable_magnetic_store_writes: ``CfnTable.MagneticStoreWritePropertiesProperty.EnableMagneticStoreWrites``.
+            :param magnetic_store_rejected_data_location: ``CfnTable.MagneticStoreWritePropertiesProperty.MagneticStoreRejectedDataLocation``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorewriteproperties.html
             :exampleMetadata: fixture=_generated
@@ -2414,7 +2412,7 @@ class CfnTable(
         def enable_magnetic_store_writes(
             self,
         ) -> typing.Union[builtins.bool, _IResolvable_da3f097b]:
-            '''A flag to enable magnetic store writes.
+            '''``CfnTable.MagneticStoreWritePropertiesProperty.EnableMagneticStoreWrites``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorewriteproperties.html#cfn-timestream-table-magneticstorewriteproperties-enablemagneticstorewrites
             '''
@@ -2426,7 +2424,7 @@ class CfnTable(
         def magnetic_store_rejected_data_location(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTable.MagneticStoreRejectedDataLocationProperty"]]:
-            '''The location to write error reports for records rejected asynchronously during magnetic store writes.
+            '''``CfnTable.MagneticStoreWritePropertiesProperty.MagneticStoreRejectedDataLocation``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorewriteproperties.html#cfn-timestream-table-magneticstorewriteproperties-magneticstorerejecteddatalocation
             '''
@@ -2459,10 +2457,9 @@ class CfnTable(
             magnetic_store_retention_period_in_days: typing.Optional[builtins.str] = None,
             memory_store_retention_period_in_hours: typing.Optional[builtins.str] = None,
         ) -> None:
-            '''Retention properties contain the duration for which your time-series data must be stored in the magnetic store and the memory store.
-
-            :param magnetic_store_retention_period_in_days: The duration for which data must be stored in the magnetic store.
-            :param memory_store_retention_period_in_hours: The duration for which data must be stored in the memory store.
+            '''
+            :param magnetic_store_retention_period_in_days: ``CfnTable.RetentionPropertiesProperty.MagneticStoreRetentionPeriodInDays``.
+            :param memory_store_retention_period_in_hours: ``CfnTable.RetentionPropertiesProperty.MemoryStoreRetentionPeriodInHours``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-retentionproperties.html
             :exampleMetadata: fixture=_generated
@@ -2492,7 +2489,7 @@ class CfnTable(
         def magnetic_store_retention_period_in_days(
             self,
         ) -> typing.Optional[builtins.str]:
-            '''The duration for which data must be stored in the magnetic store.
+            '''``CfnTable.RetentionPropertiesProperty.MagneticStoreRetentionPeriodInDays``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-retentionproperties.html#cfn-timestream-table-retentionproperties-magneticstoreretentionperiodindays
             '''
@@ -2503,7 +2500,7 @@ class CfnTable(
         def memory_store_retention_period_in_hours(
             self,
         ) -> typing.Optional[builtins.str]:
-            '''The duration for which data must be stored in the memory store.
+            '''``CfnTable.RetentionPropertiesProperty.MemoryStoreRetentionPeriodInHours``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-retentionproperties.html#cfn-timestream-table-retentionproperties-memorystoreretentionperiodinhours
             '''
@@ -2540,12 +2537,11 @@ class CfnTable(
             kms_key_id: typing.Optional[builtins.str] = None,
             object_key_prefix: typing.Optional[builtins.str] = None,
         ) -> None:
-            '''The configuration that specifies an S3 location.
-
-            :param bucket_name: The bucket name of the customer S3 bucket.
-            :param encryption_option: The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or AWS managed key.
-            :param kms_key_id: The AWS KMS key ID for the customer S3 location when encrypting with an AWS managed key.
-            :param object_key_prefix: The object key preview for the customer S3 location.
+            '''
+            :param bucket_name: ``CfnTable.S3ConfigurationProperty.BucketName``.
+            :param encryption_option: ``CfnTable.S3ConfigurationProperty.EncryptionOption``.
+            :param kms_key_id: ``CfnTable.S3ConfigurationProperty.KmsKeyId``.
+            :param object_key_prefix: ``CfnTable.S3ConfigurationProperty.ObjectKeyPrefix``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html
             :exampleMetadata: fixture=_generated
@@ -2582,7 +2578,7 @@ class CfnTable(
 
         @builtins.property
         def bucket_name(self) -> builtins.str:
-            '''The bucket name of the customer S3 bucket.
+            '''``CfnTable.S3ConfigurationProperty.BucketName``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-bucketname
             '''
@@ -2592,9 +2588,7 @@ class CfnTable(
 
         @builtins.property
         def encryption_option(self) -> builtins.str:
-            '''The encryption option for the customer S3 location.
-
-            Options are S3 server-side encryption with an S3 managed key or AWS managed key.
+            '''``CfnTable.S3ConfigurationProperty.EncryptionOption``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-encryptionoption
             '''
@@ -2604,7 +2598,7 @@ class CfnTable(
 
         @builtins.property
         def kms_key_id(self) -> typing.Optional[builtins.str]:
-            '''The AWS KMS key ID for the customer S3 location when encrypting with an AWS managed key.
+            '''``CfnTable.S3ConfigurationProperty.KmsKeyId``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-kmskeyid
             '''
@@ -2613,7 +2607,7 @@ class CfnTable(
 
         @builtins.property
         def object_key_prefix(self) -> typing.Optional[builtins.str]:
-            '''The object key preview for the customer S3 location.
+            '''``CfnTable.S3ConfigurationProperty.ObjectKeyPrefix``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html#cfn-timestream-table-s3configuration-objectkeyprefix
             '''

aws_cdk/aws_xray/__init__.py

@@ -502,8 +502,6 @@ class CfnResourcePolicy(
 ):
     '''A CloudFormation ``AWS::XRay::ResourcePolicy``.
 
-    Sets the resource policy to grant one or more AWS services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific AWS account. Each AWS account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.
-
     :cloudformationResource: AWS::XRay::ResourcePolicy
     :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html
     :exampleMetadata: fixture=_generated
@@ -536,8 +534,8 @@ class CfnResourcePolicy(
 
         :param scope: - scope in which this resource is defined.
         :param id: - scoped id of the resource.
-        :param policy_document: The resource policy document, which can be up to 5kb in size.
-        :param policy_name: The name of the resource policy. Must be unique within a specific AWS account.
+        :param policy_document: ``AWS::XRay::ResourcePolicy.PolicyDocument``.
+        :param policy_name: ``AWS::XRay::ResourcePolicy.PolicyName``.
         :param bypass_policy_lockout_check: ``AWS::XRay::ResourcePolicy.BypassPolicyLockoutCheck``.
         '''
         if __debug__:
@@ -590,7 +588,7 @@ class CfnResourcePolicy(
     @builtins.property
     @jsii.member(jsii_name="policyDocument")
     def policy_document(self) -> builtins.str:
-        '''The resource policy document, which can be up to 5kb in size.
+        '''``AWS::XRay::ResourcePolicy.PolicyDocument``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policydocument
         '''
@@ -606,9 +604,7 @@ class CfnResourcePolicy(
     @builtins.property
     @jsii.member(jsii_name="policyName")
     def policy_name(self) -> builtins.str:
-        '''The name of the resource policy.
-
-        Must be unique within a specific AWS account.
+        '''``AWS::XRay::ResourcePolicy.PolicyName``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policyname
         '''
@@ -662,8 +658,8 @@ class CfnResourcePolicyProps:
     ) -> None:
         '''Properties for defining a ``CfnResourcePolicy``.
 
-        :param policy_document: The resource policy document, which can be up to 5kb in size.
-        :param policy_name: The name of the resource policy. Must be unique within a specific AWS account.
+        :param policy_document: ``AWS::XRay::ResourcePolicy.PolicyDocument``.
+        :param policy_name: ``AWS::XRay::ResourcePolicy.PolicyName``.
         :param bypass_policy_lockout_check: ``AWS::XRay::ResourcePolicy.BypassPolicyLockoutCheck``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html
@@ -697,7 +693,7 @@ class CfnResourcePolicyProps:
 
     @builtins.property
     def policy_document(self) -> builtins.str:
-        '''The resource policy document, which can be up to 5kb in size.
+        '''``AWS::XRay::ResourcePolicy.PolicyDocument``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policydocument
         '''
@@ -707,9 +703,7 @@ class CfnResourcePolicyProps:
 
     @builtins.property
     def policy_name(self) -> builtins.str:
-        '''The name of the resource policy.
-
-        Must be unique within a specific AWS account.
+        '''``AWS::XRay::ResourcePolicy.PolicyName``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policyname
         '''
@@ -1293,11 +1287,10 @@ class CfnSamplingRule(
             modified_at: typing.Optional[builtins.str] = None,
             sampling_rule: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnSamplingRule.SamplingRuleProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
         ) -> None:
-            '''A `SamplingRule <https://docs.aws.amazon.com//xray/latest/api/API_SamplingRule.html>`_ and its metadata.
-
-            :param created_at: When the rule was created, in Unix time seconds.
-            :param modified_at: When the rule was last modified, in Unix time seconds.
-            :param sampling_rule: The sampling rule.
+            '''
+            :param created_at: ``CfnSamplingRule.SamplingRuleRecordProperty.CreatedAt``.
+            :param modified_at: ``CfnSamplingRule.SamplingRuleRecordProperty.ModifiedAt``.
+            :param sampling_rule: ``CfnSamplingRule.SamplingRuleRecordProperty.SamplingRule``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html
             :exampleMetadata: fixture=_generated
@@ -1345,7 +1338,7 @@ class CfnSamplingRule(
 
         @builtins.property
         def created_at(self) -> typing.Optional[builtins.str]:
-            '''When the rule was created, in Unix time seconds.
+            '''``CfnSamplingRule.SamplingRuleRecordProperty.CreatedAt``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-createdat
             '''
@@ -1354,7 +1347,7 @@ class CfnSamplingRule(
 
         @builtins.property
         def modified_at(self) -> typing.Optional[builtins.str]:
-            '''When the rule was last modified, in Unix time seconds.
+            '''``CfnSamplingRule.SamplingRuleRecordProperty.ModifiedAt``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-modifiedat
             '''
@@ -1365,7 +1358,7 @@ class CfnSamplingRule(
         def sampling_rule(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSamplingRule.SamplingRuleProperty"]]:
-            '''The sampling rule.
+            '''``CfnSamplingRule.SamplingRuleRecordProperty.SamplingRule``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html#cfn-xray-samplingrule-samplingrulerecord-samplingrule
             '''

aws_cdk/cloud_assembly_schema/__init__.py

@@ -1686,7 +1686,6 @@ class ContainerImageAssetCacheOption:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             "registry"
         '''
         result = self._values.get("type")
@@ -1703,8 +1702,13 @@ class ContainerImageAssetCacheOption:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
-            ref: `12345678.dkr.ecr.us-west-2.amazonaws.com/cache:${branch}`, mode"max"
+            # branch: str
+            
+            
+            params = {
+                "ref": f"12345678.dkr.ecr.us-west-2.amazonaws.com/cache:{branch}",
+                "mode": "max"
+            }
         '''
         result = self._values.get("params")
         return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], result)
@@ -3842,7 +3846,6 @@ class DockerCacheOption:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             "registry"
         '''
         result = self._values.get("type")
@@ -3859,8 +3862,13 @@ class DockerCacheOption:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
-            ref: `12345678.dkr.ecr.us-west-2.amazonaws.com/cache:${branch}`, mode"max"
+            # branch: str
+            
+            
+            params = {
+                "ref": f"12345678.dkr.ecr.us-west-2.amazonaws.com/cache:{branch}",
+                "mode": "max"
+            }
         '''
         result = self._values.get("params")
         return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], result)

aws_cdk/custom_resources/__init__.py

@@ -535,12 +535,11 @@ Additionally, the Lambda function can be placed in a private VPC by using the `v
 and `vpcSubnets` properties.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-# my_vpc: ec2.Vpc
+# vpc: ec2.Vpc
 
 cr.AwsCustomResource(self, "CustomizedInVpc",
     vpc=vpc,
-    vpc_subnets=SubnetSelection(subnet_type=ec2.SubnetType.PRIVATE_NAT),
+    vpc_subnets=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PRIVATE_WITH_EGRESS),
     policy=cr.AwsCustomResourcePolicy.from_sdk_calls(
         resources=cr.AwsCustomResourcePolicy.ANY_RESOURCE
     )