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

The time when the legal hold was cancelled.

Returns:

  • (Time)


4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4326

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

#creation_dateTime

The time when the legal hold was created.

Returns:

  • (Time)


4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4326

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

#descriptionString

The description of a legal hold.

Returns:

  • (String)


4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4326

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

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)


4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4326

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

The ID of the legal hold.

Returns:

  • (String)


4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4326

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

#statusString

The status of the legal hold.

Returns:

  • (String)


4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4326

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

#titleString

The title of a legal hold.

Returns:

  • (String)


4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 4326

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