Struct aws_sdk_docdb::model::DbInstance
source · #[non_exhaustive]pub struct DbInstance { /* private fields */ }Expand description
Detailed information about an instance.
Implementations§
source§impl DbInstance
impl DbInstance
sourcepub fn db_instance_identifier(&self) -> Option<&str>
pub fn db_instance_identifier(&self) -> Option<&str>
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
sourcepub fn db_instance_class(&self) -> Option<&str>
pub fn db_instance_class(&self) -> Option<&str>
Contains the name of the compute and memory capacity class of the instance.
sourcepub fn engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
Provides the name of the database engine to be used for this instance.
sourcepub fn db_instance_status(&self) -> Option<&str>
pub fn db_instance_status(&self) -> Option<&str>
Specifies the current state of this database.
sourcepub fn instance_create_time(&self) -> Option<&DateTime>
pub fn instance_create_time(&self) -> Option<&DateTime>
Provides the date and time that the instance was created.
sourcepub fn preferred_backup_window(&self) -> Option<&str>
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.
sourcepub fn backup_retention_period(&self) -> i32
pub fn backup_retention_period(&self) -> i32
Specifies the number of days for which automatic snapshots are retained.
sourcepub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>
pub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>
Provides a list of VPC security group elements that the instance belongs to.
sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
Specifies the name of the Availability Zone that the instance is located in.
sourcepub fn db_subnet_group(&self) -> Option<&DbSubnetGroup>
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.
sourcepub fn preferred_maintenance_window(&self) -> Option<&str>
pub fn preferred_maintenance_window(&self) -> Option<&str>
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
sourcepub fn pending_modified_values(&self) -> Option<&PendingModifiedValues>
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.
sourcepub fn latest_restorable_time(&self) -> Option<&DateTime>
pub fn latest_restorable_time(&self) -> Option<&DateTime>
Specifies the latest time to which a database can be restored with point-in-time restore.
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
Indicates the database engine version.
sourcepub fn auto_minor_version_upgrade(&self) -> bool
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.
sourcepub fn publicly_accessible(&self) -> bool
pub fn publicly_accessible(&self) -> bool
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
sourcepub fn status_infos(&self) -> Option<&[DbInstanceStatusInfo]>
pub fn status_infos(&self) -> Option<&[DbInstanceStatusInfo]>
The status of a read replica. If the instance is not a read replica, this is blank.
sourcepub fn db_cluster_identifier(&self) -> Option<&str>
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.
sourcepub fn storage_encrypted(&self) -> bool
pub fn storage_encrypted(&self) -> bool
Specifies whether or not the instance is encrypted.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
sourcepub fn dbi_resource_id(&self) -> Option<&str>
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.
sourcepub fn ca_certificate_identifier(&self) -> Option<&str>
pub fn ca_certificate_identifier(&self) -> Option<&str>
The identifier of the CA certificate for this DB instance.
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
sourcepub fn promotion_tier(&self) -> Option<i32>
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.
sourcepub fn db_instance_arn(&self) -> Option<&str>
pub fn db_instance_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the instance.
sourcepub fn enabled_cloudwatch_logs_exports(&self) -> Option<&[String]>
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
impl DbInstance
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DbInstance.
Trait Implementations§
source§impl Clone for DbInstance
impl Clone for DbInstance
source§fn clone(&self) -> DbInstance
fn clone(&self) -> DbInstance
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for DbInstance
impl Debug for DbInstance
source§impl PartialEq<DbInstance> for DbInstance
impl PartialEq<DbInstance> for DbInstance
source§fn eq(&self, other: &DbInstance) -> bool
fn eq(&self, other: &DbInstance) -> bool
self and other values to be equal, and is used
by ==.