Struct aws_sdk_docdb::model::DbInstance

#[non_exhaustive]
pub struct DbInstance {

    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 promotion_tier: Option<i32>,
    pub db_instance_arn: Option<String>,
    pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
}

Detailed information about an instance.

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>

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

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

impl DbInstance

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

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

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

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

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

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

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

Specifies the current state of this database.

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

Specifies the connection endpoint.

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

Provides the date and time that the instance was created.

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.

pub fn backup_retention_period(&self) -> i32

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

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

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

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

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

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.

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

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

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.

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

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

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

Indicates the database engine version.

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.

pub fn publicly_accessible(&self) -> bool

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

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

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

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.

pub fn storage_encrypted(&self) -> bool

Specifies whether or not the instance is encrypted.

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

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

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

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

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

The identifier of the CA certificate for this DB instance.

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.

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

The Amazon Resource Name (ARN) for the instance.

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

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

impl DbInstance

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DbInstance

Trait Implementations

impl Clone for DbInstance

fn clone(&self) -> DbInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DbInstance

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

Formats the value using the given formatter.

impl PartialEq<DbInstance> for DbInstance

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

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

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

This method tests for !=.

impl StructuralPartialEq for DbInstance