Struct aws_sdk_docdb::operation::create_db_cluster::CreateDbClusterInput

#[non_exhaustive]
pub struct CreateDbClusterInput {

    pub availability_zones: Option<Vec<String>>,
    pub backup_retention_period: Option<i32>,
    pub db_cluster_identifier: Option<String>,
    pub db_cluster_parameter_group_name: Option<String>,
    pub vpc_security_group_ids: Option<Vec<String>>,
    pub db_subnet_group_name: Option<String>,
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub port: Option<i32>,
    pub master_username: Option<String>,
    pub master_user_password: Option<String>,
    pub preferred_backup_window: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub storage_encrypted: Option<bool>,
    pub kms_key_id: Option<String>,
    pub pre_signed_url: Option<String>,
    pub enable_cloudwatch_logs_exports: Option<Vec<String>>,
    pub deletion_protection: Option<bool>,
    pub global_cluster_identifier: Option<String>,
}

Represents the input to CreateDBCluster.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

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

vpc_security_group_ids: Option<Vec<String>>

A list of EC2 VPC security groups 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

engine: Option<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.

port: Option<i32>

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

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.

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.

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

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

Constraints: Minimum 30-minute window.

tags: Option<Vec<Tag>>

The tags to be assigned to the cluster.

storage_encrypted: Option<bool>

Specifies whether the cluster is encrypted.

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 Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

pre_signed_url: Option<String>

Not currently supported.

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.

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.

global_cluster_identifier: Option<String>

The cluster identifier of the new global cluster.

Implementations

impl CreateDbClusterInput

pub fn availability_zones(&self) -> Option<&[String]>

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

pub fn backup_retention_period(&self) -> Option<i32>

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.

pub fn db_cluster_identifier(&self) -> Option<&str>

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

pub fn db_cluster_parameter_group_name(&self) -> Option<&str>

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

pub fn vpc_security_group_ids(&self) -> Option<&[String]>

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

pub fn db_subnet_group_name(&self) -> Option<&str>

A subnet group to associate with this cluster.

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

Example: mySubnetgroup

pub fn engine(&self) -> Option<&str>

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

Valid values: docdb

pub fn engine_version(&self) -> Option<&str>

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.

pub fn port(&self) -> Option<i32>

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

pub fn master_username(&self) -> Option<&str>

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.

pub fn master_user_password(&self) -> Option<&str>

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.

pub fn preferred_backup_window(&self) -> Option<&str>

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 Amazon Web Services 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.

pub fn preferred_maintenance_window(&self) -> Option<&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 Amazon Web Services Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

pub fn tags(&self) -> Option<&[Tag]>

The tags to be assigned to the cluster.

pub fn storage_encrypted(&self) -> Option<bool>

Specifies whether the cluster is encrypted.

pub fn kms_key_id(&self) -> Option<&str>

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 Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

pub fn pre_signed_url(&self) -> Option<&str>

Not currently supported.

pub fn enable_cloudwatch_logs_exports(&self) -> Option<&[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.

pub fn deletion_protection(&self) -> 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.

pub fn global_cluster_identifier(&self) -> Option<&str>

The cluster identifier of the new global cluster.

impl CreateDbClusterInput

pub fn builder() -> CreateDbClusterInputBuilder

Creates a new builder-style object to manufacture CreateDbClusterInput.

Trait Implementations

impl Clone for CreateDbClusterInput

fn clone(&self) -> CreateDbClusterInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDbClusterInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateDbClusterInput

fn eq(&self, other: &CreateDbClusterInput) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDbClusterInput