Class: Aws::RecycleBin::Types::ListRulesRequest

Inherits:

Struct

• Object
• Struct
• Aws::RecycleBin::Types::ListRulesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-recyclebin/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #lock_state ⇒ String

  The lock state of the retention rules to list.

• #max_results ⇒ Integer

  The maximum number of results to return with a single call.

• #next_token ⇒ String

  The token for the next page of results.

• #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.

• #resource_type ⇒ String

  The resource type retained by the retention rule.

Instance Attribute Details

#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:

• (Array<Types::ResourceTag>)

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

class ListRulesRequest < Struct.new(
  :max_results,
  :next_token,
  :resource_type,
  :resource_tags,
  :lock_state,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#lock_state ⇒ String

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Returns:

• (String)

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

class ListRulesRequest < Struct.new(
  :max_results,
  :next_token,
  :resource_type,
  :resource_tags,
  :lock_state,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned ‘NextToken` value.

Returns:

• (Integer)

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

class ListRulesRequest < Struct.new(
  :max_results,
  :next_token,
  :resource_type,
  :resource_tags,
  :lock_state,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next page of results.

Returns:

• (String)

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

class ListRulesRequest < Struct.new(
  :max_results,
  :next_token,
  :resource_type,
  :resource_tags,
  :lock_state,
  :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:

• (Array<Types::ResourceTag>)

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

class ListRulesRequest < Struct.new(
  :max_results,
  :next_token,
  :resource_type,
  :resource_tags,
  :lock_state,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify ‘EBS_SNAPSHOT`. To list retention rules that retain EBS-backed AMIs, specify `EC2_IMAGE`.

Returns:

• (String)

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

class ListRulesRequest < Struct.new(
  :max_results,
  :next_token,
  :resource_type,
  :resource_tags,
  :lock_state,
  :exclude_resource_tags)
  SENSITIVE = []
  include Aws::Structure
end