AvailabilityZones |
String
|
Required: No. A list of Availability Zones (AZs) in which DB instances in the cluster can be
created.Update requires: Replacement |
BackupRetentionPeriod |
Number
|
Required: No. The number of days for which automatic backups are retained. For more
information, see CreateDBCluster in the Amazon Relational Database Service API Reference.Update requires: No interruption or some
interruptions. For more information, see ModifyDBInstance in the
Amazon Relational Database Service API Reference. |
DatabaseName |
String
|
Required: No. The name of your database. You can specify a name of up to eight alpha-numeric
characters. If you do not provide a name, Amazon Relational Database Service (Amazon RDS) won't create a
database in this DB cluster.Update requires: Replacement |
DBClusterParameterGroupName |
String
|
Required: No. The name of the DB cluster parameter group to associate with this DB cluster.
For the default value, see the DBClusterParameterGroupName parameter
of the CreateDBCluster
action in the Amazon Relational Database Service API Reference.Update requires: Some interruptions |
DBSubnetGroupName |
String
|
Required: No. A DB subnet group that you want to associate with this DB cluster.Update requires: Replacement |
Engine |
String
|
Required: Yes. The name of the database engine that you want to use for this DB
cluster.For valid values, see the Engine parameter of the CreateDBCluster action in the
Amazon Relational Database Service API Reference.Update requires: Replacement |
EngineVersion |
String
|
Required: No. The version number of the database engine that you want to use.Update requires: Replacement |
KmsKeyId |
String
|
Required: No. The Amazon Resource Name (ARN) of the AWS Key Management Service master 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 master key is used. If you specify this property, you must
set the StorageEncrypted property to true.If you specify the SnapshotIdentifier, do not specify this
property. The value is inherited from the snapshot DB cluster.Update requires: Replacement. |
MasterUsername |
String
|
Required: Conditional. The master user name for the DB instance.Update requires: Replacement. |
MasterUserPassword |
String
|
Required: Conditional. The password for the master database user.Update requires: No interruption |
Port |
Number
|
Required: No. The port number on which the DB instances in the cluster can accept
connections.Update requires: No interruption |
PreferredBackupWindow |
String
|
Required: No. if automated backups are enabled (see the BackupRetentionPeriod
property), the daily time range in UTC during which you want to create automated
backups.For valid values, see the PreferredBackupWindow parameter of the
CreateDBInstance action in the
Amazon Relational Database Service API Reference.Update requires: No interruption |
PreferredMaintenanceWindow |
String
|
Required: No. The weekly time range (in UTC) during which system maintenance can
occur.For valid values, see the PreferredMaintenanceWindow parameter of
the CreateDBInstance action in the
Amazon Relational Database Service API Reference.Update requires: No interruption or some
interruptions. For more information, see ModifyDBInstance in the
Amazon Relational Database Service API Reference. |
SnapshotIdentifier |
String
|
Required: No. The identifier for the DB cluster snapshot from which you want to
restore.Update requires: Replacement |
StorageEncrypted |
Boolean
|
Required: Conditional. Indicates whether the DB instances in the cluster are encrypted.If you specify the SnapshotIdentifier property, do not specify
this property. The value is inherited from the snapshot DB cluster.Update requires: Replacement. |
Tags |
resourcetags
|
Required: No. The tags that you want to attach to this DB cluster.Update requires: Updates are not supported. |
VpcSecurityGroupIds |
String
|
Required: No. A list of VPC security groups to associate with this DB cluster.Update requires: No interruption |