You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::DBInstance

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the DescribeDBInstances action.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

Specifies the allocated storage size specified in gibibytes.

Returns:

  • (Integer) —

    Specifies the allocated storage size specified in gibibytes.

#associated_roles ⇒ Array<Types::DBInstanceRole>

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Returns:

  • (Array<Types::DBInstanceRole>) —

    The AWS Identity and Access Management (IAM) roles associated with the DB instance.

#auto_minor_version_upgrade ⇒ Boolean

Indicates that minor version patches are applied automatically.

Returns:

  • (Boolean) —

    Indicates that minor version patches are applied automatically.

#availability_zone ⇒ String

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

Returns:

  • (String) —

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

#backup_retention_period ⇒ Integer

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

Returns:

  • (Integer) —

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

#ca_certificate_identifier ⇒ String

The identifier of the CA certificate for this DB instance.

Returns:

  • (String) —

    The identifier of the CA certificate for this DB instance.

#character_set_name ⇒ String

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

Returns:

  • (String) —

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

#copy_tags_to_snapshot ⇒ Boolean

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.

Returns:

  • (Boolean) —

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

#db_cluster_identifier ⇒ 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.

Returns:

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

#db_instance_arn ⇒ String

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

Returns:

  • (String) —

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

#db_instance_class ⇒ String

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

Returns:

  • (String) —

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

#db_instance_identifier ⇒ String

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Returns:

  • (String) —

    Contains a user-supplied database identifier.

#db_instance_port ⇒ Integer

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.

Returns:

  • (Integer) —

    Specifies the port that the DB instance listens on.

#db_instance_status ⇒ String

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Returns:

  • (String) —

    Specifies the current state of this database.

#db_name ⇒ 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.

Returns:

  • (String) —

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

#db_parameter_groups ⇒ Array<Types::DBParameterGroupStatus>

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

Returns:

#db_security_groups ⇒ Array<Types::DBSecurityGroupMembership>

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

Returns:

#db_subnet_group ⇒ Types::DBSubnetGroup

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

Returns:

  • (Types::DBSubnetGroup) —

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

#dbi_resource_id ⇒ String

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

Returns:

  • (String) —

    The AWS Region-unique, immutable identifier for the DB instance.

#deletion_protection ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Indicates if the DB instance has deletion protection enabled.

#domain_memberships ⇒ Array<Types::DomainMembership>

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

Returns:

  • (Array<Types::DomainMembership>) —

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

#enabled_cloudwatch_logs_exports ⇒ Array<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.

Returns:

  • (Array<String>) —

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

#endpoint ⇒ Types::Endpoint

Specifies the connection endpoint.

Returns:

#engine ⇒ String

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

Returns:

  • (String) —

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

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String) —

    Indicates the database engine version.

#enhanced_monitoring_resource_arn ⇒ String

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

Returns:

  • (String) —

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

#iam_database_authentication_enabled ⇒ Boolean

True if mapping of AWS 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.

Returns:

  • (Boolean) —

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

#instance_create_time ⇒ Time

Provides the date and time the DB instance was created.

Returns:

  • (Time) —

    Provides the date and time the DB instance was created.

#iops ⇒ Integer

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

Returns:

  • (Integer) —

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

#kms_key_id ⇒ String

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

Returns:

  • (String) —

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

#latest_restorable_time ⇒ Time

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

Returns:

  • (Time) —

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

#license_model ⇒ String

License model information for this DB instance.

Returns:

  • (String) —

    License model information for this DB instance.

#listener_endpoint ⇒ Types::Endpoint

Specifies the listener connection endpoint for SQL Server Always On.

Returns:

  • (Types::Endpoint) —

    Specifies the listener connection endpoint for SQL Server Always On.

#master_username ⇒ String

Contains the master username for the DB instance.

Returns:

  • (String) —

    Contains the master username for the DB instance.

#max_allocated_storage ⇒ Integer

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Returns:

  • (Integer) —

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

#monitoring_interval ⇒ Integer

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

Returns:

  • (Integer) —

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

#monitoring_role_arn ⇒ String

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

Returns:

  • (String) —

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

#multi_az ⇒ Boolean

Specifies if the DB instance is a Multi-AZ deployment.

Returns:

  • (Boolean) —

    Specifies if the DB instance is a Multi-AZ deployment.

#nchar_character_set_name ⇒ 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.

Returns:

  • (String) —

    The name of the NCHAR character set for the Oracle DB instance.

#option_group_memberships ⇒ Array<Types::OptionGroupMembership>

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

Returns:

#pending_modified_values ⇒ Types::PendingModifiedValues

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

Returns:

#performance_insights_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#performance_insights_kms_key_id ⇒ String

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

  • (String) —

    The AWS KMS key identifier for encryption of Performance Insights data.

#performance_insights_retention_period ⇒ Integer

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

Returns:

  • (Integer) —

    The amount of time, in days, to retain Performance Insights data.

#preferred_backup_window ⇒ String

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

Returns:

  • (String) —

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

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String) —

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

#processor_features ⇒ Array<Types::ProcessorFeature>

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

Returns:

  • (Array<Types::ProcessorFeature>) —

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

#promotion_tier ⇒ Integer

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.

Returns:

  • (Integer) —

    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.

#publicly_accessible ⇒ Boolean

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance\'s VPC, and to the public IP address from outside of the DB instance\'s VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance 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.

Returns:

  • (Boolean) —

    Specifies the accessibility options for the DB instance.

#read_replica_db_cluster_identifiers ⇒ Array<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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

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

Returns:

  • (Array<String>) —

    Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

#read_replica_db_instance_identifiers ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#read_replica_source_db_instance_identifier ⇒ String

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

Returns:

  • (String) —

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

#replica_mode ⇒ String

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.

Returns:

  • (String) —

    The open mode of an Oracle read replica.

#secondary_availability_zone ⇒ String

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

Returns:

  • (String) —

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

#status_infos ⇒ Array<Types::DBInstanceStatusInfo>

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

Returns:

#storage_encrypted ⇒ Boolean

Specifies whether the DB instance is encrypted.

Returns:

  • (Boolean) —

    Specifies whether the DB instance is encrypted.

#storage_type ⇒ String

Specifies the storage type associated with DB instance.

Returns:

  • (String) —

    Specifies the storage type associated with DB instance.

#tag_list ⇒ Array<Types::Tag>

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

Returns:

#tde_credential_arn ⇒ String

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

Returns:

  • (String) —

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

#timezone ⇒ 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.

Returns:

  • (String) —

    The time zone of the DB instance.

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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

Returns: