DbCluster

class DbCluster

Contains the details of an Amazon Neptune DB cluster.

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

Types

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

Properties

Link copied to clipboard

AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

Link copied to clipboard

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

Link copied to clipboard

Time at which the DB cluster will be automatically restarted.

Link copied to clipboard

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

Link copied to clipboard

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

Link copied to clipboard

Not supported by Neptune.

Link copied to clipboard

Identifies the clone group to which the DB cluster is associated.

Link copied to clipboard

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Link copied to clipboard

If set to true, tags are copied to any snapshot of the DB cluster that is created.

Link copied to clipboard

If set to true, the DB cluster can be cloned across accounts.

Link copied to clipboard

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Provides the list of instances that make up the DB cluster.

Link copied to clipboard
Link copied to clipboard

Specifies the name of the DB cluster parameter group for the DB cluster.

Link copied to clipboard

The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed.

Link copied to clipboard

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

Link copied to clipboard

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Link copied to clipboard

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

Link copied to clipboard

A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

Link copied to clipboard

Specifies the connection endpoint for the primary instance of the DB cluster.

Link copied to clipboard

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

Link copied to clipboard

Indicates the database engine version.

Link copied to clipboard

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

Link copied to clipboard

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Link copied to clipboard

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Link copied to clipboard

The next time you can modify the DB cluster to use the iopt1 storage type.

Link copied to clipboard

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted 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

Not supported by Neptune.

Link copied to clipboard

Specifies whether the DB cluster has instances in multiple Availability Zones.

Link copied to clipboard

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

Link copied to clipboard

Specifies the progress of the operation as a percentage.

Link copied to clipboard
val port: Int?

Specifies the port that the database engine is listening on.

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

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

Link copied to clipboard

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

Link copied to clipboard

Not supported by Neptune.

Link copied to clipboard

Shows the scaling configuration for a Neptune Serverless DB cluster.

Link copied to clipboard

Specifies the current state of this DB cluster.

Link copied to clipboard

Specifies whether the DB cluster is encrypted.

Link copied to clipboard

The storage type used by the DB cluster.

Link copied to clipboard

Provides a list of VPC security groups that the DB cluster belongs to.

Functions

Link copied to clipboard
inline fun copy(block: DbCluster.Builder.() -> Unit = {}): DbCluster
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