Class: Aws::NetworkFirewall::Types::UpdateRuleGroupRequest

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

{
  update_token: "UpdateToken", # required
  rule_group_arn: "ResourceArn",
  rule_group_name: "ResourceName",
  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", # accepts STATELESS, STATEFUL
  description: "Description",
  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

#descriptionString

A description of the rule group.

Returns:

  • (String)


5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

class UpdateRuleGroupRequest < Struct.new(
  :update_token,
  :rule_group_arn,
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :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)


5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

class UpdateRuleGroupRequest < Struct.new(
  :update_token,
  :rule_group_arn,
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :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.



5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

class UpdateRuleGroupRequest < Struct.new(
  :update_token,
  :rule_group_arn,
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :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:



5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

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

#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)


5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

class UpdateRuleGroupRequest < Struct.new(
  :update_token,
  :rule_group_arn,
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :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.

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

Returns:

  • (String)


5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

class UpdateRuleGroupRequest < Struct.new(
  :update_token,
  :rule_group_arn,
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :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)


5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

class UpdateRuleGroupRequest < Struct.new(
  :update_token,
  :rule_group_arn,
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :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.



5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

class UpdateRuleGroupRequest < Struct.new(
  :update_token,
  :rule_group_arn,
  :rule_group_name,
  :rule_group,
  :rules,
  :type,
  :description,
  :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.

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

Returns:

  • (String)


5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

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

#update_tokenString

A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.

To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Returns:

  • (String)


5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 5359

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