Class: Aws::NetworkFirewall::Types::CreateRuleGroupRequest

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

{
  rule_group_name: "ResourceName", # required
  rule_group: {
    rule_variables: {
      ip_sets: {
        "RuleVariableName" => {
          definition: ["VariableDefinition"], # required
        },
      },
      port_sets: {
        "RuleVariableName" => {
          definition: ["VariableDefinition"],
        },
      },
    },
    reference_sets: {
      ip_set_references: {
        "IPSetReferenceName" => {
          reference_arn: "ResourceArn",
        },
      },
    },
    rules_source: { # required
      rules_string: "RulesString",
      rules_source_list: {
        targets: ["CollectionMember_String"], # required
        target_types: ["TLS_SNI"], # required, accepts TLS_SNI, HTTP_HOST
        generated_rules_type: "ALLOWLIST", # required, accepts ALLOWLIST, DENYLIST
      },
      stateful_rules: [
        {
          action: "PASS", # required, accepts PASS, DROP, ALERT
          header: { # required
            protocol: "IP", # required, accepts IP, TCP, UDP, ICMP, HTTP, FTP, TLS, SMB, DNS, DCERPC, SSH, SMTP, IMAP, MSN, KRB5, IKEV2, TFTP, NTP, DHCP
            source: "Source", # required
            source_port: "Port", # required
            direction: "FORWARD", # required, accepts FORWARD, ANY
            destination: "Destination", # required
            destination_port: "Port", # required
          },
          rule_options: [ # required
            {
              keyword: "Keyword", # required
              settings: ["Setting"],
            },
          ],
        },
      ],
      stateless_rules_and_custom_actions: {
        stateless_rules: [ # required
          {
            rule_definition: { # required
              match_attributes: { # required
                sources: [
                  {
                    address_definition: "AddressDefinition", # required
                  },
                ],
                destinations: [
                  {
                    address_definition: "AddressDefinition", # required
                  },
                ],
                source_ports: [
                  {
                    from_port: 1, # required
                    to_port: 1, # required
                  },
                ],
                destination_ports: [
                  {
                    from_port: 1, # required
                    to_port: 1, # required
                  },
                ],
                protocols: [1],
                tcp_flags: [
                  {
                    flags: ["FIN"], # required, accepts FIN, SYN, RST, PSH, ACK, URG, ECE, CWR
                    masks: ["FIN"], # accepts FIN, SYN, RST, PSH, ACK, URG, ECE, CWR
                  },
                ],
              },
              actions: ["CollectionMember_String"], # required
            },
            priority: 1, # required
          },
        ],
        custom_actions: [
          {
            action_name: "ActionName", # required
            action_definition: { # required
              publish_metric_action: {
                dimensions: [ # required
                  {
                    value: "DimensionValue", # required
                  },
                ],
              },
            },
          },
        ],
      },
    },
    stateful_rule_options: {
      rule_order: "DEFAULT_ACTION_ORDER", # accepts DEFAULT_ACTION_ORDER, STRICT_ORDER
    },
  },
  rules: "RulesString",
  type: "STATELESS", # required, accepts STATELESS, STATEFUL
  description: "Description",
  capacity: 1, # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  dry_run: false,
  encryption_configuration: {
    key_id: "KeyId",
    type: "CUSTOMER_KMS", # required, accepts CUSTOMER_KMS, AWS_OWNED_KMS_KEY
  },
  source_metadata: {
    source_arn: "ResourceArn",
    source_update_token: "UpdateToken",
  },
}

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.

You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.

Capacity for a stateless rule group

For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.

To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:

  • A match setting with no criteria specified has a value of 1.

  • A match setting with Any specified has a value of 1.

  • All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of

    1. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of

A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.

Capacity for a stateful rule group

For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.

Returns:

  • (Integer)


894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the rule group.

Returns:

  • (String)


894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

Returns:

  • (Boolean)


894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configurationTypes::EncryptionConfiguration

A complex type that contains settings for encryption of your rule group resources.



894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#rule_groupTypes::RuleGroup

An object that defines the rule group rules.

You must provide either this rule group setting or a Rules setting, but not both.

Returns:



894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  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.

Returns:

  • (String)


894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#rulesString

A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.

You must provide either this rules setting or a populated RuleGroup setting, but not both.

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your string.

Returns:

  • (String)


894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#source_metadataTypes::SourceMetadata

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.



894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The key:value pairs to associate with the resource.

Returns:



894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  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)


894
895
896
897
898
899
900
901
902
903
904
905
906
907
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 894

class CreateRuleGroupRequest < Struct.new(
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :capacity,
  :tags,
  :dry_run,
  :encryption_configuration,
  :source_metadata)
  SENSITIVE = []
  include Aws::Structure
end