DbInstance

Contains the details of an Amazon Neptune DB instance.

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Not supported by Neptune.

Link copied to clipboard

Indicates that minor version patches are applied automatically.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The identifier of the CA certificate for this DB instance.

Link copied to clipboard

(Not supported by Neptune)

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Specifies the current state of this database.

Link copied to clipboard

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.

Link copied to clipboard

The database name.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Specifies the connection endpoint.

Link copied to clipboard

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

Link copied to clipboard

Indicates the database engine version.

Link copied to clipboard

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

Link copied to clipboard

True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

Link copied to clipboard

Provides the date and time the DB instance was created.

Link copied to clipboard
val iops: Int?

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

License model information for this DB instance.

Link copied to clipboard

Not supported by Neptune.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

(Not supported by Neptune)

Link copied to clipboard

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

Link copied to clipboard

(Not supported by Neptune)

Link copied to clipboard

(Not supported by Neptune)

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

This flag should no longer be used.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Specifies the storage type associated with DB instance.

Link copied to clipboard

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

Link copied to clipboard

Not supported.

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: DbInstance.Builder.() -> Unit = {}): DbInstance
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String