AWS SDK for .NET Documentation
DBInstance Class
AmazonAmazon.RDS.ModelDBInstance Did this page help you?   Yes   No    Tell us about it...

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

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

Declaration Syntax
public class DBInstance
All MembersConstructorsMethodsProperties

Initializes a new instance of the DBInstance class

Specifies the allocated storage size specified in gigabytes.

Indicates that minor version patches are applied automatically.

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

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

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

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

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

Specifies the current state of this database.

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL. 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. Not shown when the returned parameters do not apply to an Oracle DB instance.

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

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

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

Specifies the connection endpoint.

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

Indicates the database engine version.

Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Serves as a hash function for a particular type.
(Inherited from Object.)
Gets the type of the current instance.
(Inherited from Object.)
Provides the date and time the DB instance was created.

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

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

License model information for this DB instance.

Contains the master username for the DB instance.

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

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

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

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

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

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
  • Default VPC:true
  • VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

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

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

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

The status of a read replica. If the instance is not a read replica, this will be blank.

Returns a string that represents the current object.
(Inherited from Object.)
Provides List of VPC security group elements that the DB instance belongs to.

WithAllocatedStorage(Int32) Obsolete.
Sets the AllocatedStorage property

WithAutoMinorVersionUpgrade(Boolean) Obsolete.
Sets the AutoMinorVersionUpgrade property

WithAvailabilityZone(String) Obsolete.
Sets the AvailabilityZone property

WithBackupRetentionPeriod(Int32) Obsolete.
Sets the BackupRetentionPeriod property

WithCharacterSetName(String) Obsolete.
Sets the CharacterSetName property

WithDBInstanceClass(String) Obsolete.
Sets the DBInstanceClass property

WithDBInstanceIdentifier(String) Obsolete.
Sets the DBInstanceIdentifier property

WithDBInstanceStatus(String) Obsolete.
Sets the DBInstanceStatus property

WithDBName(String) Obsolete.
Sets the DBName property

WithDBParameterGroups(array<DBParameterGroupStatus>[]()[][]) Obsolete.
Adds elements to the DBParameterGroups collection

WithDBParameterGroups(IEnumerable<(Of <<'(DBParameterGroupStatus>)>>)) Obsolete.
Adds elements to the DBParameterGroups collection

WithDBSecurityGroups(array<DBSecurityGroupMembership>[]()[][]) Obsolete.
Adds elements to the DBSecurityGroups collection

WithDBSecurityGroups(IEnumerable<(Of <<'(DBSecurityGroupMembership>)>>)) Obsolete.
Adds elements to the DBSecurityGroups collection

WithDBSubnetGroup(DBSubnetGroup) Obsolete.
Sets the DBSubnetGroup property

WithEndpoint(Endpoint) Obsolete.
Sets the Endpoint property

WithEngine(String) Obsolete.
Sets the Engine property

WithEngineVersion(String) Obsolete.
Sets the EngineVersion property

WithInstanceCreateTime(DateTime) Obsolete.
Sets the InstanceCreateTime property

WithIops(Int32) Obsolete.
Sets the Iops property

WithLatestRestorableTime(DateTime) Obsolete.
Sets the LatestRestorableTime property

WithLicenseModel(String) Obsolete.
Sets the LicenseModel property

WithMasterUsername(String) Obsolete.
Sets the MasterUsername property

WithMultiAZ(Boolean) Obsolete.
Sets the MultiAZ property

WithOptionGroupMemberships(array<OptionGroupMembership>[]()[][]) Obsolete.
Adds elements to the OptionGroupMemberships collection

WithOptionGroupMemberships(IEnumerable<(Of <<'(OptionGroupMembership>)>>)) Obsolete.
Adds elements to the OptionGroupMemberships collection

WithPendingModifiedValues(PendingModifiedValues) Obsolete.
Sets the PendingModifiedValues property

WithPreferredBackupWindow(String) Obsolete.
Sets the PreferredBackupWindow property

WithPreferredMaintenanceWindow(String) Obsolete.
Sets the PreferredMaintenanceWindow property

WithPubliclyAccessible(Boolean) Obsolete.
Sets the PubliclyAccessible property

WithReadReplicaDBInstanceIdentifiers(array<String>[]()[][]) Obsolete.
Adds elements to the ReadReplicaDBInstanceIdentifiers collection

WithReadReplicaDBInstanceIdentifiers(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Adds elements to the ReadReplicaDBInstanceIdentifiers collection

WithReadReplicaSourceDBInstanceIdentifier(String) Obsolete.
Sets the ReadReplicaSourceDBInstanceIdentifier property

WithSecondaryAvailabilityZone(String) Obsolete.
Sets the SecondaryAvailabilityZone property

WithStatusInfos(array<DBInstanceStatusInfo>[]()[][]) Obsolete.
Adds elements to the StatusInfos collection

WithStatusInfos(IEnumerable<(Of <<'(DBInstanceStatusInfo>)>>)) Obsolete.
Adds elements to the StatusInfos collection

WithVpcSecurityGroups(array<VpcSecurityGroupMembership>[]()[][]) Obsolete.
Adds elements to the VpcSecurityGroups collection

WithVpcSecurityGroups(IEnumerable<(Of <<'(VpcSecurityGroupMembership>)>>)) Obsolete.
Adds elements to the VpcSecurityGroups collection

Inheritance Hierarchy

Assembly: AWSSDK (Module: AWSSDK) Version: (