Class CfnDBClusterProps

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html

CfnDBClusterProps

Implements

ICfnDBClusterProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDBClusterProps : ICfnDBClusterProps

Syntax (vb)

Public Class CfnDBClusterProps Implements ICfnDBClusterProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var cfnDBClusterProps = new CfnDBClusterProps {
                 AllocatedStorage = 123,
                 AssociatedRoles = new [] { new DBClusterRoleProperty {
                     RoleArn = "roleArn",

                     // the properties below are optional
                     FeatureName = "featureName"
                 } },
                 AutoMinorVersionUpgrade = false,
                 AvailabilityZones = new [] { "availabilityZones" },
                 BacktrackWindow = 123,
                 BackupRetentionPeriod = 123,
                 ClusterScalabilityType = "clusterScalabilityType",
                 CopyTagsToSnapshot = false,
                 DatabaseInsightsMode = "databaseInsightsMode",
                 DatabaseName = "databaseName",
                 DbClusterIdentifier = "dbClusterIdentifier",
                 DbClusterInstanceClass = "dbClusterInstanceClass",
                 DbClusterParameterGroupName = "dbClusterParameterGroupName",
                 DbInstanceParameterGroupName = "dbInstanceParameterGroupName",
                 DbSubnetGroupName = "dbSubnetGroupName",
                 DbSystemId = "dbSystemId",
                 DeleteAutomatedBackups = false,
                 DeletionProtection = false,
                 Domain = "domain",
                 DomainIamRoleName = "domainIamRoleName",
                 EnableCloudwatchLogsExports = new [] { "enableCloudwatchLogsExports" },
                 EnableGlobalWriteForwarding = false,
                 EnableHttpEndpoint = false,
                 EnableIamDatabaseAuthentication = false,
                 EnableLocalWriteForwarding = false,
                 Engine = "engine",
                 EngineLifecycleSupport = "engineLifecycleSupport",
                 EngineMode = "engineMode",
                 EngineVersion = "engineVersion",
                 GlobalClusterIdentifier = "globalClusterIdentifier",
                 Iops = 123,
                 KmsKeyId = "kmsKeyId",
                 ManageMasterUserPassword = false,
                 MasterUserAuthenticationType = "masterUserAuthenticationType",
                 MasterUsername = "masterUsername",
                 MasterUserPassword = "masterUserPassword",
                 MasterUserSecret = new MasterUserSecretProperty {
                     KmsKeyId = "kmsKeyId",
                     SecretArn = "secretArn"
                 },
                 MonitoringInterval = 123,
                 MonitoringRoleArn = "monitoringRoleArn",
                 NetworkType = "networkType",
                 PerformanceInsightsEnabled = false,
                 PerformanceInsightsKmsKeyId = "performanceInsightsKmsKeyId",
                 PerformanceInsightsRetentionPeriod = 123,
                 Port = 123,
                 PreferredBackupWindow = "preferredBackupWindow",
                 PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                 PubliclyAccessible = false,
                 ReplicationSourceIdentifier = "replicationSourceIdentifier",
                 RestoreToTime = "restoreToTime",
                 RestoreType = "restoreType",
                 ScalingConfiguration = new ScalingConfigurationProperty {
                     AutoPause = false,
                     MaxCapacity = 123,
                     MinCapacity = 123,
                     SecondsBeforeTimeout = 123,
                     SecondsUntilAutoPause = 123,
                     TimeoutAction = "timeoutAction"
                 },
                 ServerlessV2ScalingConfiguration = new ServerlessV2ScalingConfigurationProperty {
                     MaxCapacity = 123,
                     MinCapacity = 123,
                     SecondsUntilAutoPause = 123
                 },
                 SnapshotIdentifier = "snapshotIdentifier",
                 SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
                 SourceDbClusterResourceId = "sourceDbClusterResourceId",
                 SourceRegion = "sourceRegion",
                 StorageEncrypted = false,
                 StorageType = "storageType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UseLatestRestorableTime = false,
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
             };

Synopsis

Constructors

CfnDBClusterProps()

Properties for defining a CfnDBCluster.

Properties

