Class: Aws::NetworkFirewall::Types::DescribeRuleGroupRequest

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 DescribeRuleGroupRequest data as a hash:

{
  rule_group_name: "ResourceName",
  rule_group_arn: "ResourceArn",
  type: "STATELESS", # accepts STATELESS, STATEFUL
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#rule_group_arnString

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

You must specify the ARN or the name, and you can specify both.

Returns:

  • (String)


1532
1533
1534
1535
1536
1537
1538
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1532

class DescribeRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group_arn,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_nameString

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

Returns:

  • (String)


1532
1533
1534
1535
1536
1537
1538
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1532

class DescribeRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group_arn,
  :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.

This setting is required for requests that do not include the RuleGroupARN.

Returns:

  • (String)


1532
1533
1534
1535
1536
1537
1538
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1532

class DescribeRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group_arn,
  :type)
  SENSITIVE = []
  include Aws::Structure
end