AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
Describes a snapshot.

Inheritance Hierarchy

System.Object
  Amazon.Redshift.Model.Snapshot

Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class Snapshot : Object

The Snapshot type exposes the following members

Constructors

NameDescription
Public Method Snapshot()

Properties

NameTypeDescription
Public Property AccountsWithRestoreAccess System.Collections.Generic.List<Amazon.Redshift.Model.AccountWithRestoreAccess> Gets and sets the property AccountsWithRestoreAccess.

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Public Property ActualIncrementalBackupSizeInMegaBytes System.Double Gets and sets the property ActualIncrementalBackupSizeInMegaBytes.

The size of the incremental backup.

Public Property AvailabilityZone System.String Gets and sets the property AvailabilityZone.

The Availability Zone in which the cluster was created.

Public Property BackupProgressInMegaBytes System.Double Gets and sets the property BackupProgressInMegaBytes.

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

Public Property ClusterCreateTime System.DateTime Gets and sets the property ClusterCreateTime.

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

Public Property ClusterIdentifier System.String Gets and sets the property ClusterIdentifier.

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

Public Property ClusterVersion System.String Gets and sets the property ClusterVersion.

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

Public Property CurrentBackupRateInMegaBytesPerSecond System.Double Gets and sets the property CurrentBackupRateInMegaBytesPerSecond.

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

Public Property DBName System.String Gets and sets the property DBName.

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

Public Property ElapsedTimeInSeconds System.Int64 Gets and sets the property 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.

Public Property Encrypted System.Boolean Gets and sets the property Encrypted.

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

Public Property EncryptedWithHSM System.Boolean Gets and sets the property 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.

Public Property EstimatedSecondsToCompletion System.Int64 Gets and sets the property EstimatedSecondsToCompletion.

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

Public Property KmsKeyId System.String Gets and sets the property KmsKeyId.

The AWS 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.

Public Property MasterUsername System.String Gets and sets the property MasterUsername.

The master user name for the cluster.

Public Property NodeType System.String Gets and sets the property NodeType.

The node type of the nodes in the cluster.

Public Property NumberOfNodes System.Int32 Gets and sets the property NumberOfNodes.

The number of nodes in the cluster.

Public Property OwnerAccount System.String Gets and sets the property OwnerAccount.

For manual snapshots, the AWS customer 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.

Public Property Port System.Int32 Gets and sets the property Port.

The port that the cluster is listening on.

Public Property RestorableNodeTypes System.Collections.Generic.List<System.String> Gets and sets the property RestorableNodeTypes.

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

Public Property SnapshotCreateTime System.DateTime Gets and sets the property SnapshotCreateTime.

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

Public Property SnapshotIdentifier System.String Gets and sets the property SnapshotIdentifier.

The snapshot identifier that is provided in the request.

Public Property SnapshotType System.String Gets and sets the property SnapshotType.

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

Public Property SourceRegion System.String Gets and sets the property SourceRegion.

The source region from which the snapshot was copied.

Public Property Status System.String Gets and sets the property Status.

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

Public Property Tags System.Collections.Generic.List<Amazon.Redshift.Model.Tag> Gets and sets the property Tags.

The list of tags for the cluster snapshot.

Public Property TotalBackupSizeInMegaBytes System.Double Gets and sets the property TotalBackupSizeInMegaBytes.

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

Public Property VpcId System.String Gets and sets the property 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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8