rds/aws.sdk.kotlin.services.rds.model/DbClusterSnapshot

DbClusterSnapshot

class DbClusterSnapshot

Contains the details for an Amazon RDS DB cluster snapshot

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

Types

object Companion

Properties

allocatedStorage

val allocatedStorage: Int?

The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

availabilityZones

val availabilityZones: List<String>?

The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

clusterCreateTime

val clusterCreateTime: Instant?

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

dbClusterIdentifier

val dbClusterIdentifier: String?

The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

dbClusterResourceId

val dbClusterResourceId: String?

The resource ID of the DB cluster that this DB cluster snapshot was created from.

dbClusterSnapshotArn

val dbClusterSnapshotArn: String?

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

dbClusterSnapshotIdentifier

val dbClusterSnapshotIdentifier: String?

The identifier for the DB cluster snapshot.

val dbSystemId: String?

Reserved for future use.

val engine: String?

The name of the database engine for this DB cluster snapshot.

val engineMode: String?

The engine mode of the database engine for this DB cluster snapshot.

val engineVersion: String?

The version of the database engine for this DB cluster snapshot.

iamDatabaseAuthenticationEnabled

val iamDatabaseAuthenticationEnabled: Boolean?

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

val kmsKeyId: String?

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

val licenseModel: String?

The license model information for this DB cluster snapshot.

val masterUsername: String?

The master username for this DB cluster snapshot.

percentProgress

val percentProgress: Int?

The percentage of the estimated data that has been transferred.

val port: Int?

The port that the DB cluster was listening on at the time of the snapshot.

snapshotCreateTime

val snapshotCreateTime: Instant?

The time when the snapshot was taken, in Universal Coordinated Time (UTC).

val snapshotType: String?

The type of the DB cluster snapshot.

sourceDbClusterSnapshotArn

val sourceDbClusterSnapshotArn: String?

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

val status: String?

The status of this DB cluster snapshot. Valid statuses are the following:

storageEncrypted

val storageEncrypted: Boolean?

Indicates whether the DB cluster snapshot is encrypted.

storageThroughput

val storageThroughput: Int?

The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

val storageType: String?

The storage type associated with the DB cluster snapshot.

val tagList: List<Tag>?

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

val vpcId: String?

The VPC ID associated with the DB cluster snapshot.

Functions

inline fun copy(block: DbClusterSnapshot.Builder.() -> Unit = {}): DbClusterSnapshot

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String