Class: Aws::Backup::Types::LegalHold

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

Overview

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cancellation_date ⇒ Time

The time when the legal hold was cancelled.

Returns:

  • (Time) 


4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4567

class LegalHold < Struct.new(
  :title,
  :status,
  :description,
  :legal_hold_id,
  :legal_hold_arn,
  :creation_date,
  :cancellation_date)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The time when the legal hold was created.

Returns:

  • (Time) 


4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4567

class LegalHold < Struct.new(
  :title,
  :status,
  :description,
  :legal_hold_id,
  :legal_hold_arn,
  :creation_date,
  :cancellation_date)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of a legal hold.

Returns:

  • (String) 


4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4567

class LegalHold < Struct.new(
  :title,
  :status,
  :description,
  :legal_hold_id,
  :legal_hold_arn,
  :creation_date,
  :cancellation_date)
  SENSITIVE = []
  include Aws::Structure
end

#legal_hold_arn ⇒ String

The Amazon Resource Name (ARN) of the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Returns:

  • (String) 


4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4567

class LegalHold < Struct.new(
  :title,
  :status,
  :description,
  :legal_hold_id,
  :legal_hold_arn,
  :creation_date,
  :cancellation_date)
  SENSITIVE = []
  include Aws::Structure
end

#legal_hold_id ⇒ String

The ID of the legal hold.

Returns:

  • (String) 


4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4567

class LegalHold < Struct.new(
  :title,
  :status,
  :description,
  :legal_hold_id,
  :legal_hold_arn,
  :creation_date,
  :cancellation_date)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the legal hold.

Returns:

  • (String) 


4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4567

class LegalHold < Struct.new(
  :title,
  :status,
  :description,
  :legal_hold_id,
  :legal_hold_arn,
  :creation_date,
  :cancellation_date)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of a legal hold.

Returns:

  • (String) 


4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4567

class LegalHold < Struct.new(
  :title,
  :status,
  :description,
  :legal_hold_id,
  :legal_hold_arn,
  :creation_date,
  :cancellation_date)
  SENSITIVE = []
  include Aws::Structure
end