update-responder-gateway — AWS CLI 2.36.44 Command Reference
AWS CLI Command Reference

[ aws . rtbfabric ]

update-responder-gateway

Description

Updates the description, Auto Scaling group managed endpoint configuration, trust store configuration, and client routing policy of a responder gateway. This operation also updates the protocols list in the listener configuration.

You cannot change the domainName , port , and protocol values that you set when you create a responder gateway. To change any of them, delete the gateway and create a new one.

See also: AWS API Documentation

Synopsis

  update-responder-gateway
[--domain-name <value>]
--port <value>
--protocol <value>
[--listener-config <value>]
[--trust-store-configuration <value>]
[--managed-endpoint-configuration <value>]
[--client-token <value>]
--gateway-id <value>
[--description <value>]
[--client-routing-policy <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

--domain-name (string)

Domain name for the responder gateway. This operation does not change the domain name of an existing gateway. To use a different domain name, delete the gateway and create a new one.

Constraints:

  • min: 1
  • max: 255
  • pattern: (?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))+

--port (integer) [required]

Networking port to use. This operation does not change the port of an existing gateway. To use a different port, delete the gateway and create a new one.

Constraints:

  • min: 1
  • max: 65535

--protocol (string) [required]

Networking protocol to use. This operation does not change the protocol of an existing gateway. To use a different protocol, delete the gateway and create a new one.

Possible values:

  • HTTP
  • HTTPS

--listener-config (structure)

The listener configuration for the responder gateway.

protocols -> (list) [required]

The protocol for connections from clients to the gateway

Constraints:

  • min: 1
  • max: 2

(string)

Possible values:

  • HTTP
  • HTTPS

Shorthand Syntax:

protocols=string,string

JSON Syntax:

{
  "protocols": ["HTTP"|"HTTPS", ...]
}

--trust-store-configuration (structure)

The configuration of the trust store.

certificateAuthorityCertificates -> (list) [required]

The certificate authority certificate.

Constraints:

  • min: 0
  • max: 2

(string)

Constraints:

  • min: 1
  • max: 2097152

Shorthand Syntax:

certificateAuthorityCertificates=string,string

JSON Syntax:

{
  "certificateAuthorityCertificates": ["string", ...]
}

--managed-endpoint-configuration (tagged union structure)

The configuration for the managed endpoint.

Note

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

autoScalingGroups -> (structure)

Describes the configuration of an auto scaling group.

autoScalingGroupNames -> (list) [required]

The names of the auto scaling group.

(string)

Constraints:

  • min: 1
  • max: 255

roleArn -> (string) [required]

The role ARN of the auto scaling group.

Constraints:

  • pattern: arn:aws:iam::[0-9]{12}:role/.{1,2048}

healthCheckConfig -> (structure)

The health check configuration for the Auto Scaling group managed endpoint.

port -> (integer) [required]

The port to use for health check probes. Valid range is 80 to 65535.

Constraints:

  • min: 80
  • max: 65535

path -> (string) [required]

The destination path for the health check request. Must start with / .

Constraints:

  • min: 1
  • max: 128
  • pattern: /.*

protocol -> (string)

The protocol to use for health check probes.

Possible values:

  • HTTP
  • HTTPS

timeoutMs -> (integer)

The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.

Constraints:

  • min: 100
  • max: 5000

intervalSeconds -> (integer)

The interval between health check probes, in seconds. Valid range is 5 to 60.

Constraints:

  • min: 5
  • max: 60

statusCodeMatcher -> (string)

The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200 ), a range (for example, 200-299 ), or a comma-separated list (for example, 200,204 ).

Constraints:

  • min: 1
  • max: 64

healthyThresholdCount -> (integer)

The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.

Constraints:

  • min: 2
  • max: 10

unhealthyThresholdCount -> (integer)

The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.

Constraints:

  • min: 2
  • max: 10

eksEndpoints -> (structure)

Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.

endpointsResourceName -> (string) [required]

The name of the endpoint resource.

Constraints:

  • min: 2
  • max: 63
  • pattern: [A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]

endpointsResourceNamespace -> (string) [required]

The namespace of the endpoint resource.

Constraints:

  • min: 2
  • max: 63
  • pattern: [A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]

