aws-cdk-lib 2.175.1__py3-none-any.whl → 2.177.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +26 -7
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.175.1.jsii.tgz → aws-cdk-lib@2.177.0.jsii.tgz} +0 -0
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +161 -9
- aws_cdk/aws_appconfig/__init__.py +106 -24
- aws_cdk/aws_appsync/__init__.py +4 -3
- aws_cdk/aws_backup/__init__.py +18 -84
- aws_cdk/aws_batch/__init__.py +4 -2
- aws_cdk/aws_bedrock/__init__.py +5395 -2508
- aws_cdk/aws_cleanrooms/__init__.py +77 -34
- aws_cdk/aws_cloudformation/__init__.py +4 -2
- aws_cdk/aws_cloudfront/__init__.py +12 -2
- aws_cdk/aws_cloudfront/experimental/__init__.py +1 -1
- aws_cdk/aws_cloudfront_origins/__init__.py +33 -2
- aws_cdk/aws_cloudwatch/__init__.py +53 -49
- aws_cdk/aws_codebuild/__init__.py +36 -0
- aws_cdk/aws_codepipeline/__init__.py +35 -0
- aws_cdk/aws_cognito/__init__.py +285 -253
- aws_cdk/aws_customerprofiles/__init__.py +1060 -0
- aws_cdk/aws_datazone/__init__.py +195 -125
- aws_cdk/aws_docdb/__init__.py +29 -9
- aws_cdk/aws_dynamodb/__init__.py +77 -58
- aws_cdk/aws_ec2/__init__.py +16 -11
- aws_cdk/aws_ecs/__init__.py +127 -43
- aws_cdk/aws_efs/__init__.py +5 -5
- aws_cdk/aws_eks/__init__.py +24 -3
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +41 -5
- aws_cdk/aws_emrserverless/__init__.py +86 -0
- aws_cdk/aws_fms/__init__.py +42 -0
- aws_cdk/aws_gamelift/__init__.py +8 -10
- aws_cdk/aws_healthlake/__init__.py +36 -40
- aws_cdk/aws_iam/__init__.py +8 -0
- aws_cdk/aws_imagebuilder/__init__.py +62 -48
- aws_cdk/aws_lambda/__init__.py +21 -8
- aws_cdk/aws_lambda_event_sources/__init__.py +9 -9
- aws_cdk/aws_lex/__init__.py +105 -0
- aws_cdk/aws_logs/__init__.py +59 -59
- aws_cdk/aws_mediaconvert/__init__.py +7 -3
- aws_cdk/aws_notifications/__init__.py +1390 -0
- aws_cdk/aws_notificationscontacts/__init__.py +593 -0
- aws_cdk/aws_organizations/__init__.py +5 -9
- aws_cdk/aws_rds/__init__.py +99 -30
- aws_cdk/aws_redshift/__init__.py +9 -5
- aws_cdk/aws_resiliencehub/__init__.py +41 -0
- aws_cdk/aws_route53/__init__.py +4 -4
- aws_cdk/aws_route53_targets/__init__.py +15 -15
- aws_cdk/aws_s3/__init__.py +794 -5
- aws_cdk/aws_s3_notifications/__init__.py +5 -5
- aws_cdk/aws_s3tables/__init__.py +2 -2
- aws_cdk/aws_ses/__init__.py +25 -4
- aws_cdk/aws_sns/__init__.py +39 -0
- aws_cdk/aws_ssm/__init__.py +14 -7
- aws_cdk/aws_ssmquicksetup/__init__.py +84 -84
- aws_cdk/aws_sso/__init__.py +9 -5
- aws_cdk/aws_synthetics/__init__.py +105 -32
- aws_cdk/cloud_assembly_schema/__init__.py +63 -4
- aws_cdk/cx_api/__init__.py +69 -8
- {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/METADATA +3 -3
- {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/RECORD +63 -62
- aws_cdk/aws_iot1click/__init__.py +0 -1193
- {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.175.1.dist-info → aws_cdk_lib-2.177.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_rds/__init__.py
CHANGED
|
@@ -1664,7 +1664,7 @@ rds.DatabaseCluster(self, "LimitlessDatabaseCluster",
|
|
|
1664
1664
|
version=rds.AuroraPostgresEngineVersion.VER_16_4_LIMITLESS
|
|
1665
1665
|
),
|
|
1666
1666
|
vpc=vpc,
|
|
1667
|
-
|
|
1667
|
+
cluster_scalability_type=rds.ClusterScalabilityType.LIMITLESS,
|
|
1668
1668
|
# Requires enabling Performance Insights
|
|
1669
1669
|
enable_performance_insights=True,
|
|
1670
1670
|
performance_insight_retention=rds.PerformanceInsightRetention.MONTHS_1,
|
|
@@ -5075,7 +5075,7 @@ class CfnDBCluster(
|
|
|
5075
5075
|
:param performance_insights_retention_period: The number of days to retain Performance Insights data. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: - ``7`` - *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) - ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94`` , Amazon RDS issues an error.
|
|
5076
5076
|
:param port: The port number on which the DB instances in the DB cluster accept connections. Default: - When ``EngineMode`` is ``provisioned`` , ``3306`` (for both Aurora MySQL and Aurora PostgreSQL) - When ``EngineMode`` is ``serverless`` : - ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql`` - ``5432`` when ``Engine`` is ``aurora-postgresql`` .. epigraph:: The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see `Port <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port>`_ for the AWS::RDS::DBInstance resource. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5077
5077
|
:param preferred_backup_window: The daily time range during which automated backups are created. For more information, see `Backup Window <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow>`_ in the *Amazon Aurora User Guide.* Constraints: - Must be in the format ``hh24:mi-hh24:mi`` . - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5078
|
-
: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`` The default is 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. To see the time blocks available, see `
|
|
5078
|
+
: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`` The default is 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. To see the time blocks available, see `Maintaining an Amazon Aurora DB cluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora>`_ in the *Amazon Aurora User Guide.* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
5079
5079
|
:param publicly_accessible: Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Valid for Cluster Type: Multi-AZ DB clusters only Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified. If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies: - If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. - If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies: - If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. - If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
|
|
5080
5080
|
:param replication_source_identifier: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for: Aurora DB clusters only
|
|
5081
5081
|
:param restore_to_time: The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: - Must be before the latest restorable time for the DB instance - Must be specified if ``UseLatestRestorableTime`` parameter isn't provided - Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled - Can't be specified if the ``RestoreType`` parameter is ``copy-on-write`` This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property. Example: ``2015-03-07T23:45:00Z`` Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
@@ -7269,7 +7269,7 @@ class CfnDBClusterProps:
|
|
|
7269
7269
|
:param performance_insights_retention_period: The number of days to retain Performance Insights data. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: - ``7`` - *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) - ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94`` , Amazon RDS issues an error.
|
|
7270
7270
|
:param port: The port number on which the DB instances in the DB cluster accept connections. Default: - When ``EngineMode`` is ``provisioned`` , ``3306`` (for both Aurora MySQL and Aurora PostgreSQL) - When ``EngineMode`` is ``serverless`` : - ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql`` - ``5432`` when ``Engine`` is ``aurora-postgresql`` .. epigraph:: The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see `Port <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port>`_ for the AWS::RDS::DBInstance resource. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7271
7271
|
:param preferred_backup_window: The daily time range during which automated backups are created. For more information, see `Backup Window <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow>`_ in the *Amazon Aurora User Guide.* Constraints: - Must be in the format ``hh24:mi-hh24:mi`` . - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7272
|
-
: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`` The default is 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. To see the time blocks available, see `
|
|
7272
|
+
: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`` The default is 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. To see the time blocks available, see `Maintaining an Amazon Aurora DB cluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora>`_ in the *Amazon Aurora User Guide.* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7273
7273
|
:param publicly_accessible: Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Valid for Cluster Type: Multi-AZ DB clusters only Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified. If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies: - If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. - If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies: - If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. - If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
|
|
7274
7274
|
:param replication_source_identifier: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for: Aurora DB clusters only
|
|
7275
7275
|
:param restore_to_time: The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: - Must be before the latest restorable time for the DB instance - Must be specified if ``UseLatestRestorableTime`` parameter isn't provided - Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled - Can't be specified if the ``RestoreType`` parameter is ``copy-on-write`` This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property. Example: ``2015-03-07T23:45:00Z`` Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
@@ -8308,7 +8308,7 @@ class CfnDBClusterProps:
|
|
|
8308
8308
|
|
|
8309
8309
|
Format: ``ddd:hh24:mi-ddd:hh24:mi``
|
|
8310
8310
|
|
|
8311
|
-
The default is 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. To see the time blocks available, see `
|
|
8311
|
+
The default is 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. To see the time blocks available, see `Maintaining an Amazon Aurora DB cluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora>`_ in the *Amazon Aurora User Guide.*
|
|
8312
8312
|
|
|
8313
8313
|
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
|
8314
8314
|
|
|
@@ -8860,7 +8860,7 @@ class CfnDBInstance(
|
|
|
8860
8860
|
:param db_name: The meaning of this parameter differs according to the database engine you use. .. epigraph:: If you specify the ``[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: - Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - Must contain 1 to 63 characters. - Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null`` , the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName`` . Default: ``ORCL`` Constraints: - Can't be longer than 8 characters *SQL Server* Not applicable. Must be null.
|
|
8861
8861
|
:param db_parameter_group_name: The name of an existing DB parameter group or a reference to an `AWS::RDS::DBParameterGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html>`_ resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` .. epigraph:: If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.
|
|
8862
8862
|
:param db_security_groups: A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. .. epigraph:: If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: - ``AllocatedStorage`` - ``AutoMinorVersionUpgrade`` - ``AvailabilityZone`` - ``BackupRetentionPeriod`` - ``CharacterSetName`` - ``DBInstanceClass`` - ``DBName`` - ``DBParameterGroupName`` - ``DBSecurityGroups`` - ``DBSubnetGroupName`` - ``Engine`` - ``EngineVersion`` - ``Iops`` - ``LicenseModel`` - ``MasterUsername`` - ``MasterUserPassword`` - ``MultiAZ`` - ``OptionGroupName`` - ``PreferredBackupWindow`` - ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType`` , ``StorageEncrypted`` , or ``KmsKeyId`` . If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
|
|
8863
|
-
:param db_snapshot_identifier: The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the
|
|
8863
|
+
:param db_snapshot_identifier: The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties, and the point-in-time recovery properties ``RestoreTime`` and ``UseLatestRestorableTime`` . For information about the properties that you can specify, see the ```RestoreDBInstanceFromDBSnapshot`` <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html>`_ action in the *Amazon RDS API Reference* . After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: - ``CharacterSetName`` - ``DBClusterIdentifier`` - ``DBName`` - ``KmsKeyId`` - ``MasterUsername`` - ``MasterUserPassword`` - ``PromotionTier`` - ``SourceDBInstanceIdentifier`` - ``SourceRegion`` - ``StorageEncrypted`` (for an unencrypted snapshot) - ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster.
|
|
8864
8864
|
:param db_subnet_group_name: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see `Amazon VPC and Amazon RDS <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html>`_ in the *Amazon RDS User Guide* . This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
8865
8865
|
:param db_system_id: The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB`` . The Oracle SID is also the name of your CDB.
|
|
8866
8866
|
:param dedicated_log_volume: Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
|
@@ -8897,7 +8897,7 @@ class CfnDBInstance(
|
|
|
8897
8897
|
:param performance_insights_retention_period: The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: - ``7`` - *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) - ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94`` , Amazon RDS returns an error.
|
|
8898
8898
|
:param port: The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: ``1150-65535`` Default: - RDS for Db2 - ``50000`` - RDS for MariaDB - ``3306`` - RDS for Microsoft SQL Server - ``1433`` - RDS for MySQL - ``3306`` - RDS for Oracle - ``1521`` - RDS for PostgreSQL - ``5432`` Constraints: - For RDS for Microsoft SQL Server, the value can't be ``1234`` , ``1434`` , ``3260`` , ``3343`` , ``3389`` , ``47001`` , or ``49152-49156`` .
|
|
8899
8899
|
:param preferred_backup_window: The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see `Backup Window <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow>`_ in the *Amazon RDS User Guide.* Constraints: - Must be in the format ``hh24:mi-hh24:mi`` . - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
|
|
8900
|
-
: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`` The default is 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. To see the time blocks available, see `
|
|
8900
|
+
: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`` The default is 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. To see the time blocks available, see `Maintaining a DB instance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow>`_ in the *Amazon RDS User Guide.* .. epigraph:: This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
|
|
8901
8901
|
:param processor_features: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
|
8902
8902
|
:param promotion_tier: The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see `Fault Tolerance for an Aurora DB Cluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance>`_ in the *Amazon Aurora User Guide* . This setting doesn't apply to RDS Custom DB instances. Default: ``1`` Valid Values: ``0 - 15``
|
|
8903
8903
|
:param publicly_accessible: Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the `CreateDBInstance <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html>`_ in the *Amazon RDS API Reference* .
|
|
@@ -8909,7 +8909,7 @@ class CfnDBInstance(
|
|
|
8909
8909
|
:param source_dbi_resource_id: The resource ID of the source DB instance from which to restore.
|
|
8910
8910
|
:param source_region: The ID of the region that contains the source DB instance for the read replica.
|
|
8911
8911
|
:param storage_encrypted: A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
8912
|
-
:param storage_throughput: Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
8912
|
+
:param storage_throughput: Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
8913
8913
|
:param storage_type: The storage type to associate with the DB instance. If you specify ``io1`` , ``io2`` , or ``gp3`` , you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1`` , if the ``Iops`` parameter is specified. Otherwise, ``gp2`` .
|
|
8914
8914
|
:param tags: Tags to assign to the DB instance.
|
|
8915
8915
|
:param tde_credential_arn:
|
|
@@ -9058,12 +9058,7 @@ class CfnDBInstance(
|
|
|
9058
9058
|
@builtins.property
|
|
9059
9059
|
@jsii.member(jsii_name="attrDatabaseInsightsMode")
|
|
9060
9060
|
def attr_database_insights_mode(self) -> builtins.str:
|
|
9061
|
-
'''The mode of Database Insights
|
|
9062
|
-
|
|
9063
|
-
This setting only applies to Amazon Aurora DB instances.
|
|
9064
|
-
.. epigraph::
|
|
9065
|
-
|
|
9066
|
-
Currently, this value is inherited from the DB cluster and can't be changed.
|
|
9061
|
+
'''The mode of Database Insights that is enabled for the instance.
|
|
9067
9062
|
|
|
9068
9063
|
:cloudformationAttribute: DatabaseInsightsMode
|
|
9069
9064
|
'''
|
|
@@ -10199,10 +10194,7 @@ class CfnDBInstance(
|
|
|
10199
10194
|
@builtins.property
|
|
10200
10195
|
@jsii.member(jsii_name="storageThroughput")
|
|
10201
10196
|
def storage_throughput(self) -> typing.Optional[jsii.Number]:
|
|
10202
|
-
'''Specifies the storage throughput value for the DB instance.
|
|
10203
|
-
|
|
10204
|
-
This setting applies only to the ``gp3`` storage type.
|
|
10205
|
-
'''
|
|
10197
|
+
'''Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance.'''
|
|
10206
10198
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "storageThroughput"))
|
|
10207
10199
|
|
|
10208
10200
|
@storage_throughput.setter
|
|
@@ -10918,7 +10910,7 @@ class CfnDBInstanceProps:
|
|
|
10918
10910
|
:param db_name: The meaning of this parameter differs according to the database engine you use. .. epigraph:: If you specify the ``[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: - Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - Must contain 1 to 63 characters. - Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null`` , the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName`` . Default: ``ORCL`` Constraints: - Can't be longer than 8 characters *SQL Server* Not applicable. Must be null.
|
|
10919
10911
|
:param db_parameter_group_name: The name of an existing DB parameter group or a reference to an `AWS::RDS::DBParameterGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html>`_ resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` .. epigraph:: If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.
|
|
10920
10912
|
:param db_security_groups: A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. .. epigraph:: If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: - ``AllocatedStorage`` - ``AutoMinorVersionUpgrade`` - ``AvailabilityZone`` - ``BackupRetentionPeriod`` - ``CharacterSetName`` - ``DBInstanceClass`` - ``DBName`` - ``DBParameterGroupName`` - ``DBSecurityGroups`` - ``DBSubnetGroupName`` - ``Engine`` - ``EngineVersion`` - ``Iops`` - ``LicenseModel`` - ``MasterUsername`` - ``MasterUserPassword`` - ``MultiAZ`` - ``OptionGroupName`` - ``PreferredBackupWindow`` - ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType`` , ``StorageEncrypted`` , or ``KmsKeyId`` . If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
|
|
10921
|
-
:param db_snapshot_identifier: The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the
|
|
10913
|
+
:param db_snapshot_identifier: The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties, and the point-in-time recovery properties ``RestoreTime`` and ``UseLatestRestorableTime`` . For information about the properties that you can specify, see the ```RestoreDBInstanceFromDBSnapshot`` <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html>`_ action in the *Amazon RDS API Reference* . After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: - ``CharacterSetName`` - ``DBClusterIdentifier`` - ``DBName`` - ``KmsKeyId`` - ``MasterUsername`` - ``MasterUserPassword`` - ``PromotionTier`` - ``SourceDBInstanceIdentifier`` - ``SourceRegion`` - ``StorageEncrypted`` (for an unencrypted snapshot) - ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster.
|
|
10922
10914
|
:param db_subnet_group_name: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see `Amazon VPC and Amazon RDS <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html>`_ in the *Amazon RDS User Guide* . This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
10923
10915
|
:param db_system_id: The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB`` . The Oracle SID is also the name of your CDB.
|
|
10924
10916
|
:param dedicated_log_volume: Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
|
@@ -10955,7 +10947,7 @@ class CfnDBInstanceProps:
|
|
|
10955
10947
|
:param performance_insights_retention_period: The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: - ``7`` - *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) - ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94`` , Amazon RDS returns an error.
|
|
10956
10948
|
:param port: The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: ``1150-65535`` Default: - RDS for Db2 - ``50000`` - RDS for MariaDB - ``3306`` - RDS for Microsoft SQL Server - ``1433`` - RDS for MySQL - ``3306`` - RDS for Oracle - ``1521`` - RDS for PostgreSQL - ``5432`` Constraints: - For RDS for Microsoft SQL Server, the value can't be ``1234`` , ``1434`` , ``3260`` , ``3343`` , ``3389`` , ``47001`` , or ``49152-49156`` .
|
|
10957
10949
|
:param preferred_backup_window: The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see `Backup Window <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow>`_ in the *Amazon RDS User Guide.* Constraints: - Must be in the format ``hh24:mi-hh24:mi`` . - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
|
|
10958
|
-
: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`` The default is 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. To see the time blocks available, see `
|
|
10950
|
+
: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`` The default is 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. To see the time blocks available, see `Maintaining a DB instance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow>`_ in the *Amazon RDS User Guide.* .. epigraph:: This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
|
|
10959
10951
|
:param processor_features: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
|
10960
10952
|
:param promotion_tier: The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see `Fault Tolerance for an Aurora DB Cluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance>`_ in the *Amazon Aurora User Guide* . This setting doesn't apply to RDS Custom DB instances. Default: ``1`` Valid Values: ``0 - 15``
|
|
10961
10953
|
:param publicly_accessible: Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the `CreateDBInstance <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html>`_ in the *Amazon RDS API Reference* .
|
|
@@ -10967,7 +10959,7 @@ class CfnDBInstanceProps:
|
|
|
10967
10959
|
:param source_dbi_resource_id: The resource ID of the source DB instance from which to restore.
|
|
10968
10960
|
:param source_region: The ID of the region that contains the source DB instance for the read replica.
|
|
10969
10961
|
:param storage_encrypted: A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
10970
|
-
:param storage_throughput: Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
10962
|
+
:param storage_throughput: Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
10971
10963
|
:param storage_type: The storage type to associate with the DB instance. If you specify ``io1`` , ``io2`` , or ``gp3`` , you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1`` , if the ``Iops`` parameter is specified. Otherwise, ``gp2`` .
|
|
10972
10964
|
:param tags: Tags to assign to the DB instance.
|
|
10973
10965
|
:param tde_credential_arn:
|
|
@@ -11786,7 +11778,7 @@ class CfnDBInstanceProps:
|
|
|
11786
11778
|
|
|
11787
11779
|
By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.
|
|
11788
11780
|
|
|
11789
|
-
Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the
|
|
11781
|
+
Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties, and the point-in-time recovery properties ``RestoreTime`` and ``UseLatestRestorableTime`` . For information about the properties that you can specify, see the ```RestoreDBInstanceFromDBSnapshot`` <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html>`_ action in the *Amazon RDS API Reference* .
|
|
11790
11782
|
|
|
11791
11783
|
After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.
|
|
11792
11784
|
|
|
@@ -12560,7 +12552,7 @@ class CfnDBInstanceProps:
|
|
|
12560
12552
|
|
|
12561
12553
|
Format: ``ddd:hh24:mi-ddd:hh24:mi``
|
|
12562
12554
|
|
|
12563
|
-
The default is 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. To see the time blocks available, see `
|
|
12555
|
+
The default is 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. To see the time blocks available, see `Maintaining a DB instance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow>`_ in the *Amazon RDS User Guide.*
|
|
12564
12556
|
.. epigraph::
|
|
12565
12557
|
|
|
12566
12558
|
This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
|
|
@@ -12750,7 +12742,9 @@ class CfnDBInstanceProps:
|
|
|
12750
12742
|
|
|
12751
12743
|
@builtins.property
|
|
12752
12744
|
def storage_throughput(self) -> typing.Optional[jsii.Number]:
|
|
12753
|
-
'''Specifies the storage throughput value
|
|
12745
|
+
'''Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance.
|
|
12746
|
+
|
|
12747
|
+
This setting applies only to the ``gp3`` storage type.
|
|
12754
12748
|
|
|
12755
12749
|
This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
12756
12750
|
|
|
@@ -19600,6 +19594,28 @@ class ClusterInstanceType(
|
|
|
19600
19594
|
|
|
19601
19595
|
@jsii.enum(jsii_type="aws-cdk-lib.aws_rds.ClusterScailabilityType")
|
|
19602
19596
|
class ClusterScailabilityType(enum.Enum):
|
|
19597
|
+
'''(deprecated) The scalability mode of the Aurora DB cluster.
|
|
19598
|
+
|
|
19599
|
+
:deprecated: Use ClusterScalabilityType instead. This will be removed in the next major version.
|
|
19600
|
+
|
|
19601
|
+
:stability: deprecated
|
|
19602
|
+
'''
|
|
19603
|
+
|
|
19604
|
+
STANDARD = "STANDARD"
|
|
19605
|
+
'''(deprecated) The cluster uses normal DB instance creation.
|
|
19606
|
+
|
|
19607
|
+
:stability: deprecated
|
|
19608
|
+
'''
|
|
19609
|
+
LIMITLESS = "LIMITLESS"
|
|
19610
|
+
'''(deprecated) The cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities.
|
|
19611
|
+
|
|
19612
|
+
:see: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/limitless.html
|
|
19613
|
+
:stability: deprecated
|
|
19614
|
+
'''
|
|
19615
|
+
|
|
19616
|
+
|
|
19617
|
+
@jsii.enum(jsii_type="aws-cdk-lib.aws_rds.ClusterScalabilityType")
|
|
19618
|
+
class ClusterScalabilityType(enum.Enum):
|
|
19603
19619
|
'''The scalability mode of the Aurora DB cluster.
|
|
19604
19620
|
|
|
19605
19621
|
:exampleMetadata: infused
|
|
@@ -19614,7 +19630,7 @@ class ClusterScailabilityType(enum.Enum):
|
|
|
19614
19630
|
version=rds.AuroraPostgresEngineVersion.VER_16_4_LIMITLESS
|
|
19615
19631
|
),
|
|
19616
19632
|
vpc=vpc,
|
|
19617
|
-
|
|
19633
|
+
cluster_scalability_type=rds.ClusterScalabilityType.LIMITLESS,
|
|
19618
19634
|
# Requires enabling Performance Insights
|
|
19619
19635
|
enable_performance_insights=True,
|
|
19620
19636
|
performance_insight_retention=rds.PerformanceInsightRetention.MONTHS_1,
|
|
@@ -20777,6 +20793,7 @@ class DatabaseClusterEngine(
|
|
|
20777
20793
|
"cloudwatch_logs_retention_role": "cloudwatchLogsRetentionRole",
|
|
20778
20794
|
"cluster_identifier": "clusterIdentifier",
|
|
20779
20795
|
"cluster_scailability_type": "clusterScailabilityType",
|
|
20796
|
+
"cluster_scalability_type": "clusterScalabilityType",
|
|
20780
20797
|
"copy_tags_to_snapshot": "copyTagsToSnapshot",
|
|
20781
20798
|
"credentials": "credentials",
|
|
20782
20799
|
"default_database_name": "defaultDatabaseName",
|
|
@@ -20834,6 +20851,7 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
20834
20851
|
cloudwatch_logs_retention_role: typing.Optional[_IRole_235f5d8e] = None,
|
|
20835
20852
|
cluster_identifier: typing.Optional[builtins.str] = None,
|
|
20836
20853
|
cluster_scailability_type: typing.Optional[ClusterScailabilityType] = None,
|
|
20854
|
+
cluster_scalability_type: typing.Optional[ClusterScalabilityType] = None,
|
|
20837
20855
|
copy_tags_to_snapshot: typing.Optional[builtins.bool] = None,
|
|
20838
20856
|
credentials: typing.Optional[Credentials] = None,
|
|
20839
20857
|
default_database_name: typing.Optional[builtins.str] = None,
|
|
@@ -20887,7 +20905,8 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
20887
20905
|
:param cloudwatch_logs_retention: The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``Infinity``. Default: - logs never expire
|
|
20888
20906
|
:param cloudwatch_logs_retention_role: The IAM role for the Lambda function associated with the custom resource that sets the retention policy. Default: - a new role is created.
|
|
20889
20907
|
:param cluster_identifier: An optional identifier for the cluster. Default: - A name is automatically generated.
|
|
20890
|
-
:param cluster_scailability_type: Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScailabilityType.STANDARD
|
|
20908
|
+
:param cluster_scailability_type: (deprecated) [Misspelled] Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScailabilityType.STANDARD
|
|
20909
|
+
:param cluster_scalability_type: Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScalabilityType.STANDARD
|
|
20891
20910
|
:param copy_tags_to_snapshot: Whether to copy tags to the snapshot when a snapshot is created. Default: - true
|
|
20892
20911
|
:param credentials: (deprecated) Credentials for the administrative user. Note - using this prop only works with ``Credentials.fromPassword()`` with the username of the snapshot, ``Credentials.fromUsername()`` with the username and password of the snapshot or ``Credentials.fromSecret()`` with a secret containing the username and password of the snapshot. Default: - A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password that **will not be applied** to the cluster, use ``snapshotCredentials`` for the correct behavior.
|
|
20893
20912
|
:param default_database_name: Name of a database which is automatically created inside the cluster. Default: - Database is not created in cluster.
|
|
@@ -20961,6 +20980,7 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
20961
20980
|
check_type(argname="argument cloudwatch_logs_retention_role", value=cloudwatch_logs_retention_role, expected_type=type_hints["cloudwatch_logs_retention_role"])
|
|
20962
20981
|
check_type(argname="argument cluster_identifier", value=cluster_identifier, expected_type=type_hints["cluster_identifier"])
|
|
20963
20982
|
check_type(argname="argument cluster_scailability_type", value=cluster_scailability_type, expected_type=type_hints["cluster_scailability_type"])
|
|
20983
|
+
check_type(argname="argument cluster_scalability_type", value=cluster_scalability_type, expected_type=type_hints["cluster_scalability_type"])
|
|
20964
20984
|
check_type(argname="argument copy_tags_to_snapshot", value=copy_tags_to_snapshot, expected_type=type_hints["copy_tags_to_snapshot"])
|
|
20965
20985
|
check_type(argname="argument credentials", value=credentials, expected_type=type_hints["credentials"])
|
|
20966
20986
|
check_type(argname="argument default_database_name", value=default_database_name, expected_type=type_hints["default_database_name"])
|
|
@@ -21022,6 +21042,8 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
21022
21042
|
self._values["cluster_identifier"] = cluster_identifier
|
|
21023
21043
|
if cluster_scailability_type is not None:
|
|
21024
21044
|
self._values["cluster_scailability_type"] = cluster_scailability_type
|
|
21045
|
+
if cluster_scalability_type is not None:
|
|
21046
|
+
self._values["cluster_scalability_type"] = cluster_scalability_type
|
|
21025
21047
|
if copy_tags_to_snapshot is not None:
|
|
21026
21048
|
self._values["copy_tags_to_snapshot"] = copy_tags_to_snapshot
|
|
21027
21049
|
if credentials is not None:
|
|
@@ -21203,15 +21225,30 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
21203
21225
|
|
|
21204
21226
|
@builtins.property
|
|
21205
21227
|
def cluster_scailability_type(self) -> typing.Optional[ClusterScailabilityType]:
|
|
21206
|
-
'''Specifies the scalability mode of the Aurora DB cluster.
|
|
21228
|
+
'''(deprecated) [Misspelled] Specifies the scalability mode of the Aurora DB cluster.
|
|
21207
21229
|
|
|
21208
21230
|
Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.
|
|
21209
21231
|
|
|
21210
21232
|
:default: ClusterScailabilityType.STANDARD
|
|
21233
|
+
|
|
21234
|
+
:deprecated: Use clusterScalabilityType instead. This will be removed in the next major version.
|
|
21235
|
+
|
|
21236
|
+
:stability: deprecated
|
|
21211
21237
|
'''
|
|
21212
21238
|
result = self._values.get("cluster_scailability_type")
|
|
21213
21239
|
return typing.cast(typing.Optional[ClusterScailabilityType], result)
|
|
21214
21240
|
|
|
21241
|
+
@builtins.property
|
|
21242
|
+
def cluster_scalability_type(self) -> typing.Optional[ClusterScalabilityType]:
|
|
21243
|
+
'''Specifies the scalability mode of the Aurora DB cluster.
|
|
21244
|
+
|
|
21245
|
+
Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.
|
|
21246
|
+
|
|
21247
|
+
:default: ClusterScalabilityType.STANDARD
|
|
21248
|
+
'''
|
|
21249
|
+
result = self._values.get("cluster_scalability_type")
|
|
21250
|
+
return typing.cast(typing.Optional[ClusterScalabilityType], result)
|
|
21251
|
+
|
|
21215
21252
|
@builtins.property
|
|
21216
21253
|
def copy_tags_to_snapshot(self) -> typing.Optional[builtins.bool]:
|
|
21217
21254
|
'''Whether to copy tags to the snapshot when a snapshot is created.
|
|
@@ -21716,6 +21753,7 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
21716
21753
|
"cloudwatch_logs_retention_role": "cloudwatchLogsRetentionRole",
|
|
21717
21754
|
"cluster_identifier": "clusterIdentifier",
|
|
21718
21755
|
"cluster_scailability_type": "clusterScailabilityType",
|
|
21756
|
+
"cluster_scalability_type": "clusterScalabilityType",
|
|
21719
21757
|
"copy_tags_to_snapshot": "copyTagsToSnapshot",
|
|
21720
21758
|
"credentials": "credentials",
|
|
21721
21759
|
"default_database_name": "defaultDatabaseName",
|
|
@@ -21771,6 +21809,7 @@ class DatabaseClusterProps:
|
|
|
21771
21809
|
cloudwatch_logs_retention_role: typing.Optional[_IRole_235f5d8e] = None,
|
|
21772
21810
|
cluster_identifier: typing.Optional[builtins.str] = None,
|
|
21773
21811
|
cluster_scailability_type: typing.Optional[ClusterScailabilityType] = None,
|
|
21812
|
+
cluster_scalability_type: typing.Optional[ClusterScalabilityType] = None,
|
|
21774
21813
|
copy_tags_to_snapshot: typing.Optional[builtins.bool] = None,
|
|
21775
21814
|
credentials: typing.Optional[Credentials] = None,
|
|
21776
21815
|
default_database_name: typing.Optional[builtins.str] = None,
|
|
@@ -21822,7 +21861,8 @@ class DatabaseClusterProps:
|
|
|
21822
21861
|
:param cloudwatch_logs_retention: The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``Infinity``. Default: - logs never expire
|
|
21823
21862
|
:param cloudwatch_logs_retention_role: The IAM role for the Lambda function associated with the custom resource that sets the retention policy. Default: - a new role is created.
|
|
21824
21863
|
:param cluster_identifier: An optional identifier for the cluster. Default: - A name is automatically generated.
|
|
21825
|
-
:param cluster_scailability_type: Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScailabilityType.STANDARD
|
|
21864
|
+
:param cluster_scailability_type: (deprecated) [Misspelled] Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScailabilityType.STANDARD
|
|
21865
|
+
:param cluster_scalability_type: Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScalabilityType.STANDARD
|
|
21826
21866
|
:param copy_tags_to_snapshot: Whether to copy tags to the snapshot when a snapshot is created. Default: - true
|
|
21827
21867
|
:param credentials: Credentials for the administrative user. Default: - A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password
|
|
21828
21868
|
:param default_database_name: Name of a database which is automatically created inside the cluster. Default: - Database is not created in cluster.
|
|
@@ -21903,6 +21943,7 @@ class DatabaseClusterProps:
|
|
|
21903
21943
|
check_type(argname="argument cloudwatch_logs_retention_role", value=cloudwatch_logs_retention_role, expected_type=type_hints["cloudwatch_logs_retention_role"])
|
|
21904
21944
|
check_type(argname="argument cluster_identifier", value=cluster_identifier, expected_type=type_hints["cluster_identifier"])
|
|
21905
21945
|
check_type(argname="argument cluster_scailability_type", value=cluster_scailability_type, expected_type=type_hints["cluster_scailability_type"])
|
|
21946
|
+
check_type(argname="argument cluster_scalability_type", value=cluster_scalability_type, expected_type=type_hints["cluster_scalability_type"])
|
|
21906
21947
|
check_type(argname="argument copy_tags_to_snapshot", value=copy_tags_to_snapshot, expected_type=type_hints["copy_tags_to_snapshot"])
|
|
21907
21948
|
check_type(argname="argument credentials", value=credentials, expected_type=type_hints["credentials"])
|
|
21908
21949
|
check_type(argname="argument default_database_name", value=default_database_name, expected_type=type_hints["default_database_name"])
|
|
@@ -21962,6 +22003,8 @@ class DatabaseClusterProps:
|
|
|
21962
22003
|
self._values["cluster_identifier"] = cluster_identifier
|
|
21963
22004
|
if cluster_scailability_type is not None:
|
|
21964
22005
|
self._values["cluster_scailability_type"] = cluster_scailability_type
|
|
22006
|
+
if cluster_scalability_type is not None:
|
|
22007
|
+
self._values["cluster_scalability_type"] = cluster_scalability_type
|
|
21965
22008
|
if copy_tags_to_snapshot is not None:
|
|
21966
22009
|
self._values["copy_tags_to_snapshot"] = copy_tags_to_snapshot
|
|
21967
22010
|
if credentials is not None:
|
|
@@ -22130,15 +22173,30 @@ class DatabaseClusterProps:
|
|
|
22130
22173
|
|
|
22131
22174
|
@builtins.property
|
|
22132
22175
|
def cluster_scailability_type(self) -> typing.Optional[ClusterScailabilityType]:
|
|
22133
|
-
'''Specifies the scalability mode of the Aurora DB cluster.
|
|
22176
|
+
'''(deprecated) [Misspelled] Specifies the scalability mode of the Aurora DB cluster.
|
|
22134
22177
|
|
|
22135
22178
|
Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.
|
|
22136
22179
|
|
|
22137
22180
|
:default: ClusterScailabilityType.STANDARD
|
|
22181
|
+
|
|
22182
|
+
:deprecated: Use clusterScalabilityType instead. This will be removed in the next major version.
|
|
22183
|
+
|
|
22184
|
+
:stability: deprecated
|
|
22138
22185
|
'''
|
|
22139
22186
|
result = self._values.get("cluster_scailability_type")
|
|
22140
22187
|
return typing.cast(typing.Optional[ClusterScailabilityType], result)
|
|
22141
22188
|
|
|
22189
|
+
@builtins.property
|
|
22190
|
+
def cluster_scalability_type(self) -> typing.Optional[ClusterScalabilityType]:
|
|
22191
|
+
'''Specifies the scalability mode of the Aurora DB cluster.
|
|
22192
|
+
|
|
22193
|
+
Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.
|
|
22194
|
+
|
|
22195
|
+
:default: ClusterScalabilityType.STANDARD
|
|
22196
|
+
'''
|
|
22197
|
+
result = self._values.get("cluster_scalability_type")
|
|
22198
|
+
return typing.cast(typing.Optional[ClusterScalabilityType], result)
|
|
22199
|
+
|
|
22142
22200
|
@builtins.property
|
|
22143
22201
|
def copy_tags_to_snapshot(self) -> typing.Optional[builtins.bool]:
|
|
22144
22202
|
'''Whether to copy tags to the snapshot when a snapshot is created.
|
|
@@ -41389,6 +41447,7 @@ class DatabaseClusterFromSnapshot(
|
|
|
41389
41447
|
cloudwatch_logs_retention_role: typing.Optional[_IRole_235f5d8e] = None,
|
|
41390
41448
|
cluster_identifier: typing.Optional[builtins.str] = None,
|
|
41391
41449
|
cluster_scailability_type: typing.Optional[ClusterScailabilityType] = None,
|
|
41450
|
+
cluster_scalability_type: typing.Optional[ClusterScalabilityType] = None,
|
|
41392
41451
|
copy_tags_to_snapshot: typing.Optional[builtins.bool] = None,
|
|
41393
41452
|
credentials: typing.Optional[Credentials] = None,
|
|
41394
41453
|
default_database_name: typing.Optional[builtins.str] = None,
|
|
@@ -41443,7 +41502,8 @@ class DatabaseClusterFromSnapshot(
|
|
|
41443
41502
|
:param cloudwatch_logs_retention: The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``Infinity``. Default: - logs never expire
|
|
41444
41503
|
:param cloudwatch_logs_retention_role: The IAM role for the Lambda function associated with the custom resource that sets the retention policy. Default: - a new role is created.
|
|
41445
41504
|
:param cluster_identifier: An optional identifier for the cluster. Default: - A name is automatically generated.
|
|
41446
|
-
:param cluster_scailability_type: Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScailabilityType.STANDARD
|
|
41505
|
+
:param cluster_scailability_type: (deprecated) [Misspelled] Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScailabilityType.STANDARD
|
|
41506
|
+
:param cluster_scalability_type: Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScalabilityType.STANDARD
|
|
41447
41507
|
:param copy_tags_to_snapshot: Whether to copy tags to the snapshot when a snapshot is created. Default: - true
|
|
41448
41508
|
:param credentials: (deprecated) Credentials for the administrative user. Note - using this prop only works with ``Credentials.fromPassword()`` with the username of the snapshot, ``Credentials.fromUsername()`` with the username and password of the snapshot or ``Credentials.fromSecret()`` with a secret containing the username and password of the snapshot. Default: - A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password that **will not be applied** to the cluster, use ``snapshotCredentials`` for the correct behavior.
|
|
41449
41509
|
:param default_database_name: Name of a database which is automatically created inside the cluster. Default: - Database is not created in cluster.
|
|
@@ -41501,6 +41561,7 @@ class DatabaseClusterFromSnapshot(
|
|
|
41501
41561
|
cloudwatch_logs_retention_role=cloudwatch_logs_retention_role,
|
|
41502
41562
|
cluster_identifier=cluster_identifier,
|
|
41503
41563
|
cluster_scailability_type=cluster_scailability_type,
|
|
41564
|
+
cluster_scalability_type=cluster_scalability_type,
|
|
41504
41565
|
copy_tags_to_snapshot=copy_tags_to_snapshot,
|
|
41505
41566
|
credentials=credentials,
|
|
41506
41567
|
default_database_name=default_database_name,
|
|
@@ -45480,6 +45541,7 @@ class DatabaseCluster(
|
|
|
45480
45541
|
cloudwatch_logs_retention_role: typing.Optional[_IRole_235f5d8e] = None,
|
|
45481
45542
|
cluster_identifier: typing.Optional[builtins.str] = None,
|
|
45482
45543
|
cluster_scailability_type: typing.Optional[ClusterScailabilityType] = None,
|
|
45544
|
+
cluster_scalability_type: typing.Optional[ClusterScalabilityType] = None,
|
|
45483
45545
|
copy_tags_to_snapshot: typing.Optional[builtins.bool] = None,
|
|
45484
45546
|
credentials: typing.Optional[Credentials] = None,
|
|
45485
45547
|
default_database_name: typing.Optional[builtins.str] = None,
|
|
@@ -45532,7 +45594,8 @@ class DatabaseCluster(
|
|
|
45532
45594
|
:param cloudwatch_logs_retention: The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``Infinity``. Default: - logs never expire
|
|
45533
45595
|
:param cloudwatch_logs_retention_role: The IAM role for the Lambda function associated with the custom resource that sets the retention policy. Default: - a new role is created.
|
|
45534
45596
|
:param cluster_identifier: An optional identifier for the cluster. Default: - A name is automatically generated.
|
|
45535
|
-
:param cluster_scailability_type: Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScailabilityType.STANDARD
|
|
45597
|
+
:param cluster_scailability_type: (deprecated) [Misspelled] Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScailabilityType.STANDARD
|
|
45598
|
+
:param cluster_scalability_type: Specifies the scalability mode of the Aurora DB cluster. Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD. Default: ClusterScalabilityType.STANDARD
|
|
45536
45599
|
:param copy_tags_to_snapshot: Whether to copy tags to the snapshot when a snapshot is created. Default: - true
|
|
45537
45600
|
:param credentials: Credentials for the administrative user. Default: - A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password
|
|
45538
45601
|
:param default_database_name: Name of a database which is automatically created inside the cluster. Default: - Database is not created in cluster.
|
|
@@ -45588,6 +45651,7 @@ class DatabaseCluster(
|
|
|
45588
45651
|
cloudwatch_logs_retention_role=cloudwatch_logs_retention_role,
|
|
45589
45652
|
cluster_identifier=cluster_identifier,
|
|
45590
45653
|
cluster_scailability_type=cluster_scailability_type,
|
|
45654
|
+
cluster_scalability_type=cluster_scalability_type,
|
|
45591
45655
|
copy_tags_to_snapshot=copy_tags_to_snapshot,
|
|
45592
45656
|
credentials=credentials,
|
|
45593
45657
|
default_database_name=default_database_name,
|
|
@@ -46483,6 +46547,7 @@ __all__ = [
|
|
|
46483
46547
|
"ClusterInstanceProps",
|
|
46484
46548
|
"ClusterInstanceType",
|
|
46485
46549
|
"ClusterScailabilityType",
|
|
46550
|
+
"ClusterScalabilityType",
|
|
46486
46551
|
"CommonRotationUserOptions",
|
|
46487
46552
|
"Credentials",
|
|
46488
46553
|
"CredentialsBaseOptions",
|
|
@@ -49263,6 +49328,7 @@ def _typecheckingstub__1e44b5aef872ca17869a17181382f06cd0166bdbe07e2c33701d3bf1e
|
|
|
49263
49328
|
cloudwatch_logs_retention_role: typing.Optional[_IRole_235f5d8e] = None,
|
|
49264
49329
|
cluster_identifier: typing.Optional[builtins.str] = None,
|
|
49265
49330
|
cluster_scailability_type: typing.Optional[ClusterScailabilityType] = None,
|
|
49331
|
+
cluster_scalability_type: typing.Optional[ClusterScalabilityType] = None,
|
|
49266
49332
|
copy_tags_to_snapshot: typing.Optional[builtins.bool] = None,
|
|
49267
49333
|
credentials: typing.Optional[Credentials] = None,
|
|
49268
49334
|
default_database_name: typing.Optional[builtins.str] = None,
|
|
@@ -49319,6 +49385,7 @@ def _typecheckingstub__a32e21c90ab65d3cfdb3b7ef2a0d741ba1528ec8824cd1817d1e485b4
|
|
|
49319
49385
|
cloudwatch_logs_retention_role: typing.Optional[_IRole_235f5d8e] = None,
|
|
49320
49386
|
cluster_identifier: typing.Optional[builtins.str] = None,
|
|
49321
49387
|
cluster_scailability_type: typing.Optional[ClusterScailabilityType] = None,
|
|
49388
|
+
cluster_scalability_type: typing.Optional[ClusterScalabilityType] = None,
|
|
49322
49389
|
copy_tags_to_snapshot: typing.Optional[builtins.bool] = None,
|
|
49323
49390
|
credentials: typing.Optional[Credentials] = None,
|
|
49324
49391
|
default_database_name: typing.Optional[builtins.str] = None,
|
|
@@ -50533,6 +50600,7 @@ def _typecheckingstub__d1a2e259091e12a41b0f5818df495769518e049ebcc89ed340ffc7ba4
|
|
|
50533
50600
|
cloudwatch_logs_retention_role: typing.Optional[_IRole_235f5d8e] = None,
|
|
50534
50601
|
cluster_identifier: typing.Optional[builtins.str] = None,
|
|
50535
50602
|
cluster_scailability_type: typing.Optional[ClusterScailabilityType] = None,
|
|
50603
|
+
cluster_scalability_type: typing.Optional[ClusterScalabilityType] = None,
|
|
50536
50604
|
copy_tags_to_snapshot: typing.Optional[builtins.bool] = None,
|
|
50537
50605
|
credentials: typing.Optional[Credentials] = None,
|
|
50538
50606
|
default_database_name: typing.Optional[builtins.str] = None,
|
|
@@ -51024,6 +51092,7 @@ def _typecheckingstub__c6184cbbefaa372690b9776dafecbf5857cf9bfbab91d1666aad22c56
|
|
|
51024
51092
|
cloudwatch_logs_retention_role: typing.Optional[_IRole_235f5d8e] = None,
|
|
51025
51093
|
cluster_identifier: typing.Optional[builtins.str] = None,
|
|
51026
51094
|
cluster_scailability_type: typing.Optional[ClusterScailabilityType] = None,
|
|
51095
|
+
cluster_scalability_type: typing.Optional[ClusterScalabilityType] = None,
|
|
51027
51096
|
copy_tags_to_snapshot: typing.Optional[builtins.bool] = None,
|
|
51028
51097
|
credentials: typing.Optional[Credentials] = None,
|
|
51029
51098
|
default_database_name: typing.Optional[builtins.str] = None,
|
aws_cdk/aws_redshift/__init__.py
CHANGED
|
@@ -249,7 +249,7 @@ class CfnCluster(
|
|
|
249
249
|
:param defer_maintenance_start_time: A timestamp indicating the start time for the deferred maintenance window.
|
|
250
250
|
:param destination_region: The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
|
|
251
251
|
:param elastic_ip: The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to `Supported Platforms to Launch Your Cluster <https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms>`_ in the Amazon Redshift Cluster Management Guide.
|
|
252
|
-
:param encrypted: If ``true`` , the data in the cluster is encrypted at rest. Default:
|
|
252
|
+
:param encrypted: If ``true`` , the data in the cluster is encrypted at rest. If you set the value on this parameter to ``false`` , the request will fail. Default: true
|
|
253
253
|
:param endpoint: The connection endpoint.
|
|
254
254
|
:param enhanced_vpc_routing: An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see `Enhanced VPC Routing <https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html>`_ in the Amazon Redshift Cluster Management Guide. If this option is ``true`` , enhanced VPC routing is enabled. Default: false
|
|
255
255
|
:param hsm_client_certificate_identifier: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
|
|
@@ -268,7 +268,7 @@ class CfnCluster(
|
|
|
268
268
|
:param owner_account: The AWS account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
|
|
269
269
|
:param port: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: ``5439`` Valid Values: - For clusters with ra3 nodes - Select a port within the ranges ``5431-5455`` or ``8191-8215`` . (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.) - For clusters with dc2 nodes - Select a port within the range ``1150-65535`` .
|
|
270
270
|
:param preferred_maintenance_window: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ``ddd:hh24:mi-ddd:hh24:mi`` Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see `Maintenance Windows <https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows>`_ in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
|
|
271
|
-
:param publicly_accessible: If ``true`` , the cluster can be accessed from a public network.
|
|
271
|
+
:param publicly_accessible: If ``true`` , the cluster can be accessed from a public network. Default: false
|
|
272
272
|
:param resource_action: The Amazon Redshift operation to be performed. Supported operations are ``pause-cluster`` , ``resume-cluster`` , and ``failover-primary-compute`` .
|
|
273
273
|
:param revision_target: Describes a ``RevisionTarget`` object.
|
|
274
274
|
:param rotate_encryption_key: Rotates the encryption keys for a cluster.
|
|
@@ -1948,7 +1948,7 @@ class CfnClusterProps:
|
|
|
1948
1948
|
:param defer_maintenance_start_time: A timestamp indicating the start time for the deferred maintenance window.
|
|
1949
1949
|
:param destination_region: The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
|
|
1950
1950
|
:param elastic_ip: The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to `Supported Platforms to Launch Your Cluster <https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms>`_ in the Amazon Redshift Cluster Management Guide.
|
|
1951
|
-
:param encrypted: If ``true`` , the data in the cluster is encrypted at rest. Default:
|
|
1951
|
+
:param encrypted: If ``true`` , the data in the cluster is encrypted at rest. If you set the value on this parameter to ``false`` , the request will fail. Default: true
|
|
1952
1952
|
:param endpoint: The connection endpoint.
|
|
1953
1953
|
:param enhanced_vpc_routing: An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see `Enhanced VPC Routing <https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html>`_ in the Amazon Redshift Cluster Management Guide. If this option is ``true`` , enhanced VPC routing is enabled. Default: false
|
|
1954
1954
|
:param hsm_client_certificate_identifier: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
|
|
@@ -1967,7 +1967,7 @@ class CfnClusterProps:
|
|
|
1967
1967
|
:param owner_account: The AWS account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
|
|
1968
1968
|
:param port: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: ``5439`` Valid Values: - For clusters with ra3 nodes - Select a port within the ranges ``5431-5455`` or ``8191-8215`` . (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.) - For clusters with dc2 nodes - Select a port within the range ``1150-65535`` .
|
|
1969
1969
|
:param preferred_maintenance_window: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ``ddd:hh24:mi-ddd:hh24:mi`` Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see `Maintenance Windows <https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows>`_ in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
|
|
1970
|
-
:param publicly_accessible: If ``true`` , the cluster can be accessed from a public network.
|
|
1970
|
+
:param publicly_accessible: If ``true`` , the cluster can be accessed from a public network. Default: false
|
|
1971
1971
|
:param resource_action: The Amazon Redshift operation to be performed. Supported operations are ``pause-cluster`` , ``resume-cluster`` , and ``failover-primary-compute`` .
|
|
1972
1972
|
:param revision_target: Describes a ``RevisionTarget`` object.
|
|
1973
1973
|
:param rotate_encryption_key: Rotates the encryption keys for a cluster.
|
|
@@ -2516,7 +2516,9 @@ class CfnClusterProps:
|
|
|
2516
2516
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
2517
2517
|
'''If ``true`` , the data in the cluster is encrypted at rest.
|
|
2518
2518
|
|
|
2519
|
-
|
|
2519
|
+
If you set the value on this parameter to ``false`` , the request will fail.
|
|
2520
|
+
|
|
2521
|
+
Default: true
|
|
2520
2522
|
|
|
2521
2523
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-encrypted
|
|
2522
2524
|
'''
|
|
@@ -2762,6 +2764,8 @@ class CfnClusterProps:
|
|
|
2762
2764
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
2763
2765
|
'''If ``true`` , the cluster can be accessed from a public network.
|
|
2764
2766
|
|
|
2767
|
+
Default: false
|
|
2768
|
+
|
|
2765
2769
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-cluster.html#cfn-redshift-cluster-publiclyaccessible
|
|
2766
2770
|
'''
|
|
2767
2771
|
result = self._values.get("publicly_accessible")
|