Class: Aws::Backup::Types::GetLegalHoldOutput

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::GetLegalHoldOutput

Defined in:

gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cancel_description ⇒ String

  String describing the reason for removing the legal hold.

• #cancellation_date ⇒ Time

  Time in number when legal hold was cancelled.

• #creation_date ⇒ Time

  Time in number format when legal hold was created.

• #description ⇒ String

  This is the returned string description of the legal hold.

• #legal_hold_arn ⇒ String

  This is the returned framework ARN for the specified legal hold.

• #legal_hold_id ⇒ String

  This is the returned ID associated with a specified legal hold.

• #recovery_point_selection ⇒ Types::RecoveryPointSelection

  This specifies criteria to assign a set of resources, such as resource types or backup vaults.

• #retain_record_until ⇒ Time

  This is the date and time until which the legal hold record will be retained.

• #status ⇒ String

  This is the status of the legal hold.

• #title ⇒ String

  This is the string title of the legal hold.

Instance Attribute Details

#cancel_description ⇒ String

String describing the reason for removing the legal hold.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#cancellation_date ⇒ Time

Time in number when legal hold was cancelled.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#creation_date ⇒ Time

Time in number format when legal hold was created.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#description ⇒ String

This is the returned string description of the legal hold.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#legal_hold_arn ⇒ String

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#legal_hold_id ⇒ String

This is the returned ID associated with a specified legal hold.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#recovery_point_selection ⇒ Types::RecoveryPointSelection

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

Returns:

• (Types::RecoveryPointSelection)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#retain_record_until ⇒ Time

This is the date and time until which the legal hold record will be retained.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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

#title ⇒ String

This is the string title of the legal hold.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3954

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