AWS CLI Command Reference

[ aws . ec2 ]

modify-transit-gateway-attachment-nat-configuration

Description

Modifies the NAT configuration for the specified transit gateway attachment. Use this operation to do the following:

  • Enable or disable NAT gateway support for the attachment.
  • Specify whether the transit gateway installs routes for the NAT CIDRs.
  • Replace the NAT gateway rules for the attachment.

Only the owner of the transit gateway can modify the NAT configuration.

With NAT gateway support enabled, the transit gateway translates addresses in each rule’s MatchSourceCidr range to the corresponding addresses in its NatCidr range.

The transit gateway applies changes asynchronously. To check the result, use GetTransitGatewayAttachmentNatConfiguration .

See also: AWS API Documentation

Synopsis

  modify-transit-gateway-attachment-nat-configuration
--transit-gateway-attachment-id <value>
[--nat-gateway-support <value>]
[--nat-system-route-support <value>]
[--nat-gateway-rules <value>]
[--reset-nat-gateway-rules | --no-reset-nat-gateway-rules]
[--dry-run | --no-dry-run]
[--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

--transit-gateway-attachment-id (string) [required]

The ID of the transit gateway attachment.

--nat-gateway-support (string)

Specifies whether to enable or disable NAT gateway support for the attachment. To enable NAT gateway support, the attachment must have at least one NAT gateway rule. You can’t modify the NAT configuration while NAT gateway support is enabling or disabling . If you omit this parameter, the current value doesn’t change.

Possible values:

  • enable
  • disable

--nat-system-route-support (string)

Specifies whether the transit gateway installs routes for the NAT CIDRs in the route tables to which the attachment propagates. For VPC attachments, the transit gateway always installs these routes. You can enable or disable this option only for Amazon Web Services Direct Connect gateway attachments and Site-to-Site VPN attachments that use dynamic routing. For these attachments, the default is enable . If you omit this parameter, the current value doesn’t change.

Possible values:

  • enable
  • disable

--nat-gateway-rules (list)

The NAT gateway rules for the attachment. The rules that you specify replace all existing NAT gateway rules for the attachment. You can specify up to 50 rules for an attachment. If you omit this parameter, the existing rules don’t change. To remove all rules, use ResetNatGatewayRules .

Constraints:

  • min: 0
  • max: 50

(structure)

Describes a NAT gateway rule to apply to a transit gateway attachment. A NAT gateway rule translates source addresses in the MatchSourceCidr range to the corresponding addresses in the NatCidr range.

RuleNumber -> (integer)

The rule number. Valid values are 1 to 32766. Each rule number must be unique within the request.

MatchSourceCidr -> (string)

The IPv4 CIDR block of the source addresses to translate. The CIDR block can’t overlap the multicast range (224.0.0.0/4 ) or the link-local range (169.254.0.0/16 ).

NatCidr -> (string)

The IPv4 CIDR block to translate the source addresses to. The CIDR block must be in a private (RFC 1918) or shared address space (RFC 6598) range, and must have the same prefix length as MatchSourceCidr . The CIDR blocks in the rules for an attachment can’t overlap each other.

Shorthand Syntax:

RuleNumber=integer,MatchSourceCidr=string,NatCidr=string ...

JSON Syntax:

[
  {
    "RuleNumber": integer,
    "MatchSourceCidr": "string",
    "NatCidr": "string"
  }
  ...
]

--reset-nat-gateway-rules | --no-reset-nat-gateway-rules (boolean)

Specifies whether to remove all NAT gateway rules from the attachment. If you omit this parameter, the transit gateway doesn’t remove any rules. You can’t specify this parameter together with NatGatewayRules . Because you can’t enable NAT gateway support without rules, also set NatGatewaySupport to disable in the same request if NAT gateway support is currently enabled.

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

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

TransitGatewayAttachmentId -> (string)

The ID of the transit gateway attachment.

NatGatewaySupport -> (string)

The state of NAT gateway support for the attachment.

Possible values:

  • enabled
  • disabled
  • enabling
  • disabling

NatSystemRouteSupport -> (string)

Specifies whether the transit gateway installs routes for the NAT CIDRs in the route tables to which the attachment propagates.

Possible values:

  • enable
  • disable

NatGatewayRules -> (list)

The NAT gateway rules for the attachment.

Constraints:

  • min: 0
  • max: 50

(structure)

Contains information about a NAT gateway rule for a transit gateway attachment, including the rule number, the source CIDR block, the translated CIDR block, and the state of the rule.

RuleNumber -> (integer)

The rule number.

MatchSourceCidr -> (string)

The IPv4 CIDR block of the source addresses to translate.

NatCidr -> (string)

The IPv4 CIDR block that the transit gateway translates the source addresses to.

State -> (string)

The state of the NAT gateway rule. The possible values are:

  • pending - The transit gateway is applying a change to the rule.
  • activated - The rule is in effect because NAT gateway support is enabled for the attachment.
  • deactivated - The rule isn’t in effect because NAT gateway support is disabled for the attachment.

Possible values:

  • pending
  • activated
  • deactivated
  • deleting
© Copyright 2026, Amazon Web Services. Created using Sphinx.