AWS CLI Command Reference

[ aws . ecs ]

update-gateway

Description

Modifies the configuration of a gateway. You can change only the properties that can be applied without interrupting traffic, and the configuration variant that you provide must match the gateway’s type. UpdateGateway is an asynchronous operation: the changes are applied to each load balancer the gateway manages, and the gateway reports a status of UPDATE_IN_PROGRESS until the update completes. If Amazon ECS can’t update one or more resources, it makes a best effort to update the rest and the gateway status changes to UPDATE_FAILED . Use DescribeGateway to inspect the gateway’s statusReason and failures list, which gives the ARN of each load balancer that was not updated and the operation, error code, and message for each failure.

If you specify infrastructureRoleArn , you must have the iam:PassRole permission for that role.

See also: AWS API Documentation

Synopsis

  update-gateway
--gateway <value>
[--infrastructure-role-arn <value>]
[--deletion-protection | --no-deletion-protection]
[--configuration <value>]
[--propagate-tags <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]
[--cli-error-format <value>]

Options

--gateway (string) [required]

The name or Amazon Resource Name (ARN) of the gateway to update.

--infrastructure-role-arn (string)

The Amazon Resource Name (ARN) of the IAM role that the gateway assumes to manage infrastructure on your behalf.

--deletion-protection | --no-deletion-protection (boolean)

Specifies whether to enable deletion protection for the gateway. When enabled, the gateway can’t be deleted.

--configuration (tagged union structure)

The updated type-specific configuration for the gateway. The configuration variant must match the gateway’s existing type, and only mutable fields can be changed.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: hostSharedAlb.

hostSharedAlb -> (structure)

The mutable configuration for a host-based, shared Application Load Balancer gateway.

networkConfiguration -> (structure)

The mutable network configuration for the load balancers that the gateway manages.

inboundSecurityGroup -> (string)

The ID of a security group that you provide to control inbound traffic to the load balancers that the gateway manages. When you specify a security group, the gateway doesn’t create inbound rules on the security group it manages.

maxAlbCount -> (integer)

The maximum number of Application Load Balancers that the gateway manages.

webACLArn -> (string)

The Amazon Resource Name (ARN) of the WAF web ACL to associate with the load balancers that the gateway manages.

accessLogs -> (structure)

The access log configuration for the load balancers that the gateway manages.

destination -> (tagged union structure)

The destination where access logs are delivered.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

The Amazon S3 destination for access logs.

bucket -> (string) [required]

The name of the Amazon S3 bucket where access logs are delivered.

prefix -> (string)

The object key prefix for the access logs in the Amazon S3 bucket.

httpDesync -> (string)

The desync mitigation mode for the load balancers that the gateway manages.

Possible values:

  • monitor
  • defensive
  • strictest

testTrafficRules -> (structure)

The rules that route test traffic for progressive deployments.

header -> (structure)

The header-based rule that identifies test traffic.

name -> (string) [required]

The name of the header to match for test traffic routing.

values -> (list) [required]

The header values to match for test traffic routing.

(string)

JSON Syntax:

{
  "hostSharedAlb": {
    "networkConfiguration": {
      "inboundSecurityGroup": "string"
    },
    "maxAlbCount": integer,
    "webACLArn": "string",
    "accessLogs": {
      "destination": {
        "s3": {
          "bucket": "string",
          "prefix": "string"
        }
      }
    },
    "httpDesync": "monitor"|"defensive"|"strictest",
    "testTrafficRules": {
      "header": {
        "name": "string",
        "values": ["string", ...]
      }
    }
  }
}

--propagate-tags (string)

Specifies whether to propagate the tags from the gateway to the infrastructure that the gateway manages. If you don’t specify a value, the gateway’s existing setting is unchanged.

Possible values:

  • NONE
  • GATEWAY

--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
  • off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

gatewayArn -> (string)

The Amazon Resource Name (ARN) of the gateway.

name -> (string)

The name of the gateway.

status -> (string)

The status of the gateway. After a successful update request, the status is UPDATE_IN_PROGRESS .

Possible values:

  • ACTIVE
  • UPDATE_IN_PROGRESS
  • UPDATE_COMPLETE
  • UPDATE_FAILED
  • DELETED
© Copyright 2026, Amazon Web Services. Created using Sphinx.