Class: Aws::RecycleBin::Types::LockRuleResponse

Inherits:

Struct

• Object
• Struct
• Aws::RecycleBin::Types::LockRuleResponse

Includes:

Structure

Defined in:

lib/aws-sdk-recyclebin/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The retention rule description.

• #identifier ⇒ String

  The unique ID of the retention rule.

• #lock_configuration ⇒ Types::LockConfiguration

  Information about the retention rule lock configuration.

• #lock_state ⇒ String

  The lock state for the retention rule.

• #resource_tags ⇒ Array<Types::ResourceTag>

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

• #resource_type ⇒ String

  The resource type retained by the retention rule.

• #retention_period ⇒ Types::RetentionPeriod

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

• #rule_arn ⇒ String

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

• #status ⇒ String

  The state of the retention rule.

Instance Attribute Details

#description ⇒ String

The retention rule description.

Returns:

• (String)

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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

#identifier ⇒ String

The unique ID of the retention rule.

Returns:

• (String)

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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

#lock_configuration ⇒ Types::LockConfiguration

Information about the retention rule lock configuration.

Returns:

• (Types::LockConfiguration)

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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

• (Array<Types::ResourceTag>)

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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

#resource_type ⇒ String

The resource type retained by the retention rule.

Returns:

• (String)

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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

• (Types::RetentionPeriod)

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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

#rule_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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

# File 'lib/aws-sdk-recyclebin/types.rb', line 454

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