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

Class: Aws::DynamoDB::Types::BackupSummary

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

Overview

Contains details for the backup.

Instance Attribute Summary collapse

Instance Attribute Details

#backup_arnString

ARN associated with the backup.

Returns:

  • (String)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#backup_creation_date_timeTime

Time at which the backup was created.

Returns:

  • (Time)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#backup_expiry_date_timeTime

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

Returns:

  • (Time)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#backup_nameString

Name of the specified backup.

Returns:

  • (String)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#backup_size_bytesInteger

Size of the backup in bytes.

Returns:

  • (Integer)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#backup_statusString

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

Returns:

  • (String)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#backup_typeString

BackupType:

  • USER - You create and manage these using the on-demand backup feature.

  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

  • AWS_BACKUP - On-demand backup created by you from AWS Backup service.

Returns:

  • (String)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#table_arnString

ARN associated with the table.

Returns:

  • (String)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#table_idString

Unique identifier for the table.

Returns:

  • (String)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end

#table_nameString

Name of the table.

Returns:

  • (String)


694
695
696
697
698
699
700
701
702
703
704
705
706
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 694

class BackupSummary < Struct.new(
  :table_name,
  :table_id,
  :table_arn,
  :backup_arn,
  :backup_name,
  :backup_creation_date_time,
  :backup_expiry_date_time,
  :backup_status,
  :backup_type,
  :backup_size_bytes)
  include Aws::Structure
end