# CreateRuleGroup Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags. You provide your rule group specification in your request using either `RuleGroup` or `Rules`. ## Request Syntax ``` { "AnalyzeRuleGroup": boolean, "Capacity": number, "Description": "string", "DryRun": boolean, "EncryptionConfiguration": { "KeyId": "string", "Type": "string" }, "RuleGroup": { "ReferenceSets": { "IPSetReferences": { "string" : { "ReferenceArn": "string" } } }, "RulesSource": { "RulesSourceList": { "GeneratedRulesType": "string", "Targets": [ "string" ], "TargetTypes": [ "string" ] }, "RulesString": "string", "StatefulRules": [ { "Action": "string", "Header": { "Destination": "string", "DestinationPort": "string", "Direction": "string", "Protocol": "string", "Source": "string", "SourcePort": "string" }, "RuleOptions": [ { "Keyword": "string", "Settings": [ "string" ] } ] } ], "StatelessRulesAndCustomActions": { "CustomActions": [ { "ActionDefinition": { "PublishMetricAction": { "Dimensions": [ { "Value": "string" } ] } }, "ActionName": "string" } ], "StatelessRules": [ { "Priority": number, "RuleDefinition": { "Actions": [ "string" ], "MatchAttributes": { "DestinationPorts": [ { "FromPort": number, "ToPort": number } ], "Destinations": [ { "AddressDefinition": "string" } ], "Protocols": [ number ], "SourcePorts": [ { "FromPort": number, "ToPort": number } ], "Sources": [ { "AddressDefinition": "string" } ], "TCPFlags": [ { "Flags": [ "string" ], "Masks": [ "string" ] } ] } } } ] } }, "RuleVariables": { "IPSets": { "string" : { "Definition": [ "string" ] } }, "PortSets": { "string" : { "Definition": [ "string" ] } } }, "StatefulRuleOptions": { "RuleOrder": "string" } }, "RuleGroupName": "string", "Rules": "string", "SourceMetadata": { "SourceArn": "string", "SourceUpdateToken": "string" }, "SummaryConfiguration": { "RuleOptions": [ "string" ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AnalyzeRuleGroup](#API_CreateRuleGroup_RequestSyntax) ** 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 creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, set `DryRun` to `TRUE`. Type: Boolean Required: No ** [Capacity](#API_CreateRuleGroup_RequestSyntax) ** 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](#API_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 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3. 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. Type: Integer Required: Yes ** [Description](#API_CreateRuleGroup_RequestSyntax) ** A description of the rule group. Type: String Length Constraints: Maximum length of 512. Pattern: `^.*$` Required: No ** [DryRun](#API_CreateRuleGroup_RequestSyntax) ** 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. Type: Boolean Required: No ** [EncryptionConfiguration](#API_CreateRuleGroup_RequestSyntax) ** A complex type that contains settings for encryption of your rule group resources. Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object Required: No ** [RuleGroup](#API_CreateRuleGroup_RequestSyntax) ** An object that defines the rule group rules. You must provide either this rule group setting or a `Rules` setting, but not both. Type: [RuleGroup](API_RuleGroup.md) object Required: No ** [RuleGroupName](#API_CreateRuleGroup_RequestSyntax) ** The descriptive name of the rule group. You can't change the name of a rule group after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9-]+$` Required: Yes ** [Rules](#API_CreateRuleGroup_RequestSyntax) ** 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](API_RuleGroup.md) object that Network Firewall has populated from your string. Type: String Length Constraints: Minimum length of 0. Maximum length of 2000000. Required: No ** [SourceMetadata](#API_CreateRuleGroup_RequestSyntax) ** 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: [SourceMetadata](API_SourceMetadata.md) object Required: No ** [SummaryConfiguration](#API_CreateRuleGroup_RequestSyntax) ** An object that contains a `RuleOptions` array of strings. You use `RuleOptions` to determine which of the following [RuleSummary](API_RuleSummary.md) values are returned in response to `DescribeRuleGroupSummary`. + `Metadata` - returns + `Msg` + `SID` Type: [SummaryConfiguration](API_SummaryConfiguration.md) object Required: No ** [Tags](#API_CreateRuleGroup_RequestSyntax) ** The key:value pairs to associate with the resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No ** [Type](#API_CreateRuleGroup_RequestSyntax) ** 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. Type: String Valid Values: `STATELESS | STATEFUL` Required: Yes ## Response Syntax ``` { "RuleGroupResponse": { "AnalysisResults": [ { "AnalysisDetail": "string", "IdentifiedRuleIds": [ "string" ], "IdentifiedType": "string" } ], "Capacity": number, "ConsumedCapacity": number, "Description": "string", "EncryptionConfiguration": { "KeyId": "string", "Type": "string" }, "LastModifiedTime": number, "NumberOfAssociations": number, "RuleGroupArn": "string", "RuleGroupId": "string", "RuleGroupName": "string", "RuleGroupStatus": "string", "SnsTopic": "string", "SourceMetadata": { "SourceArn": "string", "SourceUpdateToken": "string" }, "SummaryConfiguration": { "RuleOptions": [ "string" ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" }, "UpdateToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [RuleGroupResponse](#API_CreateRuleGroup_ResponseSyntax) ** The high-level properties of a rule group. This, along with the [RuleGroup](API_RuleGroup.md), define the rule group. You can retrieve all objects for a rule group by calling [DescribeRuleGroup](API_DescribeRuleGroup.md). Type: [RuleGroupResponse](API_RuleGroupResponse.md) object ** [UpdateToken](#API_CreateRuleGroup_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InsufficientCapacityException ** AWS doesn't currently have enough available capacity to fulfill your request. Try your request later. HTTP Status Code: 500 ** InternalServerError ** Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 ** InvalidRequestException ** 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. HTTP Status Code: 400 ** LimitExceededException ** Unable to perform the operation because doing so would violate a limit setting. HTTP Status Code: 400 ** ThrottlingException ** Unable to process the request due to throttling limitations. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateRuleGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateRuleGroup)