Struct aws_sdk_docdb::client::fluent_builders::CreateDBInstance

pub struct CreateDBInstance { /* private fields */ }

Fluent builder constructing a request to CreateDBInstance.

Creates a new instance.

Implementations

impl CreateDBInstance

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateDBInstance, AwsResponseRetryClassifier>, SdkError<CreateDBInstanceError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateDbInstanceOutput, SdkError<CreateDBInstanceError>>

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

The instance 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: mydbinstance

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

The instance 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: mydbinstance

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

The compute and memory capacity of the instance; for example, db.r5.large.

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

The compute and memory capacity of the instance; for example, db.r5.large.

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

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

Valid value: docdb

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

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

Valid value: docdb

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

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

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

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

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

The time range each week 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 time range each week 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 auto_minor_version_upgrade(self, input: bool) -> Self

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

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

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

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 instance. You can assign up to 10 tags to an instance.

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

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

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

The identifier of the cluster that the instance will belong to.

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

The identifier of the cluster that the instance will belong to.

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

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

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

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

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

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

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

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

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

Trait Implementations

impl Clone for CreateDBInstance

fn clone(&self) -> CreateDBInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDBInstance

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

Formats the value using the given formatter.