clusterApiServerEndpointUri -> (string) [required]

The URI of the cluster API server endpoint.

Constraints:

  • min: 0
  • max: 255
  • pattern: (https|http)://(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)(?:\.(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?))+

clusterApiServerCaCertificateChain -> (string) [required]

The CA certificate chain of the cluster API server.

Constraints:

  • min: 1
  • max: 2097152

clusterName -> (string) [required]

The name of the cluster.

Constraints:

  • min: 2
  • max: 63
  • pattern: [A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]

roleArn -> (string) [required]

The role ARN for the cluster.

Constraints:

  • pattern: arn:aws:iam::[0-9]{12}:role/.{1,2048}

Shorthand Syntax:

autoScalingGroups={autoScalingGroupNames=[string,string],roleArn=string,healthCheckConfig={port=integer,path=string,protocol=string,timeoutMs=integer,intervalSeconds=integer,statusCodeMatcher=string,healthyThresholdCount=integer,unhealthyThresholdCount=integer}},eksEndpoints={endpointsResourceName=string,endpointsResourceNamespace=string,clusterApiServerEndpointUri=string,clusterApiServerCaCertificateChain=string,clusterName=string,roleArn=string}

JSON Syntax:

{
  "autoScalingGroups": {
    "autoScalingGroupNames": ["string", ...],
    "roleArn": "string",
    "healthCheckConfig": {
      "port": integer,
      "path": "string",
      "protocol": "HTTP"|"HTTPS",
      "timeoutMs": integer,
      "intervalSeconds": integer,
      "statusCodeMatcher": "string",
      "healthyThresholdCount": integer,
      "unhealthyThresholdCount": integer
    }
  },
  "eksEndpoints": {
    "endpointsResourceName": "string",
    "endpointsResourceNamespace": "string",
    "clusterApiServerEndpointUri": "string",
    "clusterApiServerCaCertificateChain": "string",
    "clusterName": "string",
    "roleArn": "string"
  }
}

--client-token (string)

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value .

If you don’t provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same clientToken , but with different parameters, the retry fails with an IdempotentParameterMismatch error.

--gateway-id (string) [required]

The unique identifier of the gateway.

Constraints:

  • min: 8
  • max: 32
  • pattern: rtb-gw-[a-z0-9-]{1,25}

--description (string)

An optional description for the responder gateway.

Constraints:

  • pattern: [A-Za-z0-9 ]+

--client-routing-policy (string)

The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. Valid values are the following:

  • AVAILABILITY_ZONE_AFFINITY : RTB Fabric routes each requester’s traffic to gateway capacity in the requester’s own Availability Zone when the gateway has capacity available there. Otherwise, RTB Fabric routes the traffic to gateway capacity in the other Availability Zones of the gateway.
  • ANY_AVAILABILITY_ZONE : RTB Fabric routes each requester’s traffic to gateway capacity in every Availability Zone that the subnets of the gateway span. The Availability Zone that the requester is in does not change this.

If you don’t specify a value, the gateway keeps its current client routing policy. Changing the policy sets the gateway status to PENDING_UPDATE until the change is complete. RTB Fabric does not support partial Availability Zone affinity, so PARTIAL_AVAILABILITY_ZONE_AFFINITY is not a valid value. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide .

Possible values:

  • AVAILABILITY_ZONE_AFFINITY
  • ANY_AVAILABILITY_ZONE

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

gatewayId -> (string)

The unique identifier of the gateway.

Constraints:

  • min: 8
  • max: 32
  • pattern: rtb-gw-[a-z0-9-]{1,25}

status -> (string)

The status of the request.

Possible values:

  • PENDING_CREATION
  • ACTIVE
  • PENDING_DELETION
  • DELETED
  • ERROR
  • PENDING_UPDATE
  • ISOLATED
  • PENDING_ISOLATION
  • PENDING_RESTORATION

clientRoutingPolicy -> (string)

The client routing policy of the gateway. If the operation changed this policy, the gateway uses the new policy after its status returns to ACTIVE . For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide .

Possible values:

  • AVAILABILITY_ZONE_AFFINITY
  • ANY_AVAILABILITY_ZONE
© Copyright 2026, Amazon Web Services. Created using Sphinx.