docdb/aws.sdk.kotlin.services.docdb.model/DbCluster/Builder

Builder

Properties

var associatedRoles: List<DbClusterRole>?

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

availabilityZones

var availabilityZones: List<String>?

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

backupRetentionPeriod

var backupRetentionPeriod: Int?

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

cloneGroupId

var cloneGroupId: String?

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

clusterCreateTime

var clusterCreateTime: Instant?

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

dbClusterArn

var dbClusterArn: String?

The Amazon Resource Name (ARN) for the cluster.

dbClusterIdentifier

var dbClusterIdentifier: String?

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

dbClusterMembers

var dbClusterMembers: List<DbClusterMember>?

Provides the list of instances that make up the cluster.

dbClusterParameterGroup

var dbClusterParameterGroup: String?

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

dbClusterResourceId

var dbClusterResourceId: String?

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

dbSubnetGroup

var dbSubnetGroup: String?

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

deletionProtection

var deletionProtection: Boolean?

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

earliestRestorableTime

var earliestRestorableTime: Instant?

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

enabledCloudwatchLogsExports

var enabledCloudwatchLogsExports: List<String>?

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

endpoint

var endpoint: String?

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

engine

var engine: String?

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

engineVersion

var engineVersion: String?

Indicates the database engine version.

hostedZoneId

var hostedZoneId: String?

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

kmsKeyId

var kmsKeyId: String?

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

latestRestorableTime

var latestRestorableTime: Instant?

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

masterUsername

var masterUsername: String?

Contains the master user name for the cluster.

multiAz

var multiAz: Boolean?

Specifies whether the cluster has instances in multiple Availability Zones.

percentProgress

var percentProgress: String?

Specifies the progress of the operation as a percentage.

port

var port: Int?

Specifies the port that the database engine is listening on.

preferredBackupWindow

var preferredBackupWindow: String?

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

preferredMaintenanceWindow

var preferredMaintenanceWindow: String?

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

readerEndpoint

var readerEndpoint: String?

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

readReplicaIdentifiers

var readReplicaIdentifiers: List<String>?

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

replicationSourceIdentifier

var replicationSourceIdentifier: String?

Contains the identifier of the source cluster if this cluster is a secondary cluster.

status

var status: String?

Specifies the current state of this cluster.

storageEncrypted

var storageEncrypted: Boolean?

Specifies whether the cluster is encrypted.