CfnDBClusterProps¶
-
class
aws_cdk.aws_rds.
CfnDBClusterProps
(*, engine, associated_roles=None, availability_zones=None, backtrack_window=None, backup_retention_period=None, copy_tags_to_snapshot=None, database_name=None, db_cluster_identifier=None, db_cluster_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enable_cloudwatch_logs_exports=None, enable_http_endpoint=None, enable_iam_database_authentication=None, engine_mode=None, engine_version=None, global_cluster_identifier=None, kms_key_id=None, master_username=None, master_user_password=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, replication_source_identifier=None, restore_type=None, scaling_configuration=None, snapshot_identifier=None, source_db_cluster_identifier=None, source_region=None, storage_encrypted=None, tags=None, use_latest_restorable_time=None, vpc_security_group_ids=None)¶ Bases:
object
Properties for defining a
CfnDBCluster
.- Parameters
engine (
str
) – The name of the database engine to be used for this DB cluster. Valid Values:aurora
(for MySQL 5.6-compatible Aurora),aurora-mysql
(for MySQL 5.7-compatible Aurora), andaurora-postgresql
associated_roles (
Union
[IResolvable
,Sequence
[Union
[DBClusterRoleProperty
,IResolvable
]],None
]) – Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.availability_zones (
Optional
[Sequence
[str
]]) – A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .backtrack_window (
Union
[int
,float
,None
]) – The target backtrack window, in seconds. To disable backtracking, set this value to 0. .. epigraph:: Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: - If specified, this value must be set to a number from 0 to 259,200 (72 hours).backup_retention_period (
Union
[int
,float
,None
]) – The number of days for which automated backups are retained. Default: 1 Constraints: - Must be a value from 1 to 35copy_tags_to_snapshot (
Union
[bool
,IResolvable
,None
]) – A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.database_name (
Optional
[str
]) – The name of your database. If you don’t provide a name, then Amazon RDS won’t create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon Aurora User Guide .db_cluster_identifier (
Optional
[str
]) – The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Can’t end with a hyphen or contain two consecutive hyphens. Example:my-cluster1
db_cluster_parameter_group_name (
Optional
[str
]) – The name of the DB cluster parameter group to associate with this DB cluster. .. epigraph:: If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started. To list all of the available DB cluster parameter group names, use the following command:aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
db_subnet_group_name (
Optional
[str
]) – A DB subnet group that you want to associate with this DB cluster. If you are restoring a DB cluster to a point in time withRestoreType
set tocopy-on-write
, and don’t specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.deletion_protection (
Union
[bool
,IResolvable
,None
]) – A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.enable_cloudwatch_logs_exports (
Optional
[Sequence
[str
]]) – The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide . Aurora MySQL Valid values:audit
,error
,general
,slowquery
Aurora PostgreSQL Valid values:postgresql
enable_http_endpoint (
Union
[bool
,IResolvable
,None
]) – A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .enable_iam_database_authentication (
Union
[bool
,IResolvable
,None
]) – A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.engine_mode (
Optional
[str
]) – The DB engine mode of the DB cluster, eitherprovisioned
,serverless
,parallelquery
,global
, ormultimaster
. Theserverless
engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn’t support Aurora Serverless v2. Theparallelquery
engine mode isn’t required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. Theglobal
engine mode isn’t required for Aurora MySQL version 1.22 and higher 1.x versions, andglobal
engine mode isn’t required for any 2.x versions. Themultimaster
engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. For Aurora PostgreSQL, theglobal
engine mode isn’t required, and both theparallelquery
and themultimaster
engine modes currently aren’t supported. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide : - Limitations of Aurora Serverless - Limitations of Parallel Query - Limitations of Aurora Global Databases - Limitations of Multi-Master Clustersengine_version (
Optional
[str
]) – The version number of the database engine to use. To list all of the available engine versions foraurora
(for MySQL 5.6-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions foraurora-mysql
(for MySQL 5.7-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions foraurora-postgresql
, use the following command:aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
global_cluster_identifier (
Optional
[str
]) – If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. If you aren’t configuring a global database cluster, don’t specify this property. .. epigraph:: To remove the DB cluster from a global database cluster, specify an empty value for theGlobalClusterIdentifier
property. For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .kms_key_id (
Optional
[str
]) – The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such asarn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable theStorageEncrypted
property but don’t specify this property, the default KMS key is used. If you specify this property, you must set theStorageEncrypted
property totrue
. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB cluster is encrypted, the specifiedKmsKeyId
property is used.master_username (
Optional
[str
]) – The name of the master user for the DB cluster. .. epigraph:: If you specify theSourceDBClusterIdentifier
,SnapshotIdentifier
, orGlobalClusterIdentifier
property, don’t specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.master_user_password (
Optional
[str
]) – The master password for the DB instance. .. epigraph:: If you specify theSourceDBClusterIdentifier
,SnapshotIdentifier
, orGlobalClusterIdentifier
property, don’t specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.port (
Union
[int
,float
,None
]) – The port number on which the DB instances in the DB cluster accept connections. Default: - WhenEngineMode
isprovisioned
,3306
(for both Aurora MySQL and Aurora PostgreSQL) - WhenEngineMode
isserverless
: -3306
whenEngine
isaurora
oraurora-mysql
-5432
whenEngine
isaurora-postgresql
.. epigraph:: TheNo interruption
on update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.preferred_backup_window (
Optional
[str
]) – The daily time range during which automated backups are created. For more information, see Backup Window in the Amazon Aurora User Guide. Constraints: - Must be in the formathh24:mi-hh24:mi
. - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes.preferred_maintenance_window (
Optional
[str
]) – 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 Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.replication_source_identifier (
Optional
[str
]) – The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.restore_type (
Optional
[str
]) – The type of restore to be performed. You can specify one of the following values:. -full-copy
- The new DB cluster is restored as a full copy of the source DB cluster. -copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can’t specifycopy-on-write
if the engine version of the source DB cluster is earlier than 1.11. If you don’t specify aRestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.scaling_configuration (
Union
[IResolvable
,ScalingConfigurationProperty
,None
]) – TheScalingConfiguration
property type specifies the scaling configuration of an Aurora Serverless DB cluster. Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn’t support Aurora Serverless v2.snapshot_identifier (
Optional
[str
]) – The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. After you restore a DB cluster with aSnapshotIdentifier
property, you must specify the sameSnapshotIdentifier
property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don’t specify theSnapshotIdentifier
property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specifiedSnapshotIdentifier
property, and the original DB cluster is deleted. If you specify theSnapshotIdentifier
property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don’t specify the following properties: -GlobalClusterIdentifier
-MasterUsername
-MasterUserPassword
-ReplicationSourceIdentifier
-RestoreType
-SourceDBClusterIdentifier
-SourceRegion
-StorageEncrypted
(for an encrypted snapshot) -UseLatestRestorableTime
Constraints: - Must match the identifier of an existing Snapshot.source_db_cluster_identifier (
Optional
[str
]) – When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore. Constraints: - Must match the identifier of an existing DBCluster.source_region (
Optional
[str
]) – The AWS Region which contains the source DB cluster when replicating a DB cluster. For example,us-east-1
.storage_encrypted (
Union
[bool
,IResolvable
,None
]) – Indicates whether the DB cluster is encrypted. If you specify theKmsKeyId
property, then you must enable encryption. If you specify theSourceDBClusterIdentifier
property, don’t specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specifiedKmsKeyId
property is used. If you specify theSnapshotIdentifier
and the specified snapshot is encrypted, don’t specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theSnapshotIdentifier
and the specified snapshot isn’t encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don’t want the restored DB cluster to be encrypted, then don’t set this property or set it tofalse
.tags (
Optional
[Sequence
[CfnTag
]]) – Tags to assign to the DB cluster.use_latest_restorable_time (
Union
[bool
,IResolvable
,None
]) – A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.vpc_security_group_ids (
Optional
[Sequence
[str
]]) – A list of EC2 VPC security groups to associate with this DB cluster. If you plan to update the resource, don’t specify VPC security groups in a shared VPC.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_rds as rds cfn_dBCluster_props = rds.CfnDBClusterProps( engine="engine", # the properties below are optional associated_roles=[rds.CfnDBCluster.DBClusterRoleProperty( role_arn="roleArn", # the properties below are optional feature_name="featureName" )], availability_zones=["availabilityZones"], backtrack_window=123, backup_retention_period=123, copy_tags_to_snapshot=False, database_name="databaseName", db_cluster_identifier="dbClusterIdentifier", db_cluster_parameter_group_name="dbClusterParameterGroupName", db_subnet_group_name="dbSubnetGroupName", deletion_protection=False, enable_cloudwatch_logs_exports=["enableCloudwatchLogsExports"], enable_http_endpoint=False, enable_iam_database_authentication=False, engine_mode="engineMode", engine_version="engineVersion", global_cluster_identifier="globalClusterIdentifier", kms_key_id="kmsKeyId", master_username="masterUsername", master_user_password="masterUserPassword", port=123, preferred_backup_window="preferredBackupWindow", preferred_maintenance_window="preferredMaintenanceWindow", replication_source_identifier="replicationSourceIdentifier", restore_type="restoreType", scaling_configuration=rds.CfnDBCluster.ScalingConfigurationProperty( auto_pause=False, max_capacity=123, min_capacity=123, seconds_until_auto_pause=123 ), snapshot_identifier="snapshotIdentifier", source_db_cluster_identifier="sourceDbClusterIdentifier", source_region="sourceRegion", storage_encrypted=False, tags=[CfnTag( key="key", value="value" )], use_latest_restorable_time=False, vpc_security_group_ids=["vpcSecurityGroupIds"] )
Attributes
-
associated_roles
¶ Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
- Link
- Return type
Union
[IResolvable
,List
[Union
[DBClusterRoleProperty
,IResolvable
]],None
]
-
availability_zones
¶ A list of Availability Zones (AZs) where instances in the DB cluster can be created.
For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
- Link
- Return type
Optional
[List
[str
]]
-
backtrack_window
¶ The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
- Link
- Return type
Union
[int
,float
,None
]
-
backup_retention_period
¶ The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
- Link
- Return type
Union
[int
,float
,None
]
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
The default is not to copy them.
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
database_name
¶ The name of your database.
If you don’t provide a name, then Amazon RDS won’t create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon Aurora User Guide .
- Link
- Return type
Optional
[str
]
-
db_cluster_identifier
¶ The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
-
db_cluster_parameter_group_name
¶ The name of the DB cluster parameter group to associate with this DB cluster.
If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
To list all of the available DB cluster parameter group names, use the following command:
aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
-
db_subnet_group_name
¶ A DB subnet group that you want to associate with this DB cluster.
If you are restoring a DB cluster to a point in time with
RestoreType
set tocopy-on-write
, and don’t specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
-
deletion_protection
¶ A value that indicates whether the DB cluster has deletion protection enabled.
The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
enable_cloudwatch_logs_exports
¶ The list of log types that need to be enabled for exporting to CloudWatch Logs.
The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Aurora MySQL
Valid values:
audit
,error
,general
,slowquery
Aurora PostgreSQL
Valid values:
postgresql
- Link
- Return type
Optional
[List
[str
]]
-
enable_http_endpoint
¶ A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
enable_iam_database_authentication
¶ A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
-
engine
¶ The name of the database engine to be used for this DB cluster.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora),aurora-mysql
(for MySQL 5.7-compatible Aurora), andaurora-postgresql
-
engine_mode
¶ The DB engine mode of the DB cluster, either
provisioned
,serverless
,parallelquery
,global
, ormultimaster
.The
serverless
engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn’t support Aurora Serverless v2.The
parallelquery
engine mode isn’t required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.The
global
engine mode isn’t required for Aurora MySQL version 1.22 and higher 1.x versions, andglobal
engine mode isn’t required for any 2.x versions.The
multimaster
engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.For Aurora PostgreSQL, the
global
engine mode isn’t required, and both theparallelquery
and themultimaster
engine modes currently aren’t supported.Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :
- Link
- Return type
Optional
[str
]
-
engine_version
¶ The version number of the database engine to use.
To list all of the available engine versions for
aurora
(for MySQL 5.6-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for
aurora-mysql
(for MySQL 5.7-compatible Aurora), use the following command:aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for
aurora-postgresql
, use the following command:aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
-
global_cluster_identifier
¶ If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
If you aren’t configuring a global database cluster, don’t specify this property. .. epigraph:
To remove the DB cluster from a global database cluster, specify an empty value for the ``GlobalClusterIdentifier`` property.
For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
-
kms_key_id
¶ The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
.If you enable the
StorageEncrypted
property but don’t specify this property, the default KMS key is used. If you specify this property, you must set theStorageEncrypted
property totrue
.If you specify the
SnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB cluster is encrypted, the specifiedKmsKeyId
property is used.- Link
- Return type
Optional
[str
]
-
master_user_password
¶ The master password for the DB instance.
If you specify the
SourceDBClusterIdentifier
,SnapshotIdentifier
, orGlobalClusterIdentifier
property, don’t specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
-
master_username
¶ The name of the master user for the DB cluster.
If you specify the
SourceDBClusterIdentifier
,SnapshotIdentifier
, orGlobalClusterIdentifier
property, don’t specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
-
port
¶ The port number on which the DB instances in the DB cluster accept connections.
Default:
When
EngineMode
isprovisioned
,3306
(for both Aurora MySQL and Aurora PostgreSQL)When
EngineMode
isserverless
:3306
whenEngine
isaurora
oraurora-mysql
5432
whenEngine
isaurora-postgresql
The
No interruption
on update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.- Link
- Return type
Union
[int
,float
,None
]
-
preferred_backup_window
¶ The daily time range during which automated backups are created.
For more information, see Backup Window 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.
-
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 Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
-
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.
-
restore_type
¶ .
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can’t specify
copy-on-write
if the engine version of the source DB cluster is earlier than 1.11.If you don’t specify a
RestoreType
value, then the new DB cluster is restored as a full copy of the source DB cluster.- Link
- Type
The type of restore to be performed. You can specify one of the following values
- Return type
Optional
[str
]
-
scaling_configuration
¶ The
ScalingConfiguration
property type specifies the scaling configuration of an Aurora Serverless DB cluster.Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn’t support Aurora Serverless v2.
-
snapshot_identifier
¶ The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
After you restore a DB cluster with a
SnapshotIdentifier
property, you must specify the sameSnapshotIdentifier
property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don’t specify theSnapshotIdentifier
property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specifiedSnapshotIdentifier
property, and the original DB cluster is deleted.If you specify the
SnapshotIdentifier
property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don’t specify the following properties:GlobalClusterIdentifier
MasterUsername
MasterUserPassword
ReplicationSourceIdentifier
RestoreType
SourceDBClusterIdentifier
SourceRegion
StorageEncrypted
(for an encrypted snapshot)UseLatestRestorableTime
Constraints:
Must match the identifier of an existing Snapshot.
-
source_db_cluster_identifier
¶ When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
-
source_region
¶ The AWS Region which contains the source DB cluster when replicating a DB cluster.
For example,
us-east-1
.- Link
- Return type
Optional
[str
]
-
storage_encrypted
¶ Indicates whether the DB cluster is encrypted.
If you specify the
KmsKeyId
property, then you must enable encryption.If you specify the
SourceDBClusterIdentifier
property, don’t specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specifiedKmsKeyId
property is used.If you specify the
SnapshotIdentifier
and the specified snapshot is encrypted, don’t specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used.If you specify the
SnapshotIdentifier
and the specified snapshot isn’t encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don’t want the restored DB cluster to be encrypted, then don’t set this property or set it tofalse
.- Link
- Return type
Union
[bool
,IResolvable
,None
]
Tags to assign to the DB cluster.
- Link
- Return type
Optional
[List
[CfnTag
]]
-
use_latest_restorable_time
¶ A value that indicates whether to restore the DB cluster to the latest restorable backup time.
By default, the DB cluster is not restored to the latest restorable backup time.
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
vpc_security_group_ids
¶ A list of EC2 VPC security groups to associate with this DB cluster.
If you plan to update the resource, don’t specify VPC security groups in a shared VPC.
- Link
- Return type
Optional
[List
[str
]]