update-proxy-rule-priorities¶

Description¶

Updates proxy rule priorities within a proxy rule group.

Synopsis¶

  update-proxy-rule-priorities
[--proxy-rule-group-name <value>]
[--proxy-rule-group-arn <value>]
--rule-group-request-phase <value>
--rules <value>
--update-token <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--proxy-rule-group-name (string)

The descriptive name of the proxy rule group. You can’t change the name of a proxy rule group after you create it.

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

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

--proxy-rule-group-arn (string)

The Amazon Resource Name (ARN) of a proxy rule group.

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

Constraints:

min: 1

max: 256

pattern: ^arn:aws.*

--rule-group-request-phase (string) [required]

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

Possible values:

PRE_DNS

PRE_REQ

POST_RES

--rules (list) [required]

proxy rule resources to update to new positions.

(structure)

Proxy rule name and new desired position.

ProxyRuleName -> (string)

The descriptive name of the proxy rule. You can’t change the name of a proxy rule after you create it.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

NewPosition -> (integer)

Where to move a proxy rule in a proxy rule group.

Shorthand Syntax:

ProxyRuleName=string,NewPosition=integer ...

JSON Syntax:

[
  {
    "ProxyRuleName": "string",
    "NewPosition": integer
  }
  ...
]

--update-token (string) [required]

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.

Constraints:

min: 1

max: 1024

pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

ProxyRuleGroupName -> (string)

The descriptive name of the proxy rule group. You can’t change the name of a proxy rule group after you create it.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

ProxyRuleGroupArn -> (string)

The Amazon Resource Name (ARN) of a proxy rule group.

Constraints:

min: 1

max: 256

pattern: ^arn:aws.*

RuleGroupRequestPhase -> (string)

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

Possible values:

PRE_DNS

PRE_REQ

POST_RES

Rules -> (list)

The updated proxy rule hierarchy that reflects the updates from the request.

(structure)

Proxy rule name and new desired position.

ProxyRuleName -> (string)

The descriptive name of the proxy rule. You can’t change the name of a proxy rule after you create it.

Constraints:

min: 1

max: 128

pattern: ^[a-zA-Z0-9-]+$

NewPosition -> (integer)

Where to move a proxy rule in a proxy rule group.

UpdateToken -> (string)

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.

Constraints:

min: 1

max: 1024

pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

Table of Contents

Feedback

User Guide