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

aws_cdk/aws_dynamodb/__init__.py

@@ -224,7 +224,6 @@ table = dynamodb.Table(self, "Table",
 Alarms can be configured on the DynamoDB table to captured metric data
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 import aws_cdk.aws_cloudwatch as cloudwatch
 
 
@@ -237,7 +236,7 @@ metric = table.metric_throttled_requests_for_operations(
     period=Duration.minutes(1)
 )
 
-cloudwatch.Alarm(stack, "Alarm",
+cloudwatch.Alarm(self, "Alarm",
     metric=metric,
     evaluation_periods=1,
     threshold=1
@@ -315,7 +314,6 @@ class Attribute:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             import aws_cdk.aws_cloudwatch as cloudwatch
             
             
@@ -328,7 +326,7 @@ class Attribute:
                 period=Duration.minutes(1)
             )
             
-            cloudwatch.Alarm(stack, "Alarm",
+            cloudwatch.Alarm(self, "Alarm",
                 metric=metric,
                 evaluation_periods=1,
                 threshold=1
@@ -378,7 +376,6 @@ class AttributeType(enum.Enum):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         import aws_cdk.aws_cloudwatch as cloudwatch
         
         
@@ -391,7 +388,7 @@ class AttributeType(enum.Enum):
             period=Duration.minutes(1)
         )
         
-        cloudwatch.Alarm(stack, "Alarm",
+        cloudwatch.Alarm(self, "Alarm",
             metric=metric,
             evaluation_periods=1,
             threshold=1
@@ -3358,7 +3355,7 @@ class CfnTable(
         :param kinesis_stream_specification: The Kinesis Data Streams configuration for the specified table.
         :param local_secondary_indexes: Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
         :param point_in_time_recovery_specification: The settings used to enable point in time recovery.
-        :param provisioned_throughput: Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits`` . For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html>`_ . If you set ``BillingMode`` as ``PROVISIONED`` , you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST`` , you cannot specify this property.
+        :param provisioned_throughput: Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits`` . For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html>`_ . If you set ``BillingMode`` as ``PROVISIONED`` , you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST`` , you cannot specify this property.
         :param sse_specification: Specifies the settings to enable server-side encryption.
         :param stream_specification: The settings for the DynamoDB table stream, which capture changes to items stored in the table.
         :param table_class: The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS`` .
@@ -3704,7 +3701,7 @@ class CfnTable(
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTable.ProvisionedThroughputProperty"]]:
         '''Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits`` .
 
-        For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html>`_ .
+        For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html>`_ .
 
         If you set ``BillingMode`` as ``PROVISIONED`` , you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST`` , you cannot specify this property.
 
@@ -4785,7 +4782,7 @@ class CfnTable(
         ) -> None:
             '''Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits`` .
 
-            For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html>`_ .
+            For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html>`_ .
 
             :param read_capacity_units: The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException`` . For more information, see `Specifying Read and Write Requirements <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput>`_ in the *Amazon DynamoDB Developer Guide* . If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.
             :param write_capacity_units: The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException`` . For more information, see `Specifying Read and Write Requirements <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput>`_ in the *Amazon DynamoDB Developer Guide* . If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.
@@ -5236,7 +5233,7 @@ class CfnTableProps:
         :param kinesis_stream_specification: The Kinesis Data Streams configuration for the specified table.
         :param local_secondary_indexes: Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.
         :param point_in_time_recovery_specification: The settings used to enable point in time recovery.
-        :param provisioned_throughput: Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits`` . For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html>`_ . If you set ``BillingMode`` as ``PROVISIONED`` , you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST`` , you cannot specify this property.
+        :param provisioned_throughput: Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits`` . For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html>`_ . If you set ``BillingMode`` as ``PROVISIONED`` , you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST`` , you cannot specify this property.
         :param sse_specification: Specifies the settings to enable server-side encryption.
         :param stream_specification: The settings for the DynamoDB table stream, which capture changes to items stored in the table.
         :param table_class: The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS`` .
@@ -5553,7 +5550,7 @@ class CfnTableProps:
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnTable.ProvisionedThroughputProperty]]:
         '''Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits`` .
 
-        For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html>`_ .
+        For more information about the contents of a provisioned throughput structure, see `Amazon DynamoDB Table ProvisionedThroughput <https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html>`_ .
 
         If you set ``BillingMode`` as ``PROVISIONED`` , you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST`` , you cannot specify this property.
 
@@ -6736,7 +6733,6 @@ class Operation(enum.Enum):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         import aws_cdk.aws_cloudwatch as cloudwatch
         
         
@@ -6749,7 +6745,7 @@ class Operation(enum.Enum):
             period=Duration.minutes(1)
         )
         
-        cloudwatch.Alarm(stack, "Alarm",
+        cloudwatch.Alarm(self, "Alarm",
             metric=metric,
             evaluation_periods=1,
             threshold=1
@@ -7236,7 +7232,6 @@ class Table(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         import aws_cdk.aws_cloudwatch as cloudwatch
         
         
@@ -7249,7 +7244,7 @@ class Table(
             period=Duration.minutes(1)
         )
         
-        cloudwatch.Alarm(stack, "Alarm",
+        cloudwatch.Alarm(self, "Alarm",
             metric=metric,
             evaluation_periods=1,
             threshold=1
@@ -7299,7 +7294,7 @@ class Table(
         :param stream: When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Default: - streams are disabled unless ``replicationRegions`` is specified
         :param table_class: Specify the table class. Default: STANDARD
         :param time_to_live_attribute: The name of TTL attribute. Default: - TTL is disabled
-        :param wait_for_replication_to_finish: Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set. DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion. Default: true
+        :param wait_for_replication_to_finish: Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set. WARNING: DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion. If the custom resource which handles replication has a physical resource ID with the format ``region`` instead of ``tablename-region`` (this would happen if the custom resource hasn't received an event since v1.91.0), DO NOT SET this property to false without making a change to the table name. This will cause the existing replicas to be deleted. Default: true
         :param write_capacity: The write capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput. Can only be provided if billingMode is Provisioned. Default: 5
         :param partition_key: Partition key attribute definition.
         :param sort_key: Sort key attribute definition. Default: no sort key
@@ -8467,7 +8462,7 @@ class TableOptions(SchemaOptions):
         :param stream: When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Default: - streams are disabled unless ``replicationRegions`` is specified
         :param table_class: Specify the table class. Default: STANDARD
         :param time_to_live_attribute: The name of TTL attribute. Default: - TTL is disabled
-        :param wait_for_replication_to_finish: Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set. DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion. Default: true
+        :param wait_for_replication_to_finish: Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set. WARNING: DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion. If the custom resource which handles replication has a physical resource ID with the format ``region`` instead of ``tablename-region`` (this would happen if the custom resource hasn't received an event since v1.91.0), DO NOT SET this property to false without making a change to the table name. This will cause the existing replicas to be deleted. Default: true
         :param write_capacity: The write capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput. Can only be provided if billingMode is Provisioned. Default: 5
 
         :exampleMetadata: fixture=_generated
@@ -8732,11 +8727,18 @@ class TableOptions(SchemaOptions):
         created and replication will be completed asynchronously. This property is
         ignored if replicationRegions property is not set.
 
+        WARNING:
         DO NOT UNSET this property if adding/removing multiple replicationRegions
         in one deployment, as CloudFormation only supports one region replication
         at a time. CDK overcomes this limitation by waiting for replication to
         finish before starting new replicationRegion.
 
+        If the custom resource which handles replication has a physical resource
+        ID with the format ``region`` instead of ``tablename-region`` (this would happen
+        if the custom resource hasn't received an event since v1.91.0), DO NOT SET
+        this property to false without making a change to the table name.
+        This will cause the existing replicas to be deleted.
+
         :default: true
 
         :see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas
@@ -8836,7 +8838,7 @@ class TableProps(TableOptions):
         :param stream: When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Default: - streams are disabled unless ``replicationRegions`` is specified
         :param table_class: Specify the table class. Default: STANDARD
         :param time_to_live_attribute: The name of TTL attribute. Default: - TTL is disabled
-        :param wait_for_replication_to_finish: Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set. DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion. Default: true
+        :param wait_for_replication_to_finish: Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set. WARNING: DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion. If the custom resource which handles replication has a physical resource ID with the format ``region`` instead of ``tablename-region`` (this would happen if the custom resource hasn't received an event since v1.91.0), DO NOT SET this property to false without making a change to the table name. This will cause the existing replicas to be deleted. Default: true
         :param write_capacity: The write capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table's provisioned throughput. Can only be provided if billingMode is Provisioned. Default: 5
         :param kinesis_stream: Kinesis Data Stream to capture item-level changes for the table. Default: - no Kinesis Data Stream
         :param table_name: Enforces a particular physical table name. Default: 
@@ -8845,7 +8847,6 @@ class TableProps(TableOptions):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             import aws_cdk.aws_cloudwatch as cloudwatch
             
             
@@ -8858,7 +8859,7 @@ class TableProps(TableOptions):
                 period=Duration.minutes(1)
             )
             
-            cloudwatch.Alarm(stack, "Alarm",
+            cloudwatch.Alarm(self, "Alarm",
                 metric=metric,
                 evaluation_periods=1,
                 threshold=1
@@ -9092,11 +9093,18 @@ class TableProps(TableOptions):
         created and replication will be completed asynchronously. This property is
         ignored if replicationRegions property is not set.
 
+        WARNING:
         DO NOT UNSET this property if adding/removing multiple replicationRegions
         in one deployment, as CloudFormation only supports one region replication
         at a time. CDK overcomes this limitation by waiting for replication to
         finish before starting new replicationRegion.
 
+        If the custom resource which handles replication has a physical resource
+        ID with the format ``region`` instead of ``tablename-region`` (this would happen
+        if the custom resource hasn't received an event since v1.91.0), DO NOT SET
+        this property to false without making a change to the table name.
+        This will cause the existing replicas to be deleted.
+
         :default: true
 
         :see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas
@@ -9601,7 +9609,6 @@ class OperationsMetricOptions(SystemErrorsForOperationsMetricOptions):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             import aws_cdk.aws_cloudwatch as cloudwatch
             
             
@@ -9614,7 +9621,7 @@ class OperationsMetricOptions(SystemErrorsForOperationsMetricOptions):
                 period=Duration.minutes(1)
             )
             
-            cloudwatch.Alarm(stack, "Alarm",
+            cloudwatch.Alarm(self, "Alarm",
                 metric=metric,
                 evaluation_periods=1,
                 threshold=1