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

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

Overview

Note:

When making an API call, you may pass ListRuleGroupsRequest data as a hash:

{
  next_token: "PaginationToken",
  max_results: 1,
  scope: "MANAGED", # accepts MANAGED, ACCOUNT
  managed_type: "AWS_MANAGED_THREAT_SIGNATURES", # accepts AWS_MANAGED_THREAT_SIGNATURES, AWS_MANAGED_DOMAIN_LISTS
  type: "STATELESS", # accepts STATELESS, STATEFUL
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#managed_typeString

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

Returns:

  • (String)


2641
2642
2643
2644
2645
2646
2647
2648
2649
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2641

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

#max_resultsInteger

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)


2641
2642
2643
2644
2645
2646
2647
2648
2649
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2641

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

#next_tokenString

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)


2641
2642
2643
2644
2645
2646
2647
2648
2649
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2641

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

#scopeString

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)


2641
2642
2643
2644
2645
2646
2647
2648
2649
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2641

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

#typeString

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)


2641
2642
2643
2644
2645
2646
2647
2648
2649
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2641

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