Class: Aws::RecycleBin::Types::GetRuleResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

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

#exclude_resource_tags ⇒ Array<Types::ResourceTag>

[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

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

#identifier ⇒ String

The unique ID of the retention rule.

Returns:

  • (String) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

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

#lock_configuration ⇒ Types::LockConfiguration

Information about the retention rule lock configuration.

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

class GetRuleResponse < Struct.new(
  :identifier,
  :description,
  :resource_type,
  :retention_period,
  :resource_tags,
  :status,
  :lock_configuration,
  :lock_state,
  :lock_end_time,
  :rule_arn,
  :exclude_resource_tags)
  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) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

class GetRuleResponse < Struct.new(
  :identifier,
  :description,
  :resource_type,
  :retention_period,
  :resource_tags,
  :status,
  :lock_configuration,
  :lock_state,
  :lock_end_time,
  :rule_arn,
  :exclude_resource_tags)
  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) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

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

#resource_tags ⇒ Array<Types::ResourceTag>

[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

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

#resource_type ⇒ String

The resource type retained by the retention rule.

Returns:

  • (String) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

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

#retention_period ⇒ Types::RetentionPeriod

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

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

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

#rule_arn ⇒ String

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

Returns:

  • (String) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

class GetRuleResponse < Struct.new(
  :identifier,
  :description,
  :resource_type,
  :retention_period,
  :resource_tags,
  :status,
  :lock_configuration,
  :lock_state,
  :lock_end_time,
  :rule_arn,
  :exclude_resource_tags)
  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) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-recyclebin/types.rb', line 282

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