Class: Aws::RecycleBin::Types::UpdateRuleResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The retention rule description.

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

The unique ID of the retention rule.

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#lock_end_time ⇒ Time

The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

Returns:

  • (Time) 


886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#lock_state ⇒ String

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) 


886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tags ⇒ Array<Types::ResourceTag>

Information about the resource tags used to identify resources that are retained by the retention rule.

Returns:



886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The resource type retained by the retention rule.

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :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:



886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#rule_arn ⇒ String

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

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The state of the retention rule. Only retention rules that are in the available state retain resources.

Returns:

  • (String) 


886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 886

class UpdateRuleResponse < Struct.new(
  :identifier,
  :retention_period,
  :description,
  :resource_type,
  :resource_tags,
  :status,
  :lock_state,
  :lock_end_time,
  :rule_arn)
  SENSITIVE = []
  include Aws::Structure
end