Struct aws_sdk_rds::model::DbInstance

source · [−]

#[non_exhaustive]
pub struct DbInstance {Show 74 fields
    pub db_instance_identifier: Option<String>,
    pub db_instance_class: Option<String>,
    pub engine: Option<String>,
    pub db_instance_status: Option<String>,
    pub automatic_restart_time: Option<DateTime>,
    pub master_username: Option<String>,
    pub db_name: Option<String>,
    pub endpoint: Option<Endpoint>,
    pub allocated_storage: i32,
    pub instance_create_time: Option<DateTime>,
    pub preferred_backup_window: Option<String>,
    pub backup_retention_period: i32,
    pub db_security_groups: Option<Vec<DbSecurityGroupMembership>>,
    pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
    pub db_parameter_groups: Option<Vec<DbParameterGroupStatus>>,
    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 multi_az: bool,
    pub engine_version: Option<String>,
    pub auto_minor_version_upgrade: bool,
    pub read_replica_source_db_instance_identifier: Option<String>,
    pub read_replica_db_instance_identifiers: Option<Vec<String>>,
    pub read_replica_db_cluster_identifiers: Option<Vec<String>>,
    pub replica_mode: Option<ReplicaMode>,
    pub license_model: Option<String>,
    pub iops: Option<i32>,
    pub option_group_memberships: Option<Vec<OptionGroupMembership>>,
    pub character_set_name: Option<String>,
    pub nchar_character_set_name: Option<String>,
    pub secondary_availability_zone: Option<String>,
    pub publicly_accessible: bool,
    pub status_infos: Option<Vec<DbInstanceStatusInfo>>,
    pub storage_type: Option<String>,
    pub tde_credential_arn: Option<String>,
    pub db_instance_port: i32,
    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 domain_memberships: Option<Vec<DomainMembership>>,
    pub copy_tags_to_snapshot: bool,
    pub monitoring_interval: Option<i32>,
    pub enhanced_monitoring_resource_arn: Option<String>,
    pub monitoring_role_arn: Option<String>,
    pub promotion_tier: Option<i32>,
    pub db_instance_arn: Option<String>,
    pub timezone: Option<String>,
    pub iam_database_authentication_enabled: bool,
    pub performance_insights_enabled: Option<bool>,
    pub performance_insights_kms_key_id: Option<String>,
    pub performance_insights_retention_period: Option<i32>,
    pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
    pub processor_features: Option<Vec<ProcessorFeature>>,
    pub deletion_protection: bool,
    pub associated_roles: Option<Vec<DbInstanceRole>>,
    pub listener_endpoint: Option<Endpoint>,
    pub max_allocated_storage: Option<i32>,
    pub tag_list: Option<Vec<Tag>>,
    pub db_instance_automated_backups_replications: Option<Vec<DbInstanceAutomatedBackupsReplication>>,
    pub customer_owned_ip_enabled: Option<bool>,
    pub aws_backup_recovery_point_arn: Option<String>,
    pub activity_stream_status: Option<ActivityStreamStatus>,
    pub activity_stream_kms_key_id: Option<String>,
    pub activity_stream_kinesis_stream_name: Option<String>,
    pub activity_stream_mode: Option<ActivityStreamMode>,
    pub activity_stream_engine_native_audit_fields_included: Option<bool>,
    pub automation_mode: Option<AutomationMode>,
    pub resume_full_automation_mode_time: Option<DateTime>,
    pub custom_iam_instance_profile: Option<String>,
    pub backup_target: Option<String>,
}

Expand description

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

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-supplied database identifier. This identifier is the unique key that identifies a DB instance.

db_instance_class: Option<String>

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

engine: Option<String>

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

db_instance_status: Option<String>

Specifies the current state of this database.

For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

automatic_restart_time: Option<DateTime>

The time when a stopped DB instance is restarted automatically.

master_username: Option<String>

Contains the master username for the DB instance.

db_name: Option<String>

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

endpoint: Option<Endpoint>

Specifies the connection endpoint.

The endpoint might not be shown for instances whose status is creating.

allocated_storage: i32

Specifies the allocated storage size specified in gibibytes (GiB).

instance_create_time: Option<DateTime>

Provides the date and time the DB 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 DB snapshots are retained.

db_security_groups: Option<Vec<DbSecurityGroupMembership>>

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

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

db_parameter_groups: Option<Vec<DbParameterGroupStatus>>

Provides the list of DB parameter groups applied to this DB instance.

availability_zone: Option<String>

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

db_subnet_group: Option<DbSubnetGroup>

Specifies information on the subnet group associated with the DB 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>

A value that specifies that changes to the DB instance are pending. This element is only included 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.

multi_az: bool

Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

engine_version: Option<String>

Indicates the database engine version.

auto_minor_version_upgrade: bool

A value that indicates that minor version patches are applied automatically.

read_replica_source_db_instance_identifier: Option<String>

Contains the identifier of the source DB instance if this DB instance is a read replica.

read_replica_db_instance_identifiers: Option<Vec<String>>

Contains one or more identifiers of the read replicas associated with this DB instance.

read_replica_db_cluster_identifiers: Option<Vec<String>>

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

replica_mode: Option<ReplicaMode>

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

license_model: Option<String>

License model information for this DB instance. This setting doesn't apply to RDS Custom.

iops: Option<i32>

Specifies the Provisioned IOPS (I/O operations per second) value.

option_group_memberships: Option<Vec<OptionGroupMembership>>

Provides the list of option group memberships for this DB instance.

character_set_name: Option<String>

If present, specifies the name of the character set that this instance is associated with.

nchar_character_set_name: Option<String>

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

secondary_availability_zone: Option<String>

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

publicly_accessible: bool

