Class: Aws::RecycleBin::Types::RuleSummary

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

Overview

Information about a Recycle Bin retention rule.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The retention rule description.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 630

class RuleSummary < Struct.new(
  :identifier,
  :description,
  :retention_period,
  :lock_state,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

The unique ID of the retention rule.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 630

class RuleSummary < Struct.new(
  :identifier,
  :description,
  :retention_period,
  :lock_state,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#lock_state ⇒ String

[Region-level retention rules only] The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.

  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 630

class RuleSummary < Struct.new(
  :identifier,
  :description,
  :retention_period,
  :lock_state,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Types::RetentionPeriod

Information about the retention period for which the retention rule is to retain resources.

Returns:



630
631
632
633
634
635
636
637
638
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 630

class RuleSummary < Struct.new(
  :identifier,
  :description,
  :retention_period,
  :lock_state,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#rule_arn ⇒ String

The Amazon Resource Name (ARN) of the retention rule.

Returns:

  • (String) 


630
631
632
633
634
635
636
637
638
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 630

class RuleSummary < Struct.new(
  :identifier,
  :description,
  :retention_period,
  :lock_state,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end