You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Redshift::Types::Snapshot

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a snapshot.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#accounts_with_restore_access ⇒ Array<Types::AccountWithRestoreAccess>

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.

Returns:

#actual_incremental_backup_size_in_mega_bytes ⇒ Float

The size of the incremental backup.

Returns:

  • (Float) —

    The size of the incremental backup.

#availability_zone ⇒ String

The Availability Zone in which the cluster was created.

Returns:

  • (String) —

    The Availability Zone in which the cluster was created.

#backup_progress_in_mega_bytes ⇒ Float

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

Returns:

  • (Float) —

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

#cluster_create_time ⇒ Time

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

Returns:

  • (Time) —

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

#cluster_identifier ⇒ String

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

Returns:

  • (String) —

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

#cluster_version ⇒ String

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

Returns:

  • (String) —

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

#current_backup_rate_in_mega_bytes_per_second ⇒ Float

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

Returns:

  • (Float) —

    The number of megabytes per second being transferred to the snapshot backup.

#db_name ⇒ String

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

Returns:

  • (String) —

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

#elapsed_time_in_seconds ⇒ Integer

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

Returns:

  • (Integer) —

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

#encrypted ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#encrypted_with_hsm ⇒ Boolean

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.

Returns:

  • (Boolean) —

    A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.

#enhanced_vpc_routing ⇒ Boolean

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

Returns:

  • (Boolean) —

    An option that specifies whether to create the cluster with enhanced VPC routing enabled.

#estimated_seconds_to_completion ⇒ Integer

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

Returns:

  • (Integer) —

    The estimate of the time remaining before the snapshot backup will complete.

#kms_key_id ⇒ String

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.

Returns:

  • (String) —

    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.

#maintenance_track_name ⇒ String

The name of the maintenance track for the snapshot.

Returns:

  • (String) —

    The name of the maintenance track for the snapshot.

#manual_snapshot_remaining_days ⇒ Integer

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

Returns:

  • (Integer) —

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

#manual_snapshot_retention_period ⇒ Integer

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.

Returns:

  • (Integer) —

    The number of days that a manual snapshot is retained.

#master_username ⇒ String

The master user name for the cluster.

Returns:

  • (String) —

    The master user name for the cluster.

#node_type ⇒ String

The node type of the nodes in the cluster.

Returns:

  • (String) —

    The node type of the nodes in the cluster.

#number_of_nodes ⇒ Integer

The number of nodes in the cluster.

Returns:

  • (Integer) —

    The number of nodes in the cluster.

#owner_account ⇒ String

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.

Returns:

  • (String) —

    For manual snapshots, the AWS customer account used to create or copy the snapshot.

#port ⇒ Integer

The port that the cluster is listening on.

Returns:

  • (Integer) —

    The port that the cluster is listening on.

#restorable_node_types ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#snapshot_create_time ⇒ 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.

Returns:

  • (Time) —

    The time (in UTC format) when Amazon Redshift began the snapshot.

#snapshot_identifier ⇒ String

The snapshot identifier that is provided in the request.

Returns:

  • (String) —

    The snapshot identifier that is provided in the request.

#snapshot_retention_start_time ⇒ Time

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

Returns:

  • (Time) —

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

#snapshot_type ⇒ String

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

Returns:

  • (String) —

    The snapshot type.

#source_region ⇒ String

The source region from which the snapshot was copied.

Returns:

  • (String) —

    The source region from which the snapshot was copied.

#status ⇒ String

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

Returns:

  • (String) —

    The snapshot status.

#tags ⇒ Array<Types::Tag>

The list of tags for the cluster snapshot.

Returns:

  • (Array<Types::Tag>) —

    The list of tags for the cluster snapshot.

#total_backup_size_in_mega_bytes ⇒ Float

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

Returns:

  • (Float) —

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

#vpc_id ⇒ String

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

Returns:

  • (String) —

    The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.