AllocatedStorage	The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
AssociatedRoles	Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
AutoMinorVersionUpgrade	Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
AvailabilityZones	A list of Availability Zones (AZs) where instances in the DB cluster can be created.
BacktrackWindow	The target backtrack window, in seconds. To disable backtracking, set this value to `0` .
BackupRetentionPeriod	The number of days for which automated backups are retained.
ClusterScalabilityType	Specifies the scalability mode of the Aurora DB cluster.
CopyTagsToSnapshot	A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
DatabaseInsightsMode	The mode of Database Insights to enable for the DB cluster.
DatabaseName	The name of your database.
DbClusterIdentifier	The DB cluster identifier. This parameter is stored as a lowercase string.
DbClusterInstanceClass	The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6gd.xlarge` . Not all DB instance classes are available in all AWS Regions , or for all database engines.
DbClusterParameterGroupName	The name of the DB cluster parameter group to associate with this DB cluster.
DbInstanceParameterGroupName	The name of the DB parameter group to apply to all instances of the DB cluster.
DbSubnetGroupName	A DB subnet group that you want to associate with this DB cluster.
DbSystemId	Reserved for future use.
DeleteAutomatedBackups	Specifies whether to remove automated backups immediately after the DB cluster is deleted.
DeletionProtection	A value that indicates whether the DB cluster has deletion protection enabled.
Domain	Indicates the directory ID of the Active Directory to create the DB cluster.
DomainIamRoleName	Specifies the name of the IAM role to use when making API calls to the Directory Service.
EnableCloudwatchLogsExports	The list of log types that need to be enabled for exporting to CloudWatch Logs.
EnableGlobalWriteForwarding	Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).
EnableHttpEndpoint	Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
EnableIamDatabaseAuthentication	A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
EnableLocalWriteForwarding	Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
Engine	The name of the database engine to be used for this DB cluster.
EngineLifecycleSupport	The life cycle type for this DB cluster.
EngineMode	The DB engine mode of the DB cluster, either `provisioned` or `serverless` .
EngineVersion	The version number of the database engine to use.
GlobalClusterIdentifier	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.
Iops	The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
KmsKeyId	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` .
ManageMasterUserPassword	Specifies whether to manage the master user password with AWS Secrets Manager.
MasterUserAuthenticationType	Specifies the authentication type for the master user.
MasterUserPassword	The master password for the DB instance.
MasterUserSecret	The secret managed by RDS in AWS Secrets Manager for the master user password.
MasterUsername	The name of the master user for the DB cluster.
MonitoringInterval	The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
MonitoringRoleArn	The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
NetworkType	The network type of the DB cluster.
PerformanceInsightsEnabled	Specifies whether to turn on Performance Insights for the DB cluster.
PerformanceInsightsKmsKeyId	The AWS KMS key identifier for encryption of Performance Insights data.
PerformanceInsightsRetentionPeriod	The number of days to retain Performance Insights data.
Port	The port number on which the DB instances in the DB cluster accept connections.
PreferredBackupWindow	The daily time range during which automated backups are created.
PreferredMaintenanceWindow	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PubliclyAccessible	Specifies whether the DB cluster is publicly accessible.
ReplicationSourceIdentifier	The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
RestoreToTime	The date and time to restore the DB cluster to.
RestoreType	The type of restore to be performed. You can specify one of the following values:.
ScalingConfiguration	The scaling configuration of an Aurora Serverless v1 DB cluster.
ServerlessV2ScalingConfiguration	The scaling configuration of an Aurora Serverless V2 DB cluster.
SnapshotIdentifier	The identifier for the DB snapshot or DB cluster snapshot to restore from.
SourceDbClusterIdentifier	When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
SourceDbClusterResourceId	The resource ID of the source DB cluster from which to restore.
SourceRegion	The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, `us-east-1` .
StorageEncrypted	Indicates whether the DB cluster is encrypted.
StorageType	The storage type to associate with the DB cluster.
Tags	Tags to assign to the DB cluster.
UseLatestRestorableTime	A value that indicates whether to restore the DB cluster to the latest restorable backup time.
VpcSecurityGroupIds	A list of EC2 VPC security groups to associate with this DB cluster.

Constructors

CfnDBClusterProps()

Properties for defining a CfnDBCluster.

public CfnDBClusterProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var cfnDBClusterProps = new CfnDBClusterProps {
                 AllocatedStorage = 123,
                 AssociatedRoles = new [] { new DBClusterRoleProperty {
                     RoleArn = "roleArn",

                     // the properties below are optional
                     FeatureName = "featureName"
                 } },
                 AutoMinorVersionUpgrade = false,
                 AvailabilityZones = new [] { "availabilityZones" },
                 BacktrackWindow = 123,
                 BackupRetentionPeriod = 123,
                 ClusterScalabilityType = "clusterScalabilityType",
                 CopyTagsToSnapshot = false,
                 DatabaseInsightsMode = "databaseInsightsMode",
                 DatabaseName = "databaseName",
                 DbClusterIdentifier = "dbClusterIdentifier",
                 DbClusterInstanceClass = "dbClusterInstanceClass",
                 DbClusterParameterGroupName = "dbClusterParameterGroupName",
                 DbInstanceParameterGroupName = "dbInstanceParameterGroupName",
                 DbSubnetGroupName = "dbSubnetGroupName",
                 DbSystemId = "dbSystemId",
                 DeleteAutomatedBackups = false,
                 DeletionProtection = false,
                 Domain = "domain",
                 DomainIamRoleName = "domainIamRoleName",
                 EnableCloudwatchLogsExports = new [] { "enableCloudwatchLogsExports" },
                 EnableGlobalWriteForwarding = false,
                 EnableHttpEndpoint = false,
                 EnableIamDatabaseAuthentication = false,
                 EnableLocalWriteForwarding = false,
                 Engine = "engine",
                 EngineLifecycleSupport = "engineLifecycleSupport",
                 EngineMode = "engineMode",
                 EngineVersion = "engineVersion",
                 GlobalClusterIdentifier = "globalClusterIdentifier",
                 Iops = 123,
                 KmsKeyId = "kmsKeyId",
                 ManageMasterUserPassword = false,
                 MasterUserAuthenticationType = "masterUserAuthenticationType",
                 MasterUsername = "masterUsername",
                 MasterUserPassword = "masterUserPassword",
                 MasterUserSecret = new MasterUserSecretProperty {
                     KmsKeyId = "kmsKeyId",
                     SecretArn = "secretArn"
                 },
                 MonitoringInterval = 123,
                 MonitoringRoleArn = "monitoringRoleArn",
                 NetworkType = "networkType",
                 PerformanceInsightsEnabled = false,
                 PerformanceInsightsKmsKeyId = "performanceInsightsKmsKeyId",
                 PerformanceInsightsRetentionPeriod = 123,
                 Port = 123,
                 PreferredBackupWindow = "preferredBackupWindow",
                 PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                 PubliclyAccessible = false,
                 ReplicationSourceIdentifier = "replicationSourceIdentifier",
                 RestoreToTime = "restoreToTime",
                 RestoreType = "restoreType",
                 ScalingConfiguration = new ScalingConfigurationProperty {
                     AutoPause = false,
                     MaxCapacity = 123,
                     MinCapacity = 123,
                     SecondsBeforeTimeout = 123,
                     SecondsUntilAutoPause = 123,
                     TimeoutAction = "timeoutAction"
                 },
                 ServerlessV2ScalingConfiguration = new ServerlessV2ScalingConfigurationProperty {
                     MaxCapacity = 123,
                     MinCapacity = 123,
                     SecondsUntilAutoPause = 123
                 },
                 SnapshotIdentifier = "snapshotIdentifier",
                 SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
                 SourceDbClusterResourceId = "sourceDbClusterResourceId",
                 SourceRegion = "sourceRegion",
                 StorageEncrypted = false,
                 StorageType = "storageType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UseLatestRestorableTime = false,
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
             };

Properties

AllocatedStorage

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

public double? AllocatedStorage { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage

Remarks

Valid for Cluster Type: Multi-AZ DB clusters only

This setting is required to create a Multi-AZ DB cluster.

AssociatedRoles

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

public object? AssociatedRoles { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles

Remarks

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type union: either IResolvable or (either IResolvable or CfnDBCluster.IDBClusterRoleProperty)[]

AutoMinorVersionUpgrade

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

public object? AutoMinorVersionUpgrade { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade

Remarks

By default, minor engine upgrades are applied automatically.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version .

Type union: either bool or IResolvable

AvailabilityZones

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

public string[]? AvailabilityZones { get; set; }

Property Value

string[]

Remarks

For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .

Valid for: Aurora DB clusters only

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones

BacktrackWindow

The target backtrack window, in seconds. To disable backtracking, set this value to 0 .

public double? BacktrackWindow { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow

Remarks

Valid for Cluster Type: Aurora MySQL DB clusters only

Default: 0

Constraints:

BackupRetentionPeriod

The number of days for which automated backups are retained.

public double? BackupRetentionPeriod { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod

Remarks

Default: 1

Constraints:

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Default: - 1

ClusterScalabilityType

Specifies the scalability mode of the Aurora DB cluster.

public string? ClusterScalabilityType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-clusterscalabilitytype

Remarks

When set to limitless , the cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to standard (the default), the cluster uses normal DB instance creation.

Important: Automated backup retention isn't supported with Aurora Limitless Database clusters. If you set this property to limitless , you cannot set DeleteAutomatedBackups to false . To create a backup, use manual snapshots instead.

CopyTagsToSnapshot

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

public object? CopyTagsToSnapshot { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot

Remarks

The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type union: either bool or IResolvable

DatabaseInsightsMode

The mode of Database Insights to enable for the DB cluster.

public string? DatabaseInsightsMode { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databaseinsightsmode

Remarks

If you set this value to advanced , you must also set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

DatabaseName

The name of your database.

public string? DatabaseName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename

Remarks

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 .

Valid for: Aurora DB clusters and Multi-AZ DB clusters

DbClusterIdentifier

The DB cluster identifier. This parameter is stored as a lowercase string.

public string? DbClusterIdentifier { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier

Remarks

Constraints:

Example: my-cluster1

Valid for: Aurora DB clusters and Multi-AZ DB clusters

DbClusterInstanceClass

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines.

public string? DbClusterInstanceClass { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass

Remarks

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide .

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

DbClusterParameterGroupName

The name of the DB cluster parameter group to associate with this DB cluster.

public object? DbClusterParameterGroupName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname

Remarks

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type union: either string or IDBClusterParameterGroupRef

DbInstanceParameterGroupName

The name of the DB parameter group to apply to all instances of the DB cluster.

public string? DbInstanceParameterGroupName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname

Remarks

When you apply a parameter group using the <code>DBInstanceParameterGroupName</code> parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.

Valid for Cluster Type: Aurora DB clusters only

Default: The existing name setting

Constraints:

DbSubnetGroupName

A DB subnet group that you want to associate with this DB cluster.

public object? DbSubnetGroupName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname

Remarks

If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type union: either string or IDBSubnetGroupRef

DbSystemId

Reserved for future use.

public string? DbSystemId { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsystemid

Remarks

DeleteAutomatedBackups

Specifies whether to remove automated backups immediately after the DB cluster is deleted.

public object? DeleteAutomatedBackups { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deleteautomatedbackups

Remarks

This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule.

Type union: either bool or IResolvable

DeletionProtection

A value that indicates whether the DB cluster has deletion protection enabled.

public object? DeletionProtection { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection

Remarks

The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type union: either bool or IResolvable

Domain

Indicates the directory ID of the Active Directory to create the DB cluster.

public string? Domain { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain

Remarks

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

For more information, see Kerberos authentication in the Amazon Aurora User Guide .

Valid for: Aurora DB clusters only

DomainIamRoleName

Specifies the name of the IAM role to use when making API calls to the Directory Service.

public string? DomainIamRoleName { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename

Remarks

Valid for: Aurora DB clusters only

EnableCloudwatchLogsExports

The list of log types that need to be enabled for exporting to CloudWatch Logs.

public string[]? EnableCloudwatchLogsExports { get; set; }

Property Value

string[]

Remarks

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports

EnableGlobalWriteForwarding

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

public object? EnableGlobalWriteForwarding { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableglobalwriteforwarding

Remarks

By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.

Valid for Cluster Type: Aurora DB clusters only

Type union: either bool or IResolvable

EnableHttpEndpoint

Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.

public object? EnableHttpEndpoint { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint

Remarks

When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

For more information, see Using RDS Data API in the Amazon Aurora User Guide .

Valid for Cluster Type: Aurora DB clusters only

Type union: either bool or IResolvable

EnableIamDatabaseAuthentication

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

public object? EnableIamDatabaseAuthentication { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication

Remarks

By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Type union: either bool or IResolvable

EnableLocalWriteForwarding

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

public object? EnableLocalWriteForwarding { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablelocalwriteforwarding

Remarks

By default, write operations aren't allowed on reader DB instances.

Valid for: Aurora DB clusters only

Type union: either bool or IResolvable

Engine

The name of the database engine to be used for this DB cluster.

public string? Engine { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine

Remarks

Valid Values:

Valid for: Aurora DB clusters and Multi-AZ DB clusters

EngineLifecycleSupport

The life cycle type for this DB cluster.

public string? EngineLifecycleSupport { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginelifecyclesupport

Remarks

By default, this value is set to <code>open-source-rds-extended-support</code> , which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to <code>open-source-rds-extended-support-disabled</code> . In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

EngineMode

The DB engine mode of the DB cluster, either provisioned or serverless .

public string? EngineMode { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode

Remarks

The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.

For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide :

Valid for Cluster Type: Aurora DB clusters only

EngineVersion

The version number of the database engine to use.

public string? EngineVersion { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion

Remarks

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.

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"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

For information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide .

Aurora PostgreSQL

For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .

MySQL

For information, see Amazon RDS for MySQL in the Amazon RDS User Guide .

PostgreSQL

For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide .

Valid for: Aurora DB clusters and Multi-AZ DB clusters

GlobalClusterIdentifier

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.

public object? GlobalClusterIdentifier { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier

Remarks

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.

To remove the DB cluster from a global database cluster, specify an empty value for the <code>GlobalClusterIdentifier</code> property.

For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .

Valid for: Aurora DB clusters only

Type union: either string or IGlobalClusterRef

Iops

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

public double? Iops { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops

Remarks

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide .

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

Constraints:

KmsKeyId

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 .

public object? KmsKeyId { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid

Remarks

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 the StorageEncrypted property to true .

If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.

If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type union: either string or IKeyRef

ManageMasterUserPassword

Specifies whether to manage the master user password with AWS Secrets Manager.

public object? ManageMasterUserPassword { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword

Remarks

For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

Type union: either bool or IResolvable

MasterUserAuthenticationType

Specifies the authentication type for the master user.

public string? MasterUserAuthenticationType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserauthenticationtype

Remarks

With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.

You can specify one of the following values:

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

This option is only valid for RDS for MySQL, RDS for MariaDB, RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL engines.

MasterUserPassword

The master password for the DB instance.

public string? MasterUserPassword { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword

Remarks

If you specify the <code>SourceDBClusterIdentifier</code> , <code>SnapshotIdentifier</code> , or <code>GlobalClusterIdentifier</code> 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

MasterUserSecret

The secret managed by RDS in AWS Secrets Manager for the master user password.

public object? MasterUserSecret { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret

Remarks

When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the <code>SecretArn</code> property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret.

For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.

Type union: either IResolvable or CfnDBCluster.IMasterUserSecretProperty

MasterUsername

The name of the master user for the DB cluster.

public string? MasterUsername { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername

Remarks

If you specify the <code>SourceDBClusterIdentifier</code> , <code>SnapshotIdentifier</code> , or <code>GlobalClusterIdentifier</code> 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

MonitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

public double? MonitoringInterval { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval

Remarks

To turn off collecting Enhanced Monitoring metrics, specify 0 .

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

Default: 0

MonitoringRoleArn

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

public string? MonitoringRoleArn { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn

Remarks

An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide .

If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

NetworkType

The network type of the DB cluster.

public string? NetworkType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype

Remarks

Valid values:

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( DUAL ).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

PerformanceInsightsEnabled

Specifies whether to turn on Performance Insights for the DB cluster.

public object? PerformanceInsightsEnabled { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled

Remarks

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Type union: either bool or IResolvable

PerformanceInsightsKmsKeyId

The AWS KMS key identifier for encryption of Performance Insights data.

public string? PerformanceInsightsKmsKeyId { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid

Remarks

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

PerformanceInsightsRetentionPeriod

The number of days to retain Performance Insights data.

public double? PerformanceInsightsRetentionPeriod { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod

Remarks

When creating a DB cluster without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values:

Default: 7 days

If you specify a retention period that isn't valid, such as 94 , Amazon RDS issues an error.

Port

The port number on which the DB instances in the DB cluster accept connections.

public double? Port { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port

Remarks

Default:

The <code>No interruption</code> on update behavior only applies to DB clusters. If you are updating a DB instance, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port">Port</a> for the AWS::RDS::DBInstance resource.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

PreferredBackupWindow

The daily time range during which automated backups are created.

public string? PreferredBackupWindow { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow

Remarks

For more information, see Backup Window in the Amazon Aurora User Guide.

Constraints:

Valid for: Aurora DB clusters and Multi-AZ DB clusters

PreferredMaintenanceWindow

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

public string? PreferredMaintenanceWindow { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow

Remarks

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 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

PubliclyAccessible

Specifies whether the DB cluster is publicly accessible.

public object? PubliclyAccessible { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible

Remarks

Valid for Cluster Type: Multi-AZ DB clusters only

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 controlled by its security group settings.

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.

The default behavior when PubliclyAccessible is not specified depends on whether a DBSubnetGroup is specified.

If DBSubnetGroup isn't specified, PubliclyAccessible defaults to true .

If DBSubnetGroup is specified, PubliclyAccessible defaults to false unless the value of DBSubnetGroup is default , in which case PubliclyAccessible defaults to true .

If PubliclyAccessible is true and the VPC that the DBSubnetGroup is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.

Type union: either bool or IResolvable

ReplicationSourceIdentifier

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

public string? ReplicationSourceIdentifier { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier

Remarks

Valid for: Aurora DB clusters only

RestoreToTime

The date and time to restore the DB cluster to.

public string? RestoreToTime { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretotime

Remarks

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

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

RestoreType

The type of restore to be performed. You can specify one of the following values:.

public string? RestoreType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype

Remarks

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

ScalingConfiguration

The scaling configuration of an Aurora Serverless v1 DB cluster.

public object? ScalingConfiguration { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration

Remarks

This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.

Valid for: Aurora Serverless v1 DB clusters only

Type union: either IResolvable or CfnDBCluster.IScalingConfigurationProperty

ServerlessV2ScalingConfiguration

The scaling configuration of an Aurora Serverless V2 DB cluster.

public object? ServerlessV2ScalingConfiguration { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration

Remarks

This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property.

Valid for: Aurora Serverless v2 DB clusters only

Type union: either IResolvable or CfnDBCluster.IServerlessV2ScalingConfigurationProperty

SnapshotIdentifier

The identifier for the DB snapshot or DB cluster snapshot to restore from.

public string? SnapshotIdentifier { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier

Remarks

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 same SnapshotIdentifier 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 the SnapshotIdentifier 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 specified SnapshotIdentifier 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:

Constraints:

Valid for: Aurora DB clusters and Multi-AZ DB clusters

SourceDbClusterIdentifier

When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.

public string? SourceDbClusterIdentifier { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier

Remarks

Constraints:

Valid for: Aurora DB clusters and Multi-AZ DB clusters

SourceDbClusterResourceId

The resource ID of the source DB cluster from which to restore.

public string? SourceDbClusterResourceId { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusterresourceid

Remarks

SourceRegion

The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1 .

public string? SourceRegion { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion

Remarks

Valid for: Aurora DB clusters only

StorageEncrypted

Indicates whether the DB cluster is encrypted.

public object? StorageEncrypted { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted

Remarks

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 specified KmsKeyId 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 specified KmsKeyId 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 the KmsKeyId 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 to false .

If you specify both the <code>StorageEncrypted</code> and <code>SnapshotIdentifier</code> properties without specifying the <code>KmsKeyId</code> property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type union: either bool or IResolvable

StorageType

The storage type to associate with the DB cluster.

public string? StorageType { get; set; }

Property Value

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype

Remarks

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .

This setting is required to create a Multi-AZ DB cluster.

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values:

Default:

When you create an Aurora DB cluster with the storage type set to <code>aurora-iopt1</code> , the storage type is returned in the response. The storage type isn't returned when you set it to <code>aurora</code> .

UseLatestRestorableTime

A value that indicates whether to restore the DB cluster to the latest restorable backup time.

public object? UseLatestRestorableTime { get; set; }

Property Value