#[non_exhaustive]
pub struct DbInstance {
Show 27 fields pub db_instance_identifier: Option<String>, pub db_instance_class: Option<String>, pub engine: Option<String>, pub db_instance_status: Option<String>, pub endpoint: Option<Endpoint>, pub instance_create_time: Option<DateTime>, pub preferred_backup_window: Option<String>, pub backup_retention_period: i32, pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>, pub availability_zone: Option<String>, pub db_subnet_group: Option<DbSubnetGroup>, pub preferred_maintenance_window: Option<String>, pub pending_modified_values: Option<PendingModifiedValues>, pub latest_restorable_time: Option<DateTime>, pub engine_version: Option<String>, pub auto_minor_version_upgrade: bool, pub publicly_accessible: bool, pub status_infos: Option<Vec<DbInstanceStatusInfo>>, pub db_cluster_identifier: Option<String>, pub storage_encrypted: bool, pub kms_key_id: Option<String>, pub dbi_resource_id: Option<String>, pub ca_certificate_identifier: Option<String>, pub copy_tags_to_snapshot: Option<bool>, pub promotion_tier: Option<i32>, pub db_instance_arn: Option<String>, pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
}
Expand description

Detailed information about an instance.

Fields (Non-exhaustive)§

This struct is marked as 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>

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

§db_instance_class: Option<String>

Contains the name of the compute and memory capacity class of the instance.

§engine: Option<String>

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

§db_instance_status: Option<String>

Specifies the current state of this database.

§endpoint: Option<Endpoint>

Specifies the connection endpoint.

§instance_create_time: Option<DateTime>

Provides the date and time that the instance was created.

§preferred_backup_window: Option<String>

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

§backup_retention_period: i32

Specifies the number of days for which automatic snapshots are retained.

§vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

Provides a list of VPC security group elements that the instance belongs to.

§availability_zone: Option<String>

Specifies the name of the Availability Zone that the instance is located in.

§db_subnet_group: Option<DbSubnetGroup>

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

§preferred_maintenance_window: Option<String>

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

§pending_modified_values: Option<PendingModifiedValues>

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

§latest_restorable_time: Option<DateTime>

Specifies the latest time to which a database can be restored with point-in-time restore.

§engine_version: Option<String>

Indicates the database engine version.

§auto_minor_version_upgrade: bool

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

§publicly_accessible: bool

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

§status_infos: Option<Vec<DbInstanceStatusInfo>>

The status of a read replica. If the instance is not a read replica, this is blank.

§db_cluster_identifier: Option<String>

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

§storage_encrypted: bool

Specifies whether or not the instance is encrypted.

§kms_key_id: Option<String>

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

§dbi_resource_id: Option<String>

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

§ca_certificate_identifier: Option<String>

The identifier of the CA certificate for this DB instance.

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

§db_instance_arn: Option<String>

The Amazon Resource Name (ARN) for the instance.

§enabled_cloudwatch_logs_exports: Option<Vec<String>>

A list of log types that this instance is configured to export to CloudWatch Logs.

Implementations§

source§

impl DbInstance

source

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

source

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

Contains the name of the compute and memory capacity class of the instance.

source

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

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

source

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

Specifies the current state of this database.

source

pub fn endpoint(&self) -> Option<&Endpoint>

Specifies the connection endpoint.

source

pub fn instance_create_time(&self) -> Option<&DateTime>

Provides the date and time that the instance was created.

source

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

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

source

pub fn backup_retention_period(&self) -> i32

Specifies the number of days for which automatic snapshots are retained.

source

pub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>

Provides a list of VPC security group elements that the instance belongs to.

source

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

Specifies the name of the Availability Zone that the instance is located in.

source

pub fn db_subnet_group(&self) -> Option<&DbSubnetGroup>

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

source

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

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

source

pub fn pending_modified_values(&self) -> Option<&PendingModifiedValues>

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

source

pub fn latest_restorable_time(&self) -> Option<&DateTime>

Specifies the latest time to which a database can be restored with point-in-time restore.

source

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

Indicates the database engine version.

source

pub fn auto_minor_version_upgrade(&self) -> bool

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

source

pub fn publicly_accessible(&self) -> bool

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

source

pub fn status_infos(&self) -> Option<&[DbInstanceStatusInfo]>

The status of a read replica. If the instance is not a read replica, this is blank.

source

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

source

pub fn storage_encrypted(&self) -> bool

Specifies whether or not the instance is encrypted.

source

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

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

source

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

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

source

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

The identifier of the CA certificate for this DB instance.

source

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.

source

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.

source

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

The Amazon Resource Name (ARN) for the instance.

source

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

A list of log types that this instance is configured to export to CloudWatch Logs.

source§

impl DbInstance

source

pub fn builder() -> DbInstanceBuilder

Creates a new builder-style object to manufacture DbInstance.

Trait Implementations§

source§

impl Clone for DbInstance

source§

fn clone(&self) -> DbInstance

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DbInstance

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for DbInstance

source§

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

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

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

impl StructuralPartialEq for DbInstance

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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