Redshift Cluster Snapshot

This table represents the Redshift Cluster Snapshot resource from Amazon Web Services.

aws.redshift_cluster_snapshot

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
accounts_with_restore_accesscorejsonA list of the Amazon Web Services accounts authorized to restore the snapshot. Returns <code>null</code> if no accounts are authorized. Visible only to the snapshot owner.
actual_incremental_backup_size_in_mega_bytescorefloat64The size of the incremental backup.
availability_zonecorestringThe Availability Zone in which the cluster was created.
backup_progress_in_mega_bytescorefloat64The number of megabytes that have been transferred to the snapshot backup.
cluster_create_timecoretimestampThe time (UTC) when the cluster was originally created.
cluster_identifiercorestringThe identifier of the cluster for which the snapshot was taken.
cluster_versioncorestringThe version ID of the Amazon Redshift engine that is running on the cluster.
current_backup_rate_in_mega_bytes_per_secondcorefloat64The number of megabytes per second being transferred to the snapshot backup. Returns <code>0</code> for a completed backup.
db_namecorestringThe name of the database that was created when the cluster was created.
elapsed_time_in_secondscoreint64The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
encryptedcoreboolIf <code>true</code>, the data in the snapshot is encrypted at rest.
encrypted_with_hsmcoreboolA boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. <code>true</code> indicates that the data is encrypted using HSM keys.
engine_full_versioncorestringThe cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
enhanced_vpc_routingcoreboolAn 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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide. If this option is <code>true</code>, enhanced VPC routing is enabled. Default: false
estimated_seconds_to_completioncoreint64The estimate of the time remaining before the snapshot backup will complete. Returns <code>0</code> for a completed backup.
kms_key_idcorestringThe 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.
maintenance_track_namecorestringThe name of the maintenance track for the snapshot.
manual_snapshot_remaining_dayscoreint64The number of days until a manual snapshot will pass its retention period.
manual_snapshot_retention_periodcoreint64The 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.
master_password_secret_arncorestringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
master_password_secret_kms_key_idcorestringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
master_usernamecorestringThe admin user name for the cluster.
node_typecorestringThe node type of the nodes in the cluster.
number_of_nodescoreint64The number of nodes in the cluster.
owner_accountcorestringFor 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.
portcoreint64The port that the cluster is listening on.
restorable_node_typescorearray<string>The list of node types that this cluster snapshot is able to restore into.
snapshot_arncorestring
snapshot_create_timecoretimestampThe time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
snapshot_identifiercorestringThe snapshot identifier that is provided in the request.
snapshot_retention_start_timecoretimestampA timestamp representing the start of the retention period for the snapshot.
snapshot_typecorestringThe snapshot type. Snapshots created using <a>CreateClusterSnapshot</a> and <a>CopyClusterSnapshot</a> are of type "manual".
source_regioncorestringThe source region from which the snapshot was copied.
statuscorestringThe snapshot status. The value of the status depends on the API operation used: <ul> <li> <a>CreateClusterSnapshot</a> and <a>CopyClusterSnapshot</a> returns status as "creating". </li> <li> <a>DescribeClusterSnapshots</a> returns status as "creating", "available", "final snapshot", or "failed". </li> <li> <a>DeleteClusterSnapshot</a> returns status as "deleted". </li> </ul>
tagscorehstore
total_backup_size_in_mega_bytescorefloat64The size of the complete set of backup data that would be used to restore the cluster.
vpc_idcorestringThe VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.