Class: Aws::NetworkFirewall::Types::DescribeRuleGroupMetadataResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacityInteger

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

Returns:

  • (Integer)


1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1485

class DescribeRuleGroupMetadataResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :description,
  :type,
  :capacity,
  :stateful_rule_options,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

Returns the metadata objects for the specified rule group.

Returns:

  • (String)


1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1485

class DescribeRuleGroupMetadataResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :description,
  :type,
  :capacity,
  :stateful_rule_options,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timeTime

The last time that the rule group was changed.

Returns:

  • (Time)


1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1485

class DescribeRuleGroupMetadataResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :description,
  :type,
  :capacity,
  :stateful_rule_options,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#rule_group_arnString

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)


1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1485

class DescribeRuleGroupMetadataResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :description,
  :type,
  :capacity,
  :stateful_rule_options,
  :last_modified_time)
  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)


1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1485

class DescribeRuleGroupMetadataResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :description,
  :type,
  :capacity,
  :stateful_rule_options,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end

#stateful_rule_optionsTypes::StatefulRuleOptions

Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1485

class DescribeRuleGroupMetadataResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :description,
  :type,
  :capacity,
  :stateful_rule_options,
  :last_modified_time)
  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)


1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 1485

class DescribeRuleGroupMetadataResponse < Struct.new(
  :rule_group_arn,
  :rule_group_name,
  :description,
  :type,
  :capacity,
  :stateful_rule_options,
  :last_modified_time)
  SENSITIVE = []
  include Aws::Structure
end