Documentation

Describes a snapshot.

See: newSnapshot smart constructor.

Create a value of Snapshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountsWithRestoreAccess:Snapshot', snapshot_accountsWithRestoreAccess - 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.

$sel:actualIncrementalBackupSizeInMegaBytes:Snapshot', snapshot_actualIncrementalBackupSizeInMegaBytes - The size of the incremental backup.

$sel:availabilityZone:Snapshot', snapshot_availabilityZone - The Availability Zone in which the cluster was created.

$sel:backupProgressInMegaBytes:Snapshot', snapshot_backupProgressInMegaBytes - The number of megabytes that have been transferred to the snapshot backup.

$sel:clusterCreateTime:Snapshot', snapshot_clusterCreateTime - The time (UTC) when the cluster was originally created.

$sel:clusterIdentifier:Snapshot', snapshot_clusterIdentifier - The identifier of the cluster for which the snapshot was taken.

$sel:clusterVersion:Snapshot', snapshot_clusterVersion - The version ID of the Amazon Redshift engine that is running on the cluster.

$sel:currentBackupRateInMegaBytesPerSecond:Snapshot', snapshot_currentBackupRateInMegaBytesPerSecond - The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

$sel:dbName:Snapshot', snapshot_dbName - The name of the database that was created when the cluster was created.

$sel:elapsedTimeInSeconds:Snapshot', snapshot_elapsedTimeInSeconds - The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

$sel:encrypted:Snapshot', snapshot_encrypted - If true, the data in the snapshot is encrypted at rest.

$sel:encryptedWithHSM:Snapshot', snapshot_encryptedWithHSM - 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.

$sel:engineFullVersion:Snapshot', snapshot_engineFullVersion - The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

$sel:enhancedVpcRouting:Snapshot', snapshot_enhancedVpcRouting - 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.

If this option is true, enhanced VPC routing is enabled.

Default: false

$sel:estimatedSecondsToCompletion:Snapshot', snapshot_estimatedSecondsToCompletion - The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

$sel:kmsKeyId:Snapshot', snapshot_kmsKeyId - 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.

$sel:maintenanceTrackName:Snapshot', snapshot_maintenanceTrackName - The name of the maintenance track for the snapshot.

$sel:manualSnapshotRemainingDays:Snapshot', snapshot_manualSnapshotRemainingDays - The number of days until a manual snapshot will pass its retention period.

$sel:manualSnapshotRetentionPeriod:Snapshot', snapshot_manualSnapshotRetentionPeriod - The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

$sel:masterUsername:Snapshot', snapshot_masterUsername - The admin user name for the cluster.

$sel:nodeType:Snapshot', snapshot_nodeType - The node type of the nodes in the cluster.

$sel:numberOfNodes:Snapshot', snapshot_numberOfNodes - The number of nodes in the cluster.

$sel:ownerAccount:Snapshot', snapshot_ownerAccount - 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.

$sel:port:Snapshot', snapshot_port - The port that the cluster is listening on.

$sel:restorableNodeTypes:Snapshot', snapshot_restorableNodeTypes - The list of node types that this cluster snapshot is able to restore into.

$sel:snapshotCreateTime:Snapshot', snapshot_snapshotCreateTime - 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.

$sel:snapshotIdentifier:Snapshot', snapshot_snapshotIdentifier - The snapshot identifier that is provided in the request.

$sel:snapshotRetentionStartTime:Snapshot', snapshot_snapshotRetentionStartTime - A timestamp representing the start of the retention period for the snapshot.

$sel:snapshotType:Snapshot', snapshot_snapshotType - The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

$sel:sourceRegion:Snapshot', snapshot_sourceRegion - The source region from which the snapshot was copied.

$sel:status:Snapshot', snapshot_status - The snapshot status. The value of the status depends on the API operation used:

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

$sel:tags:Snapshot', snapshot_tags - The list of tags for the cluster snapshot.

$sel:totalBackupSizeInMegaBytes:Snapshot', snapshot_totalBackupSizeInMegaBytes - The size of the complete set of backup data that would be used to restore the cluster.

$sel:vpcId:Snapshot', snapshot_vpcId - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

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.

The size of the incremental backup.

The Availability Zone in which the cluster was created.

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

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

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

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

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

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

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

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

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.

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

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.

If this option is true, enhanced VPC routing is enabled.

Default: false

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

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.

The name of the maintenance track for the snapshot.

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

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

The value must be either -1 or an integer between 1 and 3,653.

The admin user name for the cluster.

The node type of the nodes in the cluster.

The number of nodes in the cluster.

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.

The port that the cluster is listening on.

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

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.

The snapshot identifier that is provided in the request.

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

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

The source region from which the snapshot was copied.

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

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

The list of tags for the cluster snapshot.

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

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