class Aws::Redshift::Types::Snapshot

Describes a snapshot.

@!attribute [rw] snapshot_identifier

The snapshot identifier that is provided in the request.
@return [String]

@!attribute [rw] cluster_identifier

The identifier of the cluster for which the snapshot was taken.
@return [String]

@!attribute [rw] snapshot_create_time

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.
@return [Time]

@!attribute [rw] 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".
@return [String]

@!attribute [rw] port

The port that the cluster is listening on.
@return [Integer]

@!attribute [rw] availability_zone

The Availability Zone in which the cluster was created.
@return [String]

@!attribute [rw] cluster_create_time

The time (UTC) when the cluster was originally created.
@return [Time]

@!attribute [rw] master_username

The admin user name for the cluster.
@return [String]

@!attribute [rw] cluster_version

The version ID of the Amazon Redshift engine that is running on the
cluster.
@return [String]

@!attribute [rw] engine_full_version

The cluster version of the cluster used to create the snapshot. For
example, 1.0.15503.
@return [String]

@!attribute [rw] snapshot_type

The snapshot type. Snapshots created using CreateClusterSnapshot and
CopyClusterSnapshot are of type "manual".
@return [String]

@!attribute [rw] node_type

The node type of the nodes in the cluster.
@return [String]

@!attribute [rw] number_of_nodes

The number of nodes in the cluster.
@return [Integer]

@!attribute [rw] db_name

The name of the database that was created when the cluster was
created.
@return [String]

@!attribute [rw] vpc_id

The VPC identifier of the cluster if the snapshot is from a cluster
in a VPC. Otherwise, this field is not in the output.
@return [String]

@!attribute [rw] encrypted

If `true`, the data in the snapshot is encrypted at rest.
@return [Boolean]

@!attribute [rw] kms_key_id

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.
@return [String]

@!attribute [rw] encrypted_with_hsm

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.
@return [Boolean]

@!attribute [rw] accounts_with_restore_access

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.
@return [Array<Types::AccountWithRestoreAccess>]

@!attribute [rw] owner_account

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.
@return [String]

@!attribute [rw] total_backup_size_in_mega_bytes

The size of the complete set of backup data that would be used to
restore the cluster.
@return [Float]

@!attribute [rw] actual_incremental_backup_size_in_mega_bytes

The size of the incremental backup.
@return [Float]

@!attribute [rw] backup_progress_in_mega_bytes

The number of megabytes that have been transferred to the snapshot
backup.
@return [Float]

@!attribute [rw] current_backup_rate_in_mega_bytes_per_second

The number of megabytes per second being transferred to the snapshot
backup. Returns `0` for a completed backup.
@return [Float]

@!attribute [rw] estimated_seconds_to_completion

The estimate of the time remaining before the snapshot backup will
complete. Returns `0` for a completed backup.
@return [Integer]

@!attribute [rw] elapsed_time_in_seconds

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

@!attribute [rw] source_region

The source region from which the snapshot was copied.
@return [String]

@!attribute [rw] tags

The list of tags for the cluster snapshot.
@return [Array<Types::Tag>]

@!attribute [rw] restorable_node_types

The list of node types that this cluster snapshot is able to restore
into.
@return [Array<String>]

@!attribute [rw] enhanced_vpc_routing

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][1] in the Amazon Redshift Cluster Management
Guide.

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

Default: false

[1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html
@return [Boolean]

@!attribute [rw] maintenance_track_name

The name of the maintenance track for the snapshot.
@return [String]

@!attribute [rw] manual_snapshot_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.
@return [Integer]

@!attribute [rw] manual_snapshot_remaining_days

The number of days until a manual snapshot will pass its retention
period.
@return [Integer]

@!attribute [rw] snapshot_retention_start_time

A timestamp representing the start of the retention period for the
snapshot.
@return [Time]

@see docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/Snapshot AWS API Documentation

Constants

SENSITIVE