UpdateRuleGroupCommand

Suggest an Edit

Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.

To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NetworkFirewallClient, UpdateRuleGroupCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
// const { NetworkFirewallClient, UpdateRuleGroupCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
const client = new NetworkFirewallClient(config);
const input = { // UpdateRuleGroupRequest
  UpdateToken: "STRING_VALUE", // required
  RuleGroupArn: "STRING_VALUE",
  RuleGroupName: "STRING_VALUE",
  RuleGroup: { // RuleGroup
    RuleVariables: { // RuleVariables
      IPSets: { // IPSets
        "<keys>": { // IPSet
          Definition: [ // VariableDefinitionList // required
            "STRING_VALUE",
          ],
        },
      },
      PortSets: { // PortSets
        "<keys>": { // PortSet
          Definition: [
            "STRING_VALUE",
          ],
        },
      },
    },
    ReferenceSets: { // ReferenceSets
      IPSetReferences: { // IPSetReferenceMap
        "<keys>": { // IPSetReference
          ReferenceArn: "STRING_VALUE",
        },
      },
    },
    RulesSource: { // RulesSource
      RulesString: "STRING_VALUE",
      RulesSourceList: { // RulesSourceList
        Targets: [ // RuleTargets // required
          "STRING_VALUE",
        ],
        TargetTypes: [ // TargetTypes // required
          "TLS_SNI" || "HTTP_HOST",
        ],
        GeneratedRulesType: "ALLOWLIST" || "DENYLIST", // required
      },
      StatefulRules: [ // StatefulRules
        { // StatefulRule
          Action: "PASS" || "DROP" || "ALERT" || "REJECT", // required
          Header: { // Header
            Protocol: "IP" || "TCP" || "UDP" || "ICMP" || "HTTP" || "FTP" || "TLS" || "SMB" || "DNS" || "DCERPC" || "SSH" || "SMTP" || "IMAP" || "MSN" || "KRB5" || "IKEV2" || "TFTP" || "NTP" || "DHCP", // required
            Source: "STRING_VALUE", // required
            SourcePort: "STRING_VALUE", // required
            Direction: "FORWARD" || "ANY", // required
            Destination: "STRING_VALUE", // required
            DestinationPort: "STRING_VALUE", // required
          },
          RuleOptions: [ // RuleOptions // required
            { // RuleOption
              Keyword: "STRING_VALUE", // required
              Settings: [ // Settings
                "STRING_VALUE",
              ],
            },
          ],
        },
      ],
      StatelessRulesAndCustomActions: { // StatelessRulesAndCustomActions
        StatelessRules: [ // StatelessRules // required
          { // StatelessRule
            RuleDefinition: { // RuleDefinition
              MatchAttributes: { // MatchAttributes
                Sources: [ // Addresses
                  { // Address
                    AddressDefinition: "STRING_VALUE", // required
                  },
                ],
                Destinations: [
                  {
                    AddressDefinition: "STRING_VALUE", // required
                  },
                ],
                SourcePorts: [ // PortRanges
                  { // PortRange
                    FromPort: Number("int"), // required
                    ToPort: Number("int"), // required
                  },
                ],
                DestinationPorts: [
                  {
                    FromPort: Number("int"), // required
                    ToPort: Number("int"), // required
                  },
                ],
                Protocols: [ // ProtocolNumbers
                  Number("int"),
                ],
                TCPFlags: [ // TCPFlags
                  { // TCPFlagField
                    Flags: [ // Flags // required
                      "FIN" || "SYN" || "RST" || "PSH" || "ACK" || "URG" || "ECE" || "CWR",
                    ],
                    Masks: [
                      "FIN" || "SYN" || "RST" || "PSH" || "ACK" || "URG" || "ECE" || "CWR",
                    ],
                  },
                ],
              },
              Actions: [ // StatelessActions // required
                "STRING_VALUE",
              ],
            },
            Priority: Number("int"), // required
          },
        ],
        CustomActions: [ // CustomActions
          { // CustomAction
            ActionName: "STRING_VALUE", // required
            ActionDefinition: { // ActionDefinition
              PublishMetricAction: { // PublishMetricAction
                Dimensions: [ // Dimensions // required
                  { // Dimension
                    Value: "STRING_VALUE", // required
                  },
                ],
              },
            },
          },
        ],
      },
    },
    StatefulRuleOptions: { // StatefulRuleOptions
      RuleOrder: "DEFAULT_ACTION_ORDER" || "STRICT_ORDER",
    },
  },
  Rules: "STRING_VALUE",
  Type: "STATELESS" || "STATEFUL",
  Description: "STRING_VALUE",
  DryRun: true || false,
  EncryptionConfiguration: { // EncryptionConfiguration
    KeyId: "STRING_VALUE",
    Type: "CUSTOMER_KMS" || "AWS_OWNED_KMS_KEY", // required
  },
  SourceMetadata: { // SourceMetadata
    SourceArn: "STRING_VALUE",
    SourceUpdateToken: "STRING_VALUE",
  },
  AnalyzeRuleGroup: true || false,
};
const command = new UpdateRuleGroupCommand(input);
const response = await client.send(command);
// { // UpdateRuleGroupResponse
//   UpdateToken: "STRING_VALUE", // required
//   RuleGroupResponse: { // RuleGroupResponse
//     RuleGroupArn: "STRING_VALUE", // required
//     RuleGroupName: "STRING_VALUE", // required
//     RuleGroupId: "STRING_VALUE", // required
//     Description: "STRING_VALUE",
//     Type: "STATELESS" || "STATEFUL",
//     Capacity: Number("int"),
//     RuleGroupStatus: "ACTIVE" || "DELETING" || "ERROR",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//     ConsumedCapacity: Number("int"),
//     NumberOfAssociations: Number("int"),
//     EncryptionConfiguration: { // EncryptionConfiguration
//       KeyId: "STRING_VALUE",
//       Type: "CUSTOMER_KMS" || "AWS_OWNED_KMS_KEY", // required
//     },
//     SourceMetadata: { // SourceMetadata
//       SourceArn: "STRING_VALUE",
//       SourceUpdateToken: "STRING_VALUE",
//     },
//     SnsTopic: "STRING_VALUE",
//     LastModifiedTime: new Date("TIMESTAMP"),
//     AnalysisResults: [ // AnalysisResultList
//       { // AnalysisResult
//         IdentifiedRuleIds: [ // RuleIdList
//           "STRING_VALUE",
//         ],
//         IdentifiedType: "STATELESS_RULE_FORWARDING_ASYMMETRICALLY" || "STATELESS_RULE_CONTAINS_TCP_FLAGS",
//         AnalysisDetail: "STRING_VALUE",
//       },
//     ],
//   },
// };

