Creates a new Amazon DocumentDB DB cluster.
docdb_create_db_cluster(AvailabilityZones, BackupRetentionPeriod,
DBClusterIdentifier, DBClusterParameterGroupName, VpcSecurityGroupIds,
DBSubnetGroupName, Engine, EngineVersion, Port, MasterUsername,
MasterUserPassword, PreferredBackupWindow, PreferredMaintenanceWindow,
Tags, StorageEncrypted, KmsKeyId, EnableCloudwatchLogsExports,
DeletionProtection)A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35.
[required] The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
The name of the DB cluster parameter group to associate with this DB cluster.
A list of EC2 VPC security groups to associate with this DB cluster.
A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must
not be default.
Example: mySubnetgroup
[required] The name of the database engine to be used for this DB cluster.
Valid values: docdb
The version number of the database engine to use.
The port number on which the instances in the DB cluster accept connections.
[required] The name of the master user for the DB cluster.
Constraints:
Must be from 1 to 16 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
[required] The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 41 characters.
The daily time range during which automated backups are created if
automated backups are enabled using the BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
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.
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.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
The tags to be assigned to the DB cluster.
Specifies whether the DB cluster is encrypted.
The AWS KMS key identifier for an encrypted DB cluster.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
If an encryption key is not specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source,
then Amazon DocumentDB uses the encryption key that is used to
encrypt the source. Otherwise, Amazon DocumentDB uses your default
encryption key.
If the StorageEncrypted parameter is true and
ReplicationSourceIdentifier is not specified, Amazon DocumentDB
uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
If you create a replica of an encrypted DB cluster in another AWS
Region, you must set KmsKeyId to a KMS key ID that is valid in the
destination AWS Region. This key is used to encrypt the replica in that
AWS Region.
A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection is disabled. DeletionProtection protects clusters
from being accidentally deleted.
svc$create_db_cluster(
AvailabilityZones = list(
"string"
),
BackupRetentionPeriod = 123,
DBClusterIdentifier = "string",
DBClusterParameterGroupName = "string",
VpcSecurityGroupIds = list(
"string"
),
DBSubnetGroupName = "string",
Engine = "string",
EngineVersion = "string",
Port = 123,
MasterUsername = "string",
MasterUserPassword = "string",
PreferredBackupWindow = "string",
PreferredMaintenanceWindow = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
StorageEncrypted = TRUE|FALSE,
KmsKeyId = "string",
EnableCloudwatchLogsExports = list(
"string"
),
DeletionProtection = TRUE|FALSE
)