AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inheritance Hierarchy

System.Object
  Amazon.RDS.Model.DBInstance

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class DBInstance

The DBInstance type exposes the following members

Constructors

NameDescription
Public Method DBInstance()

Properties

NameTypeDescription
Public Property AllocatedStorage System.Int32

Gets and sets the property AllocatedStorage.

Specifies the allocated storage size specified in gigabytes.

Public Property AutoMinorVersionUpgrade System.Boolean

Gets and sets the property AutoMinorVersionUpgrade.

Indicates that minor version patches are applied automatically.

Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

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

Public Property BackupRetentionPeriod System.Int32

Gets and sets the property BackupRetentionPeriod.

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

Public Property CACertificateIdentifier System.String

Gets and sets the property CACertificateIdentifier.

The identifier of the CA certificate for this DB instance.

Public Property CharacterSetName System.String

Gets and sets the property CharacterSetName.

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

Public Property CopyTagsToSnapshot System.Boolean

Gets and sets the property CopyTagsToSnapshot.

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

Public Property DBClusterIdentifier System.String

Gets and sets the property DBClusterIdentifier.

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.

Public Property DBInstanceArn System.String

Gets and sets the property DBInstanceArn.

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

Public Property DBInstanceClass System.String

Gets and sets the property DBInstanceClass.

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

Public Property DBInstanceIdentifier System.String

Gets and sets the property DBInstanceIdentifier.

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

Public Property DbInstancePort System.Int32

Gets and sets the property DbInstancePort.

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.

Public Property DBInstanceStatus System.String

Gets and sets the property DBInstanceStatus.

Specifies the current state of this database.

Public Property DbiResourceId System.String

Gets and sets the property DbiResourceId.

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

Public Property DBName System.String

Gets and sets the property DBName.

The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

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.

Public Property DBParameterGroups System.Collections.Generic.List<Amazon.RDS.Model.DBParameterGroupStatus>

Gets and sets the property DBParameterGroups.

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

Public Property DBSecurityGroups System.Collections.Generic.List<Amazon.RDS.Model.DBSecurityGroupMembership>

Gets and sets the property DBSecurityGroups.

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

Public Property DBSubnetGroup Amazon.RDS.Model.DBSubnetGroup

Gets and sets the property DBSubnetGroup.

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

Public Property DomainMemberships System.Collections.Generic.List<Amazon.RDS.Model.DomainMembership>

Gets and sets the property DomainMemberships.

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

Public Property Endpoint Amazon.RDS.Model.Endpoint

Gets and sets the property Endpoint.

Specifies the connection endpoint.

Public Property Engine System.String

Gets and sets the property Engine.

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

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

Indicates the database engine version.

Public Property EnhancedMonitoringResourceArn System.String

Gets and sets the property EnhancedMonitoringResourceArn.

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

Public Property IAMDatabaseAuthenticationEnabled System.Boolean

Gets and sets the property IAMDatabaseAuthenticationEnabled.

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

Public Property InstanceCreateTime System.DateTime

Gets and sets the property InstanceCreateTime.

Provides the date and time the DB instance was created.

Public Property Iops System.Int32

Gets and sets the property Iops.

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

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

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

Public Property LatestRestorableTime System.DateTime

Gets and sets the property LatestRestorableTime.

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

Public Property LicenseModel System.String

Gets and sets the property LicenseModel.

License model information for this DB instance.

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

Contains the master username for the DB instance.

Public Property MonitoringInterval System.Int32

Gets and sets the property MonitoringInterval.

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

Public Property MonitoringRoleArn System.String

Gets and sets the property MonitoringRoleArn.

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

Public Property MultiAZ System.Boolean

Gets and sets the property MultiAZ.

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

Public Property OptionGroupMemberships System.Collections.Generic.List<Amazon.RDS.Model.OptionGroupMembership>

Gets and sets the property OptionGroupMemberships.

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

Public Property PendingModifiedValues Amazon.RDS.Model.PendingModifiedValues

Gets and sets the property 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.

Public Property PerformanceInsightsEnabled System.Boolean

Gets and sets the property PerformanceInsightsEnabled.

Public Property PerformanceInsightsKMSKeyId System.String

Gets and sets the property PerformanceInsightsKMSKeyId.

Public Property PreferredBackupWindow System.String

Gets and sets the property PreferredBackupWindow.

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

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

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

Public Property PromotionTier System.Int32

Gets and sets the property PromotionTier.

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.

Public Property PubliclyAccessible System.Boolean

Gets and sets the property PubliclyAccessible.

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.

Public Property ReadReplicaDBClusterIdentifiers System.Collections.Generic.List<System.String>

Gets and sets the property ReadReplicaDBClusterIdentifiers.

Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.

Public Property ReadReplicaDBInstanceIdentifiers System.Collections.Generic.List<System.String>

Gets and sets the property ReadReplicaDBInstanceIdentifiers.

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

Public Property ReadReplicaSourceDBInstanceIdentifier System.String

Gets and sets the property ReadReplicaSourceDBInstanceIdentifier.

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

Public Property SecondaryAvailabilityZone System.String

Gets and sets the property SecondaryAvailabilityZone.

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

Public Property StatusInfos System.Collections.Generic.List<Amazon.RDS.Model.DBInstanceStatusInfo>

Gets and sets the property StatusInfos.

The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

Public Property StorageEncrypted System.Boolean

Gets and sets the property StorageEncrypted.

Specifies whether the DB instance is encrypted.

Public Property StorageType System.String

Gets and sets the property StorageType.

Specifies the storage type associated with DB instance.

Public Property TdeCredentialArn System.String

Gets and sets the property TdeCredentialArn.

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

Public Property Timezone System.String

Gets and sets the property Timezone.

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.

Public Property VpcSecurityGroups System.Collections.Generic.List<Amazon.RDS.Model.VpcSecurityGroupMembership>

Gets and sets the property VpcSecurityGroups.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms