Class: Aws::RecycleBin::Types::UnlockRuleResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The retention rule description.

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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

#identifierString

The unique ID of the retention rule.

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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

#lock_configurationTypes::LockConfiguration

Information about the retention rule lock configuration.



715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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

#lock_end_timeTime

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)


715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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

#lock_stateString

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)


715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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

#resource_tagsArray<Types::ResourceTag>

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

Returns:



715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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

#resource_typeString

The resource type retained by the retention rule.

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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

#retention_periodTypes::RetentionPeriod

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



715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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

#statusString

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

Returns:

  • (String)


715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/types.rb', line 715

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