Specifies the accessibility options for the DB instance.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

status_infos: Option<Vec<DbInstanceStatusInfo>>

The status of a read replica. If the instance isn't a read replica, this is blank.

storage_type: Option<String>

Specifies the storage type associated with DB instance.

tde_credential_arn: Option<String>

The ARN from the key store with which the instance is associated for TDE encryption.

db_instance_port: i32

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

db_cluster_identifier: Option<String>

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

storage_encrypted: bool

Specifies whether the DB instance is encrypted.

kms_key_id: Option<String>

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.

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

dbi_resource_id: Option<String>

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

ca_certificate_identifier: Option<String>

The identifier of the CA certificate for this DB instance.

domain_memberships: Option<Vec<DomainMembership>>

The Active Directory Domain membership records associated with the DB instance.

copy_tags_to_snapshot: bool

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

monitoring_interval: Option<i32>

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

enhanced_monitoring_resource_arn: Option<String>

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

monitoring_role_arn: Option<String>

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

promotion_tier: Option<i32>

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

db_instance_arn: Option<String>

The Amazon Resource Name (ARN) for the DB instance.

timezone: Option<String>

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

iam_database_authentication_enabled: bool

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

performance_insights_enabled: Option<bool>

True if Performance Insights is enabled for the DB instance, and otherwise false.

performance_insights_kms_key_id: Option<String>

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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

performance_insights_retention_period: Option<i32>

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

enabled_cloudwatch_logs_exports: Option<Vec<String>>

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

processor_features: Option<Vec<ProcessorFeature>>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

deletion_protection: bool

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

associated_roles: Option<Vec<DbInstanceRole>>

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

listener_endpoint: Option<Endpoint>

Specifies the listener connection endpoint for SQL Server Always On.

max_allocated_storage: Option<i32>

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

tag_list: Option<Vec<Tag>>

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

db_instance_automated_backups_replications: Option<Vec<DbInstanceAutomatedBackupsReplication>>

The list of replicated automated backups associated with the DB instance.

customer_owned_ip_enabled: Option<bool>

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

aws_backup_recovery_point_arn: Option<String>

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

activity_stream_status: Option<ActivityStreamStatus>

The status of the database activity stream.

activity_stream_kms_key_id: Option<String>

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

activity_stream_kinesis_stream_name: Option<String>

The name of the Amazon Kinesis data stream used for the database activity stream.

activity_stream_mode: Option<ActivityStreamMode>

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

activity_stream_engine_native_audit_fields_included: Option<bool>

Indicates whether engine-native audit fields are included in the database activity stream.

automation_mode: Option<AutomationMode>

The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

resume_full_automation_mode_time: Option<DateTime>

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

custom_iam_instance_profile: Option<String>

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide.

backup_target: Option<String>

Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

Struct aws_sdk_rds::model::DbInstance

Fields (Non-exhaustive)

Implementations

impl DbInstance

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

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

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

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

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

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

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

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

pub fn allocated_storage(&self) -> i32

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

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

pub fn backup_retention_period(&self) -> i32

pub fn db_security_groups(&self) -> Option<&[DbSecurityGroupMembership]>

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

pub fn db_parameter_groups(&self) -> Option<&[DbParameterGroupStatus]>

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

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

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

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

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

pub fn multi_az(&self) -> bool

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

pub fn auto_minor_version_upgrade(&self) -> bool

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

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

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

pub fn replica_mode(&self) -> Option<&ReplicaMode>

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

pub fn iops(&self) -> Option<i32>

pub fn option_group_memberships(&self) -> Option<&[OptionGroupMembership]>

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

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

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

pub fn publicly_accessible(&self) -> bool

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

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

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

pub fn db_instance_port(&self) -> i32

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

pub fn storage_encrypted(&self) -> bool

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

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

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

pub fn domain_memberships(&self) -> Option<&[DomainMembership]>

pub fn copy_tags_to_snapshot(&self) -> bool

pub fn monitoring_interval(&self) -> Option<i32>

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

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

pub fn promotion_tier(&self) -> Option<i32>

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

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

pub fn iam_database_authentication_enabled(&self) -> bool

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

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

pub fn performance_insights_retention_period(&self) -> Option<i32>

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

pub fn processor_features(&self) -> Option<&[ProcessorFeature]>

pub fn deletion_protection(&self) -> bool

pub fn associated_roles(&self) -> Option<&[DbInstanceRole]>

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

pub fn max_allocated_storage(&self) -> Option<i32>

pub fn tag_list(&self) -> Option<&[Tag]>

pub fn db_instance_automated_backups_replications( &self) -> Option<&[DbInstanceAutomatedBackupsReplication]>

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

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

pub fn activity_stream_status(&self) -> Option<&ActivityStreamStatus>

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

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

pub fn activity_stream_mode(&self) -> Option<&ActivityStreamMode>

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

pub fn automation_mode(&self) -> Option<&AutomationMode>

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

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

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

impl DbInstance

pub fn builder() -> Builder

pub fn db_security_groups(&self) -> Option<&[DbSecurityGroupMembership ]>

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

pub fn db_parameter_groups(&self) -> Option<&[DbParameterGroupStatus ]>

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

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

pub fn option_group_memberships(&self) -> Option<&[OptionGroupMembership ]>

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

pub fn domain_memberships(&self) -> Option<&[DomainMembership ]>

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

pub fn processor_features(&self) -> Option<&[ProcessorFeature ]>

pub fn associated_roles(&self) -> Option<&[DbInstanceRole ]>

pub fn tag_list(&self) -> Option<&[Tag ]>

pub fn db_instance_automated_backups_replications(
&self
) -> Option<&[DbInstanceAutomatedBackupsReplication ]>

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

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

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