AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . network-firewall ]

update-proxy-rule

Description

Updates the properties of the specified proxy rule.

See also: AWS API Documentation

Synopsis

  update-proxy-rule
[--proxy-rule-group-name <value>]
[--proxy-rule-group-arn <value>]
--proxy-rule-name <value>
[--description <value>]
[--action <value>]
[--add-conditions <value>]
[--remove-conditions <value>]
--update-token <value>
[--cli-input-json <value>]
[--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>]
[--v2-debug]

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.

--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.

--proxy-rule-name (string)

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

--description (string)

A description of the proxy rule.

--action (string)

Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.

Possible values:

  • ALLOW
  • DENY
  • ALERT

--add-conditions (list)

Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

(structure)

Match criteria that specify what traffic attributes to examine.

ConditionOperator -> (string)

Defines how to perform a match.

ConditionKey -> (string)

Defines what is to be matched.

ConditionValues -> (list)

Specifes the exact value that needs to be matched against.

(string)

Shorthand Syntax:

ConditionOperator=string,ConditionKey=string,ConditionValues=string,string ...

JSON Syntax:

[
  {
    "ConditionOperator": "string",
    "ConditionKey": "string",
    "ConditionValues": ["string", ...]
  }
  ...
]

--remove-conditions (list)

Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

(structure)

Match criteria that specify what traffic attributes to examine.

ConditionOperator -> (string)

Defines how to perform a match.

ConditionKey -> (string)

Defines what is to be matched.

ConditionValues -> (list)

Specifes the exact value that needs to be matched against.

(string)

Shorthand Syntax:

ConditionOperator=string,ConditionKey=string,ConditionValues=string,string ...

JSON Syntax:

[
  {
    "ConditionOperator": "string",
    "ConditionKey": "string",
    "ConditionValues": ["string", ...]
  }
  ...
]

--update-token (string)

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

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

ProxyRule -> (structure)

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

ProxyRuleName -> (string)

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

Description -> (string)

A description of the proxy rule.

Action -> (string)

Action to take.

Conditions -> (list)

Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

(structure)

Match criteria that specify what traffic attributes to examine.

ConditionOperator -> (string)

Defines how to perform a match.

ConditionKey -> (string)

Defines what is to be matched.

ConditionValues -> (list)

Specifes the exact value that needs to be matched against.

(string)

RemovedConditions -> (list)

Proxy rule conditions removed from the rule.

(structure)

Match criteria that specify what traffic attributes to examine.

ConditionOperator -> (string)

Defines how to perform a match.

ConditionKey -> (string)

Defines what is to be matched.

ConditionValues -> (list)

Specifes the exact value that needs to be matched against.

(string)

UpdateToken -> (string)

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

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule 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 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.