CreateProxyRuleGroup
Creates an AWS Network Firewall ProxyRuleGroup
Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations.
To manage a proxy rule group's tags, use the standard AWS resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about proxy rule groups, use ListProxyRuleGroups and DescribeProxyRuleGroup.
To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.
Request Syntax
{
"Description": "string",
"ProxyRuleGroupName": "string",
"Rules": {
"PostRESPONSE": [
{
"Action": "string",
"Conditions": [
{
"ConditionKey": "string",
"ConditionOperator": "string",
"ConditionValues": [ "string" ]
}
],
"Description": "string",
"ProxyRuleName": "string"
}
],
"PreDNS": [
{
"Action": "string",
"Conditions": [
{
"ConditionKey": "string",
"ConditionOperator": "string",
"ConditionValues": [ "string" ]
}
],
"Description": "string",
"ProxyRuleName": "string"
}
],
"PreREQUEST": [
{
"Action": "string",
"Conditions": [
{
"ConditionKey": "string",
"ConditionOperator": "string",
"ConditionValues": [ "string" ]
}
],
"Description": "string",
"ProxyRuleName": "string"
}
]
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Description
-
A description of the proxy rule group.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
^.*$Required: No
- ProxyRuleGroupName
-
The descriptive name of the proxy rule group. You can't change the name of a proxy 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
-
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
Type: ProxyRulesByRequestPhase object
Required: No
- Tags
-
The key:value pairs to associate with the resource.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Required: No
Response Syntax
{
"ProxyRuleGroup": {
"CreateTime": number,
"DeleteTime": number,
"Description": "string",
"ProxyRuleGroupArn": "string",
"ProxyRuleGroupName": "string",
"Rules": {
"PostRESPONSE": [
{
"Action": "string",
"Conditions": [
{
"ConditionKey": "string",
"ConditionOperator": "string",
"ConditionValues": [ "string" ]
}
],
"Description": "string",
"ProxyRuleName": "string"
}
],
"PreDNS": [
{
"Action": "string",
"Conditions": [
{
"ConditionKey": "string",
"ConditionOperator": "string",
"ConditionValues": [ "string" ]
}
],
"Description": "string",
"ProxyRuleName": "string"
}
],
"PreREQUEST": [
{
"Action": "string",
"Conditions": [
{
"ConditionKey": "string",
"ConditionOperator": "string",
"ConditionValues": [ "string" ]
}
],
"Description": "string",
"ProxyRuleName": "string"
}
]
},
"Tags": [
{
"Key": "string",
"Value": "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.
- ProxyRuleGroup
-
The properties that define the proxy rule group.
Type: ProxyRuleGroup object
- UpdateToken
-
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.
To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy 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 proxy 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 Errors.
- 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:
