Amazon Relational Database Service
API Reference (API Version 2012-04-23)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

DBInstance

Description

Contains the result of a successful invocation of the following actions:

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

Contents

NameDescription
AllocatedStorage

Specifies the allocated storage size specified in gigabytes.

Type: Integer

AutoMinorVersionUpgrade

Indicates that minor version patches are applied automatically.

Type: Boolean

AvailabilityZone

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

Type: String

BackupRetentionPeriod

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

Type: Integer

CharacterSetName

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

Type: String

DBInstanceClass

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

Type: String

DBInstanceIdentifier

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

Type: String

DBInstanceStatus

Specifies the current state of this database.

Type: String

DBName

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

MySQL

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.

Type: String

DBParameterGroups

Provides the list of DB Parameter Groups applied to this DB Instance.

Type: DBParameterGroupStatus list

DBSecurityGroups

Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Type: DBSecurityGroupMembership list

DBSubnetGroup

Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.

Type: DBSubnetGroup

Endpoint

Specifies the connection endpoint.

Type: Endpoint

Engine

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

Type: String

EngineVersion

Indicates the database engine version.

Type: String

InstanceCreateTime

Provides the date and time the DB Instance was created.

Type: DateTime

LatestRestorableTime

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

Type: DateTime

LicenseModel

License model information for this DB Instance.

Type: String

MasterUsername

Contains the master username for the DB Instance.

Type: String

MultiAZ

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

Type: Boolean

OptionGroupMembership

Specifies the name and status of the option group that this instance belongs to.

Type: OptionGroupMembership

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.

Type: PendingModifiedValues

PreferredBackupWindow

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

Type: String

PreferredMaintenanceWindow

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

Type: String

ReadReplicaDBInstanceIdentifiers

Contains one or more identifiers of the Read Replicas associated with this DB Instance.

Type: String list

ReadReplicaSourceDBInstanceIdentifier

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.

Type: String