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

  • CreateDBInstance
  • DeleteDBInstance
  • ModifyDBInstance

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

Namespace: Amazon.RDS.Model
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class DBInstance
Public Class DBInstance
public ref class DBInstance

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
DBInstance()()()()
Initializes a new instance of the DBInstance class
AllocatedStorage
Specifies the allocated storage size specified in gigabytes.
AutoMinorVersionUpgrade
Indicates that minor version patches are applied automatically.
AvailabilityZone
Specifies the name of the Availability Zone the DB Instance is located in.
BackupRetentionPeriod
Specifies the number of days for which automatic DB Snapshots are retained.
DBInstanceClass
Contains the name of the compute and memory capacity class of the DB Instance.
DBInstanceIdentifier
Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance.
DBInstanceStatus
Specifies the current state of this database.
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.
DBParameterGroups
Provides the list of DB Parameter Groups applied to this DB Instance.
DBSecurityGroups
Provides List of DB Security Group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
DBSubnetGroup
Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group.
Endpoint
Specifies the connection endpoint.
Engine
Provides the name of the database engine to be used for this DB Instance.
EngineVersion
Indicates the database engine version.
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
InstanceCreateTime
Provides the date and time the DB Instance was created.
LatestRestorableTime
Specifies the latest time to which a database can be restored with point-in-time restore.
LicenseModel
License model information for this DB Instance.
MasterUsername
Contains the master username for the DB Instance.
MultiAZ
Specifies if the DB Instance is a Multi-AZ deployment.
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.
PreferredBackupWindow
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
PreferredMaintenanceWindow
Specifies the weekly time range (in UTC) during which system maintenance can occur.
ReadReplicaDBInstanceIdentifiers
Contains one or more identifiers of the Read Replicas associated with this DB Instance.
ReadReplicaSourceDBInstanceIdentifier
Contains the identifier of the source DB Instance if this DB Instance is a Read Replica.
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
WithAllocatedStorage(Int32)
Sets the AllocatedStorage property
WithAutoMinorVersionUpgrade(Boolean)
Sets the AutoMinorVersionUpgrade property
WithAvailabilityZone(String)
Sets the AvailabilityZone property
WithBackupRetentionPeriod(Int32)
Sets the BackupRetentionPeriod property
WithDBInstanceClass(String)
Sets the DBInstanceClass property
WithDBInstanceIdentifier(String)
Sets the DBInstanceIdentifier property
WithDBInstanceStatus(String)
Sets the DBInstanceStatus property
WithDBName(String)
Sets the DBName property
WithDBParameterGroups(array<DBParameterGroupStatus>[]()[][])
Adds elements to the DBParameterGroups collection
WithDBParameterGroups(IEnumerable<(Of <<'(DBParameterGroupStatus>)>>))
Adds elements to the DBParameterGroups collection
WithDBSecurityGroups(array<DBSecurityGroupMembership>[]()[][])
Adds elements to the DBSecurityGroups collection
WithDBSecurityGroups(IEnumerable<(Of <<'(DBSecurityGroupMembership>)>>))
Adds elements to the DBSecurityGroups collection
WithDBSubnetGroup(DBSubnetGroup)
Sets the DBSubnetGroup property
WithEndpoint(Endpoint)
Sets the Endpoint property
WithEngine(String)
Sets the Engine property
WithEngineVersion(String)
Sets the EngineVersion property
WithInstanceCreateTime(DateTime)
Sets the InstanceCreateTime property
WithLatestRestorableTime(DateTime)
Sets the LatestRestorableTime property
WithLicenseModel(String)
Sets the LicenseModel property
WithMasterUsername(String)
Sets the MasterUsername property
WithMultiAZ(Boolean)
Sets the MultiAZ property
WithPendingModifiedValues(PendingModifiedValues)
Sets the PendingModifiedValues property
WithPreferredBackupWindow(String)
Sets the PreferredBackupWindow property
WithPreferredMaintenanceWindow(String)
Sets the PreferredMaintenanceWindow property
WithReadReplicaDBInstanceIdentifiers(IEnumerable<(Of <<'(String>)>>))
Adds elements to the ReadReplicaDBInstanceIdentifiers collection
WithReadReplicaDBInstanceIdentifiers(array<String>[]()[][])
Adds elements to the ReadReplicaDBInstanceIdentifiers collection
WithReadReplicaSourceDBInstanceIdentifier(String)
Sets the ReadReplicaSourceDBInstanceIdentifier property

Inheritance Hierarchy

System..::..Object
  Amazon.RDS.Model..::..DBInstance

See Also