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

Instance Attribute Summary collapse

Instance Attribute Details

#accounts_with_restore_accessArray<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_bytesFloat

The size of the incremental backup.

Returns:

  • (Float)

    The size of the incremental backup.

#availability_zoneString

The Availability Zone in which the cluster was created.

Returns:

  • (String)

    The Availability Zone in which the cluster was created.

#backup_progress_in_mega_bytesFloat

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_timeTime

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

Returns:

  • (Time)

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

#cluster_identifierString

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_versionString

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_secondFloat

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_nameString

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_secondsInteger

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.

#encryptedBoolean

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_hsmBoolean

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_routingBoolean

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_completionInteger

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_idString

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.

#master_usernameString

The master user name for the cluster.

Returns:

  • (String)

    The master user name for the cluster.

#node_typeString

The node type of the nodes in the cluster.

Returns:

  • (String)

    The node type of the nodes in the cluster.

#number_of_nodesInteger

The number of nodes in the cluster.

Returns:

  • (Integer)

    The number of nodes in the cluster.

#owner_accountString

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.

#portInteger

The port that the cluster is listening on.

Returns:

  • (Integer)

    The port that the cluster is listening on.

#restorable_node_typesArray<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_timeTime

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

Returns:

  • (Time)

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

#snapshot_identifierString

The snapshot identifier that is provided in the request.

Returns:

  • (String)

    The snapshot identifier that is provided in the request.

#snapshot_typeString

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

Returns:

  • (String)

    The snapshot type.

#source_regionString

The source region from which the snapshot was copied.

Returns:

  • (String)

    The source region from which the snapshot was copied.

#statusString

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

Returns:

  • (String)

    The snapshot status.

#tagsArray<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_bytesFloat

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_idString

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.