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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cancellation_dateTime

This is the time in number format when legal hold was cancelled.

Returns:

  • (Time)


3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3544

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

#creation_dateTime

This is the time in number format when legal hold was created.

Returns:

  • (Time)


3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3544

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

#descriptionString

This is the description of a legal hold.

Returns:

  • (String)


3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3544

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

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Returns:

  • (String)


3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3544

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

ID of specific legal hold on one or more recovery points.

Returns:

  • (String)


3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3544

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

#statusString

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

Returns:

  • (String)


3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3544

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

#titleString

This is the title of a legal hold.

Returns:

  • (String)


3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3544

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