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 details of an Amazon Neptune DB instance.

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

Inheritance Hierarchy

System.Object
  Amazon.Neptune.Model.DBInstance

Namespace: Amazon.Neptune.Model
Assembly: AWSSDK.Neptune.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.

Not supported by Neptune.

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.

(Not supported by Neptune)

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 Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.

Public Property DBName System.String

Gets and sets the property DBName.

The database name.

Public Property DBParameterGroups System.Collections.Generic.List<Amazon.Neptune.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.Neptune.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.Neptune.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 DeletionProtection System.Boolean

Gets and sets the property DeletionProtection.

Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

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

Gets and sets the property DomainMemberships.

Not supported

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

Gets and sets the property EnabledCloudwatchLogsExports.

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

Public Property Endpoint Amazon.Neptune.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 Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

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.

Not supported: The encryption for DB instances is managed by the DB cluster.

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.

Not supported by Neptune.

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 Neptune to send Enhanced Monitoring metrics to Amazon 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.Neptune.Model.OptionGroupMembership>

Gets and sets the property OptionGroupMemberships.

(Not supported by Neptune)

Public Property PendingModifiedValues Amazon.Neptune.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.

(Not supported by Neptune)

Public Property PerformanceInsightsKMSKeyId System.String

Gets and sets the property PerformanceInsightsKMSKeyId.

(Not supported by Neptune)

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 a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

Public Property PubliclyAccessible System.Boolean

Gets and sets the property PubliclyAccessible.

This flag should no longer be used.

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

Gets and sets the property ReadReplicaDBClusterIdentifiers.

Contains one or more identifiers of 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.Neptune.Model.DBInstanceStatusInfo>

Gets and sets the property StatusInfos.

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

Public Property StorageEncrypted System.Boolean

Gets and sets the property StorageEncrypted.

Not supported: The encryption for DB instances is managed by the DB cluster.

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.

Not supported.

Public Property VpcSecurityGroups System.Collections.Generic.List<Amazon.Neptune.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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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