logo
pub struct CreateDBClusterMessage {
Show 20 fields pub availability_zones: Option<Vec<String>>, pub backup_retention_period: Option<i64>, pub db_cluster_identifier: String, pub db_cluster_parameter_group_name: Option<String>, pub db_subnet_group_name: Option<String>, pub deletion_protection: Option<bool>, pub enable_cloudwatch_logs_exports: Option<Vec<String>>, pub engine: String, pub engine_version: Option<String>, pub global_cluster_identifier: Option<String>, pub kms_key_id: Option<String>, pub master_user_password: Option<String>, pub master_username: Option<String>, pub port: Option<i64>, pub pre_signed_url: Option<String>, pub preferred_backup_window: Option<String>, pub preferred_maintenance_window: Option<String>, pub storage_encrypted: Option<bool>, pub tags: Option<Vec<Tag>>, pub vpc_security_group_ids: Option<Vec<String>>,
}
Expand description

Represents the input to CreateDBCluster.

Fields

availability_zones: Option<Vec<String>>

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

backup_retention_period: Option<i64>

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.

db_cluster_identifier: String

The 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

db_cluster_parameter_group_name: Option<String>

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

db_subnet_group_name: Option<String>

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

deletion_protection: Option<bool>

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.

enable_cloudwatch_logs_exports: Option<Vec<String>>

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

engine: String

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

Valid values: docdb

engine_version: Option<String>

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

global_cluster_identifier: Option<String>

The cluster identifier of the new global cluster.

kms_key_id: Option<String>

The KMS key identifier for an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

KMS creates the default encryption key for your account. Your account has a different default encryption key for each Regions.

master_user_password: Option<String>

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 100 characters.

master_username: Option<String>

The name of the master user for the cluster.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

port: Option<i64>

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

pre_signed_url: Option<String>

Not currently supported.

preferred_backup_window: Option<String>

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

preferred_maintenance_window: Option<String>

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 Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

storage_encrypted: Option<bool>

Specifies whether the cluster is encrypted.

tags: Option<Vec<Tag>>

The tags to be assigned to the cluster.

vpc_security_group_ids: Option<Vec<String>>

A list of EC2 VPC security groups to associate with this cluster.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more