Struct aws_sdk_docdb::operation::create_db_instance::CreateDbInstanceInput

#[non_exhaustive]
pub struct CreateDbInstanceInput {
    pub db_instance_identifier: Option<String>,
    pub db_instance_class: Option<String>,
    pub engine: Option<String>,
    pub availability_zone: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub tags: Option<Vec<Tag>>,
    pub db_cluster_identifier: Option<String>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub promotion_tier: Option<i32>,
    pub enable_performance_insights: Option<bool>,
    pub performance_insights_kms_key_id: Option<String>,
}

Represents the input to CreateDBInstance.

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.

db_instance_identifier: Option<String>

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

db_instance_class: Option<String>

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

engine: Option<String>

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

Valid value: docdb

availability_zone: Option<String>

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

preferred_maintenance_window: Option<String>

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.

auto_minor_version_upgrade: Option<bool>

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

Default: false

tags: Option<Vec<Tag>>

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

db_cluster_identifier: Option<String>

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

copy_tags_to_snapshot: Option<bool>

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

promotion_tier: Option<i32>

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

enable_performance_insights: Option<bool>

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

performance_insights_kms_key_id: Option<String>

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.

Implementations

impl CreateDbInstanceInput

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

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) -> Option<&str>

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

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

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

Valid value: docdb

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

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) -> Option<&str>

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) -> Option<bool>

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) -> Option<&[Tag]>

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

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

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

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

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

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) -> Option<bool>

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) -> Option<&str>

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.

impl CreateDbInstanceInput

pub fn builder() -> CreateDbInstanceInputBuilder

Creates a new builder-style object to manufacture CreateDbInstanceInput.

Trait Implementations

impl Clone for CreateDbInstanceInput

fn clone(&self) -> CreateDbInstanceInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDbInstanceInput

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

Formats the value using the given formatter.

impl PartialEq for CreateDbInstanceInput

fn eq(&self, other: &CreateDbInstanceInput) -> 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 CreateDbInstanceInput