Class: Aws::NetworkFirewall::Types::ListRuleGroupsRequest

Inherits:

Struct

• Object
• Struct
• Aws::NetworkFirewall::Types::ListRuleGroupsRequest

Defined in:

gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #managed_type ⇒ String

  Indicates the general category of the Amazon Web Services managed rule group.

• #max_results ⇒ Integer

  The maximum number of objects that you want Network Firewall to return for this request.

• #next_token ⇒ String

  When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response.

• #scope ⇒ String

  The scope of the request.

• #subscription_status ⇒ String

  Filters the results to show only rule groups with the specified subscription status.

• #type ⇒ String

  Indicates whether the rule group is stateless or stateful.

Instance Attribute Details

#managed_type ⇒ String

Indicates the general category of the Amazon Web Services managed rule group.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5285

class ListRuleGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :scope,
  :managed_type,
  :subscription_status,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

• (Integer)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5285

class ListRuleGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :scope,
  :managed_type,
  :subscription_status,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5285

class ListRuleGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :scope,
  :managed_type,
  :subscription_status,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5285

class ListRuleGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :scope,
  :managed_type,
  :subscription_status,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_status ⇒ String

Filters the results to show only rule groups with the specified subscription status. Use this to find subscribed or unsubscribed rule groups.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5285

class ListRuleGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :scope,
  :managed_type,
  :subscription_status,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5285

class ListRuleGroupsRequest < Struct.new(
  :next_token,
  :max_results,
  :scope,
  :managed_type,
  :subscription_status,
  :type)
  SENSITIVE = []
  include Aws::Structure
end