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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Describes a snapshot.

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.



6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#actual_incremental_backup_size_in_mega_bytesFloat

The size of the incremental backup.

Returns:

  • (Float)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#availability_zoneString

The Availability Zone in which the cluster was created.

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#backup_progress_in_mega_bytesFloat

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

Returns:

  • (Float)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#cluster_create_timeTime

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

Returns:

  • (Time)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#cluster_identifierString

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

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#cluster_versionString

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

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#db_nameString

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

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#encryptedBoolean

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

Returns:

  • (Boolean)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#estimated_seconds_to_completionInteger

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

Returns:

  • (Integer)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#master_usernameString

The master user name for the cluster.

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#node_typeString

The node type of the nodes in the cluster.

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#number_of_nodesInteger

The number of nodes in the cluster.

Returns:

  • (Integer)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#portInteger

The port that the cluster is listening on.

Returns:

  • (Integer)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#restorable_node_typesArray<String>

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

Returns:

  • (Array<String>)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#snapshot_identifierString

The snapshot identifier that is provided in the request.

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#snapshot_typeString

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

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#source_regionString

The source region from which the snapshot was copied.

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#statusString

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".

Returns:

  • (String)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#tagsArray<Types::Tag>

The list of tags for the cluster snapshot.

Returns:



6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#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)


6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6304

class Snapshot < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :snapshot_create_time,
  :status,
  :port,
  :availability_zone,
  :cluster_create_time,
  :master_username,
  :cluster_version,
  :snapshot_type,
  :node_type,
  :number_of_nodes,
  :db_name,
  :vpc_id,
  :encrypted,
  :kms_key_id,
  :encrypted_with_hsm,
  :accounts_with_restore_access,
  :owner_account,
  :total_backup_size_in_mega_bytes,
  :actual_incremental_backup_size_in_mega_bytes,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :estimated_seconds_to_completion,
  :elapsed_time_in_seconds,
  :source_region,
  :tags,
  :restorable_node_types,
  :enhanced_vpc_routing)
  include Aws::Structure
end