Snapshot

class Snapshot

Describes a snapshot.

Types

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

Properties

Link copied to clipboard

A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Link copied to clipboard

The size of the incremental backup.

Link copied to clipboard

The Availability Zone in which the cluster was created.

Link copied to clipboard

The number of megabytes that have been transferred to the snapshot backup.

Link copied to clipboard

The time (UTC) when the cluster was originally created.

Link copied to clipboard

The identifier of the cluster for which the snapshot was taken.

Link copied to clipboard

The version ID of the Amazon Redshift engine that is running on the cluster.

Link copied to clipboard

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Link copied to clipboard

The name of the database that was created when the cluster was created.

Link copied to clipboard

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Link copied to clipboard

If true, the data in the snapshot is encrypted at rest.

Link copied to clipboard

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

Link copied to clipboard

The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

Link copied to clipboard

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

Link copied to clipboard

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Link copied to clipboard

The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Link copied to clipboard

The name of the maintenance track for the snapshot.

Link copied to clipboard

The number of days until a manual snapshot will pass its retention period.

Link copied to clipboard

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

Link copied to clipboard

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

Link copied to clipboard

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

Link copied to clipboard

The admin user name for the cluster.

Link copied to clipboard

The node type of the nodes in the cluster.

Link copied to clipboard

The number of nodes in the cluster.

Link copied to clipboard

For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Link copied to clipboard
val port: Int?

The port that the cluster is listening on.

Link copied to clipboard

The list of node types that this cluster snapshot is able to restore into.

Link copied to clipboard

The Amazon Resource Name (ARN) of the snapshot.

Link copied to clipboard

The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Link copied to clipboard

The snapshot identifier that is provided in the request.

Link copied to clipboard

A timestamp representing the start of the retention period for the snapshot.

Link copied to clipboard

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

Link copied to clipboard

The source region from which the snapshot was copied.

Link copied to clipboard

The snapshot status. The value of the status depends on the API operation used:

Link copied to clipboard
val tags: List<Tag>?

The list of tags for the cluster snapshot.

Link copied to clipboard

The size of the complete set of backup data that would be used to restore the cluster.

Link copied to clipboard

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Functions

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