aws-cdk-lib 2.134.0__py3-none-any.whl → 2.135.0__py3-none-any.whl

aws_cdk/aws_dms/__init__.py

@@ -25,6 +25,9 @@ For more information on the resources and properties available for this service,
 
 <!--END CFNONLY DISCLAIMER-->
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime
@@ -5051,17 +5054,17 @@ class CfnEndpoint(
 
             :param after_connect_script: For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data. Example: ``afterConnectScript=SET session_replication_role='replica'``
             :param babelfish_database_name: The Babelfish for Aurora PostgreSQL database name for the endpoint.
-            :param capture_ddls: To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts. If this value is set to ``N`` , you don't have to create tables or triggers on the source database.
+            :param capture_ddls: To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts. The default value is ``true`` . If this value is set to ``N`` , you don't have to create tables or triggers on the source database.
             :param database_mode: Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.
-            :param ddl_artifacts_schema: The schema in which the operational DDL database artifacts are created. Example: ``ddlArtifactsSchema=xyzddlschema;``
+            :param ddl_artifacts_schema: The schema in which the operational DDL database artifacts are created. The default value is ``public`` . Example: ``ddlArtifactsSchema=xyzddlschema;``
             :param execute_timeout: Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds. Example: ``executeTimeout=100;``
-            :param fail_tasks_on_lob_truncation: When set to ``true`` , this value causes a task to fail if the actual size of a LOB column is greater than the specified ``LobMaxSize`` . If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
-            :param heartbeat_enable: The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps ``restart_lsn`` moving and prevents storage full scenarios.
-            :param heartbeat_frequency: Sets the WAL heartbeat frequency (in minutes).
-            :param heartbeat_schema: Sets the schema in which the heartbeat artifacts are created.
-            :param map_boolean_as_boolean: When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as ``varchar(5)`` . You must set this setting on both the source and target endpoints for it to take effect.
-            :param max_file_size: Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Example: ``maxFileSize=512``
-            :param plugin_name: Specifies the plugin to use to create a replication slot.
+            :param fail_tasks_on_lob_truncation: When set to ``true`` , this value causes a task to fail if the actual size of a LOB column is greater than the specified ``LobMaxSize`` . The default value is ``false`` . If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
+            :param heartbeat_enable: The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps ``restart_lsn`` moving and prevents storage full scenarios. The default value is ``false`` .
+            :param heartbeat_frequency: Sets the WAL heartbeat frequency (in minutes). The default value is 5 minutes.
+            :param heartbeat_schema: Sets the schema in which the heartbeat artifacts are created. The default value is ``public`` .
+            :param map_boolean_as_boolean: When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as ``varchar(5)`` . You must set this setting on both the source and target endpoints for it to take effect. The default value is ``false`` .
+            :param max_file_size: Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. The default value is 32,768 KB (32 MB). Example: ``maxFileSize=512``
+            :param plugin_name: Specifies the plugin to use to create a replication slot. The default value is ``pglogical`` .
             :param secrets_manager_access_role_arn: The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in ``SecretsManagerSecret`` . The role must allow the ``iam:PassRole`` action. ``SecretsManagerSecret`` has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint. .. epigraph:: You can specify one of two sets of values for these permissions. You can specify the values for this setting and ``SecretsManagerSecretId`` . Or you can specify clear-text values for ``UserName`` , ``Password`` , ``ServerName`` , and ``Port`` . You can't specify both. For more information on creating this ``SecretsManagerSecret`` , the corresponding ``SecretsManagerAccessRoleArn`` , and the ``SecretsManagerSecretId`` that is required to access it, see `Using secrets to access AWS Database Migration Service resources <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager>`_ in the *AWS Database Migration Service User Guide* .
             :param secrets_manager_secret_id: The full ARN, partial ARN, or display name of the ``SecretsManagerSecret`` that contains the PostgreSQL endpoint connection details.
             :param slot_name: Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance. When used with the ``CdcStartPosition`` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of ``CdcStartPosition`` . If the specified slot doesn't exist or the task doesn't have a valid ``CdcStartPosition`` setting, DMS raises an error. For more information about setting the ``CdcStartPosition`` request parameter, see `Determining a CDC native start point <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native>`_ in the *AWS Database Migration Service User Guide* . For more information about using ``CdcStartPosition`` , see `CreateReplicationTask <https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html>`_ , `StartReplicationTask <https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html>`_ , and `ModifyReplicationTask <https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html>`_ .
@@ -5174,6 +5177,8 @@ class CfnEndpoint(
 
             You can later remove these artifacts.
 
+            The default value is ``true`` .
+
             If this value is set to ``N`` , you don't have to create tables or triggers on the source database.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-captureddls
@@ -5194,6 +5199,8 @@ class CfnEndpoint(
         def ddl_artifacts_schema(self) -> typing.Optional[builtins.str]:
             '''The schema in which the operational DDL database artifacts are created.
 
+            The default value is ``public`` .
+
             Example: ``ddlArtifactsSchema=xyzddlschema;``
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-ddlartifactsschema
@@ -5218,6 +5225,8 @@ class CfnEndpoint(
         ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
             '''When set to ``true`` , this value causes a task to fail if the actual size of a LOB column is greater than the specified ``LobMaxSize`` .
 
+            The default value is ``false`` .
+
             If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-failtasksonlobtruncation
@@ -5233,6 +5242,8 @@ class CfnEndpoint(
 
             By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source. This heartbeat keeps ``restart_lsn`` moving and prevents storage full scenarios.
 
+            The default value is ``false`` .
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatenable
             '''
             result = self._values.get("heartbeat_enable")
@@ -5242,6 +5253,8 @@ class CfnEndpoint(
         def heartbeat_frequency(self) -> typing.Optional[jsii.Number]:
             '''Sets the WAL heartbeat frequency (in minutes).
 
+            The default value is 5 minutes.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatfrequency
             '''
             result = self._values.get("heartbeat_frequency")
@@ -5251,6 +5264,8 @@ class CfnEndpoint(
         def heartbeat_schema(self) -> typing.Optional[builtins.str]:
             '''Sets the schema in which the heartbeat artifacts are created.
 
+            The default value is ``public`` .
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatschema
             '''
             result = self._values.get("heartbeat_schema")
@@ -5264,6 +5279,8 @@ class CfnEndpoint(
 
             By default, PostgreSQL migrates booleans as ``varchar(5)`` . You must set this setting on both the source and target endpoints for it to take effect.
 
+            The default value is ``false`` .
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-mapbooleanasboolean
             '''
             result = self._values.get("map_boolean_as_boolean")
@@ -5273,6 +5290,8 @@ class CfnEndpoint(
         def max_file_size(self) -> typing.Optional[jsii.Number]:
             '''Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
 
+            The default value is 32,768 KB (32 MB).
+
             Example: ``maxFileSize=512``
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-maxfilesize
@@ -5284,6 +5303,8 @@ class CfnEndpoint(
         def plugin_name(self) -> typing.Optional[builtins.str]:
             '''Specifies the plugin to use to create a replication slot.
 
+            The default value is ``pglogical`` .
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-pluginname
             '''
             result = self._values.get("plugin_name")

aws_cdk/aws_docdb/__init__.py

@@ -262,6 +262,9 @@ cluster = docdb.DatabaseCluster(self, "Database",
 )
 ```
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime

aws_cdk/aws_docdbelastic/__init__.py

@@ -25,6 +25,9 @@ For more information on the resources and properties available for this service,
 
 <!--END CFNONLY DISCLAIMER-->
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime
@@ -120,11 +123,11 @@ class CfnCluster(
         :param shard_capacity: The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
         :param shard_count: The number of shards assigned to the elastic cluster. Maximum is 32.
         :param admin_user_password: The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters. *Constraints* : - Must contain from 8 to 100 characters. - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@). - A valid ``AdminUserName`` entry is also required.
-        :param backup_retention_period: 
+        :param backup_retention_period: The number of days for which automatic snapshots are retained.
         :param kms_key_id: The KMS key identifier to use to encrypt the new elastic cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
-        :param preferred_backup_window: 
+        :param preferred_backup_window: The daily time range during which automated backups are created if automated backups are enabled, as determined by ``backupRetentionPeriod`` .
         :param preferred_maintenance_window: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format* : ``ddd:hh24:mi-ddd:hh24:mi`` *Default* : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week. *Valid days* : Mon, Tue, Wed, Thu, Fri, Sat, Sun *Constraints* : Minimum 30-minute window.
-        :param shard_instance_count: 
+        :param shard_instance_count: The number of replica instances applying to all shards in the cluster. A ``shardInstanceCount`` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
         :param subnet_ids: The Amazon EC2 subnet IDs for the new elastic cluster.
         :param tags: The tags to be assigned to the new elastic cluster.
         :param vpc_security_group_ids: A list of EC2 VPC security groups to associate with the new elastic cluster.
@@ -294,6 +297,7 @@ class CfnCluster(
     @builtins.property
     @jsii.member(jsii_name="backupRetentionPeriod")
     def backup_retention_period(self) -> typing.Optional[jsii.Number]:
+        '''The number of days for which automatic snapshots are retained.'''
         return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "backupRetentionPeriod"))
 
     @backup_retention_period.setter
@@ -319,6 +323,7 @@ class CfnCluster(
     @builtins.property
     @jsii.member(jsii_name="preferredBackupWindow")
     def preferred_backup_window(self) -> typing.Optional[builtins.str]:
+        '''The daily time range during which automated backups are created if automated backups are enabled, as determined by ``backupRetentionPeriod`` .'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "preferredBackupWindow"))
 
     @preferred_backup_window.setter
@@ -347,6 +352,7 @@ class CfnCluster(
     @builtins.property
     @jsii.member(jsii_name="shardInstanceCount")
     def shard_instance_count(self) -> typing.Optional[jsii.Number]:
+        '''The number of replica instances applying to all shards in the cluster.'''
         return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "shardInstanceCount"))
 
     @shard_instance_count.setter
@@ -446,11 +452,11 @@ class CfnClusterProps:
         :param shard_capacity: The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
         :param shard_count: The number of shards assigned to the elastic cluster. Maximum is 32.
         :param admin_user_password: The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters. *Constraints* : - Must contain from 8 to 100 characters. - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@). - A valid ``AdminUserName`` entry is also required.
-        :param backup_retention_period: 
+        :param backup_retention_period: The number of days for which automatic snapshots are retained.
         :param kms_key_id: The KMS key identifier to use to encrypt the new elastic cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
-        :param preferred_backup_window: 
+        :param preferred_backup_window: The daily time range during which automated backups are created if automated backups are enabled, as determined by ``backupRetentionPeriod`` .
         :param preferred_maintenance_window: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format* : ``ddd:hh24:mi-ddd:hh24:mi`` *Default* : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week. *Valid days* : Mon, Tue, Wed, Thu, Fri, Sat, Sun *Constraints* : Minimum 30-minute window.
-        :param shard_instance_count: 
+        :param shard_instance_count: The number of replica instances applying to all shards in the cluster. A ``shardInstanceCount`` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
         :param subnet_ids: The Amazon EC2 subnet IDs for the new elastic cluster.
         :param tags: The tags to be assigned to the new elastic cluster.
         :param vpc_security_group_ids: A list of EC2 VPC security groups to associate with the new elastic cluster.
@@ -615,7 +621,8 @@ class CfnClusterProps:
 
     @builtins.property
     def backup_retention_period(self) -> typing.Optional[jsii.Number]:
-        '''
+        '''The number of days for which automatic snapshots are retained.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-backupretentionperiod
         '''
         result = self._values.get("backup_retention_period")
@@ -636,7 +643,8 @@ class CfnClusterProps:
 
     @builtins.property
     def preferred_backup_window(self) -> typing.Optional[builtins.str]:
-        '''
+        '''The daily time range during which automated backups are created if automated backups are enabled, as determined by ``backupRetentionPeriod`` .
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredbackupwindow
         '''
         result = self._values.get("preferred_backup_window")
@@ -661,7 +669,10 @@ class CfnClusterProps:
 
     @builtins.property
     def shard_instance_count(self) -> typing.Optional[jsii.Number]:
-        '''
+        '''The number of replica instances applying to all shards in the cluster.
+
+        A ``shardInstanceCount`` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardinstancecount
         '''
         result = self._values.get("shard_instance_count")

aws_cdk/aws_dynamodb/__init__.py

@@ -861,6 +861,9 @@ dynamodb.Table(stack, "Table",
 )
 ```
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime