Snapshot

Gets and sets the property 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.

Gets and sets the property ActualIncrementalBackupSizeInMegaBytes.

The size of the incremental backup.

Gets and sets the property AvailabilityZone.

The Availability Zone in which the cluster was created.

Gets and sets the property BackupProgressInMegaBytes.

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

Gets and sets the property ClusterCreateTime.

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

Gets and sets the property ClusterIdentifier.

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

Gets and sets the property ClusterVersion.

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

Gets and sets the property CurrentBackupRateInMegaBytesPerSecond.

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

Gets and sets the property DBName.

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

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.

Gets and sets the property Encrypted.

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

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.

Gets and sets the property EngineFullVersion.

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

Gets and sets the property 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

Gets and sets the property EstimatedSecondsToCompletion.

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

Gets and sets the property 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.

Gets and sets the property MaintenanceTrackName.

The name of the maintenance track for the snapshot.

Gets and sets the property ManualSnapshotRemainingDays.

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

Gets and sets the property 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.

Gets and sets the property MasterPasswordSecretArn.

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

Gets and sets the property MasterPasswordSecretKmsKeyId.

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

Gets and sets the property MasterUsername.

The admin user name for the cluster.

Gets and sets the property NodeType.

The node type of the nodes in the cluster.

Gets and sets the property NumberOfNodes.

The number of nodes in the cluster.

Gets and sets the property 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.

Gets and sets the property Port.

The port that the cluster is listening on.

Gets and sets the property RestorableNodeTypes.

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

Gets and sets the property SnapshotArn.

The Amazon Resource Name (ARN) of the snapshot.

Gets and sets the property 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.

Gets and sets the property SnapshotIdentifier.

The snapshot identifier that is provided in the request.

Gets and sets the property SnapshotRetentionStartTime.

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

Gets and sets the property SnapshotType.

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

Gets and sets the property SourceRegion.

The source region from which the snapshot was copied.

Gets and sets the property 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".

Gets and sets the property Tags.

The list of tags for the cluster snapshot.

Gets and sets the property TotalBackupSizeInMegaBytes.

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

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.