UpdateRuleGroupCommand Input

See UpdateRuleGroupCommandInput for more details

Parameter
Type
Description
UpdateToken
Required
string | undefined

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.

AnalyzeRuleGroup
boolean | undefined

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun to TRUE.

Description
string | undefined

A description of the rule group.

DryRun
boolean | undefined

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.

EncryptionConfiguration
EncryptionConfiguration | undefined

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

RuleGroup
RuleGroup | undefined

An object that defines the rule group rules.

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

RuleGroupArn
string | undefined

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

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

RuleGroupName
string | undefined

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.

Rules
string | undefined

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.

SourceMetadata
SourceMetadata | undefined

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.

Type
RuleGroupType | undefined

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.

UpdateRuleGroupCommand Output

See UpdateRuleGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RuleGroupResponse
Required
RuleGroupResponse | undefined

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

UpdateToken
Required
string | undefined

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.

Throws

Name
Fault
Details
InternalServerError
server

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InvalidRequestException
client

The operation failed because of a problem with your request. Examples include:

  • You specified an unsupported parameter name or value.

  • You tried to update a property with a value that isn't among the available types.

  • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InvalidTokenException
client

The token you provided is stale or isn't valid for the operation.

ResourceNotFoundException
client

Unable to locate a resource using the parameters that you provided.

ThrottlingException
client

Unable to process the request due to throttling limitations.

NetworkFirewallServiceException
Base exception class for all service exceptions from NetworkFirewall service.