Struct aws_sdk_docdb::operation::create_db_cluster::builders::CreateDBClusterFluentBuilder

pub struct CreateDBClusterFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateDBCluster.

Creates a new Amazon DocumentDB cluster.

Implementations

impl CreateDBClusterFluentBuilder

pub fn as_input(&self) -> &CreateDbClusterInputBuilder

Access the CreateDBCluster as a reference.

pub async fn send( self ) -> Result<CreateDbClusterOutput, SdkError<CreateDBClusterError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateDbClusterOutput, CreateDBClusterError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn availability_zones(self, input: impl Into<String>) -> Self

Appends an item to AvailabilityZones.

To override the contents of this collection use set_availability_zones.

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

pub fn set_availability_zones(self, input: Option<Vec<String>>) -> Self

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

pub fn get_availability_zones(&self) -> &Option<Vec<String>>

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

pub fn backup_retention_period(self, input: i32) -> Self

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 set_backup_retention_period(self, input: Option<i32>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_db_cluster_identifier(self, input: Option<String>) -> Self

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 get_db_cluster_identifier(&self) -> &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

pub fn db_cluster_parameter_group_name(self, input: impl Into<String>) -> Self

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

pub fn set_db_cluster_parameter_group_name(self, input: Option<String>) -> Self

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

pub fn get_db_cluster_parameter_group_name(&self) -> &Option<String>

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

pub fn vpc_security_group_ids(self, input: impl Into<String>) -> Self

Appends an item to VpcSecurityGroupIds.

To override the contents of this collection use set_vpc_security_group_ids.

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

pub fn set_vpc_security_group_ids(self, input: Option<Vec<String>>) -> Self

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

pub fn get_vpc_security_group_ids(&self) -> &Option<Vec<String>>

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

pub fn db_subnet_group_name(self, input: impl Into<String>) -> Self

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 set_db_subnet_group_name(self, input: Option<String>) -> Self

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 get_db_subnet_group_name(&self) -> &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

pub fn engine(self, input: impl Into<String>) -> Self

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

Valid values: docdb

pub fn set_engine(self, input: Option<String>) -> Self

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

Valid values: docdb

pub fn get_engine(&self) -> &Option<String>

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

Valid values: docdb

pub fn engine_version(self, input: impl Into<String>) -> Self

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 set_engine_version(self, input: Option<String>) -> Self

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 get_engine_version(&self) -> &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.

pub fn port(self, input: i32) -> Self

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

pub fn set_port(self, input: Option<i32>) -> Self

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

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

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

pub fn master_username(self, input: impl Into<String>) -> Self

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 set_master_username(self, input: Option<String>) -> Self

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 get_master_username(&self) -> &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.

pub fn master_user_password(self, input: impl Into<String>) -> Self

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 set_master_user_password(self, input: Option<String>) -> Self

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 get_master_user_password(&self) -> &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.

pub fn preferred_backup_window(self, input: impl Into<String>) -> Self

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 set_preferred_backup_window(self, input: Option<String>) -> Self

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 get_preferred_backup_window(&self) -> &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.

pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self

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 set_preferred_maintenance_window(self, input: Option<String>) -> Self

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 get_preferred_maintenance_window(&self) -> &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.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The tags to be assigned to the cluster.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags to be assigned to the cluster.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The tags to be assigned to the cluster.

pub fn storage_encrypted(self, input: bool) -> Self

Specifies whether the cluster is encrypted.

pub fn set_storage_encrypted(self, input: Option<bool>) -> Self

Specifies whether the cluster is encrypted.

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

Specifies whether the cluster is encrypted.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

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 set_kms_key_id(self, input: Option<String>) -> Self

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 get_kms_key_id(&self) -> &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.

pub fn pre_signed_url(self, input: impl Into<String>) -> Self

Not currently supported.

pub fn set_pre_signed_url(self, input: Option<String>) -> Self

Not currently supported.

pub fn get_pre_signed_url(&self) -> &Option<String>

Not currently supported.

pub fn enable_cloudwatch_logs_exports(self, input: impl Into<String>) -> Self

Appends an item to EnableCloudwatchLogsExports.

To override the contents of this collection use set_enable_cloudwatch_logs_exports.

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 set_enable_cloudwatch_logs_exports( self, input: Option<Vec<String>> ) -> Self

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 get_enable_cloudwatch_logs_exports(&self) -> &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.

pub fn deletion_protection(self, input: bool) -> Self

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 set_deletion_protection(self, input: Option<bool>) -> Self

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 get_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, input: impl Into<String>) -> Self

The cluster identifier of the new global cluster.

pub fn set_global_cluster_identifier(self, input: Option<String>) -> Self

The cluster identifier of the new global cluster.

pub fn get_global_cluster_identifier(&self) -> &Option<String>

The cluster identifier of the new global cluster.

pub fn storage_type(self, input: impl Into<String>) -> Self

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

pub fn set_storage_type(self, input: Option<String>) -> Self

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

pub fn get_storage_type(&self) -> &Option<String>

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

Trait Implementations

impl Clone for CreateDBClusterFluentBuilder

fn clone(&self) -> CreateDBClusterFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDBClusterFluentBuilder

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

Formats the value using the given formatter.