Class: Aws::RedshiftServerless::Types::Snapshot

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

Overview

A snapshot object that contains databases.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accounts_with_provisioned_restore_accessArray<String>

All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

Returns:

  • (Array<String>)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#accounts_with_restore_accessArray<String>

All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

Returns:

  • (Array<String>)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#actual_incremental_backup_size_in_mega_bytesFloat

The size of the incremental backup in megabytes.

Returns:

  • (Float)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#admin_usernameString

The username of the database within a snapshot.

Returns:

  • (String)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#backup_progress_in_mega_bytesFloat

The size in megabytes of the data that has been backed up to a snapshot.

Returns:

  • (Float)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#current_backup_rate_in_mega_bytes_per_secondFloat

The rate at which data is backed up into a snapshot in megabytes per second.

Returns:

  • (Float)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#elapsed_time_in_secondsInteger

The amount of time it took to back up data into a snapshot.

Returns:

  • (Integer)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_seconds_to_completionInteger

The estimated amount of seconds until the snapshot completes backup.

Returns:

  • (Integer)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The unique identifier of the KMS key used to encrypt the snapshot.

Returns:

  • (String)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_arnString

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

Returns:

  • (String)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_nameString

The name of the namepsace.

Returns:

  • (String)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#owner_accountString

The owner Amazon Web Services; account of the snapshot.

Returns:

  • (String)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_arnString

The Amazon Resource Name (ARN) of the snapshot.

Returns:

  • (String)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_create_timeTime

The timestamp of when the snapshot was created.

Returns:

  • (Time)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_nameString

The name of the snapshot.

Returns:

  • (String)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_remaining_daysInteger

The amount of days until the snapshot is deleted.

Returns:

  • (Integer)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_periodInteger

The period of time, in days, of how long the snapshot is retained.

Returns:

  • (Integer)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_retention_start_timeTime

The timestamp of when data within the snapshot started getting retained.

Returns:

  • (Time)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the snapshot.

Returns:

  • (String)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#total_backup_size_in_mega_bytesFloat

The total size, in megabytes, of how big the snapshot is.

Returns:

  • (Float)


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 1861

class Snapshot < Struct.new(
  :accounts_with_provisioned_restore_access,
  :accounts_with_restore_access,
  :actual_incremental_backup_size_in_mega_bytes,
  :admin_username,
  :backup_progress_in_mega_bytes,
  :current_backup_rate_in_mega_bytes_per_second,
  :elapsed_time_in_seconds,
  :estimated_seconds_to_completion,
  :kms_key_id,
  :namespace_arn,
  :namespace_name,
  :owner_account,
  :snapshot_arn,
  :snapshot_create_time,
  :snapshot_name,
  :snapshot_remaining_days,
  :snapshot_retention_period,
  :snapshot_retention_start_time,
  :status,
  :total_backup_size_in_mega_bytes)
  SENSITIVE = []
  include Aws::Structure
end