Skip to content

modify_transit_gateway_attachment_nat_configuration

Operation

modify_transit_gateway_attachment_nat_configuration

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.

Parameters:

Name Type Description Default
request ModifyTransitGatewayAttachmentNatConfigurationInput | ModifyTransitGatewayAttachmentNatConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ModifyTransitGatewayAttachmentNatConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ModifyTransitGatewayAttachmentNatConfigurationOutput

An instance of ModifyTransitGatewayAttachmentNatConfigurationOutput.

modify_transit_gateway_attachment_nat_configuration async

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.

Parameters:

Name Type Description Default
request ModifyTransitGatewayAttachmentNatConfigurationInput | ModifyTransitGatewayAttachmentNatConfigurationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ModifyTransitGatewayAttachmentNatConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ModifyTransitGatewayAttachmentNatConfigurationOutput

An instance of ModifyTransitGatewayAttachmentNatConfigurationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ModifyTransitGatewayAttachmentNatConfigurationInputDict

Bases: TypedDict

Dictionary form of ModifyTransitGatewayAttachmentNatConfigurationInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

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.

nat_gateway_rules instance-attribute

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.

nat_gateway_support instance-attribute
nat_gateway_support: str | None

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.

nat_system_route_support instance-attribute
nat_system_route_support: str | None

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.

reset_nat_gateway_rules instance-attribute
reset_nat_gateway_rules: bool | None

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.

transit_gateway_attachment_id instance-attribute
transit_gateway_attachment_id: Required[str]

The ID of the transit gateway attachment.

ModifyTransitGatewayAttachmentNatConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for ModifyTransitGatewayAttachmentNatConfigurationInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

nat_gateway_rules class-attribute instance-attribute
nat_gateway_rules: list[TransitGatewayNatRuleRequest] | None = ...

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.

nat_gateway_support class-attribute instance-attribute
nat_gateway_support: str | None = ...

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.

nat_system_route_support class-attribute instance-attribute
nat_system_route_support: str | None = ...

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.

reset_nat_gateway_rules class-attribute instance-attribute
reset_nat_gateway_rules: bool | None = ...

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.

transit_gateway_attachment_id class-attribute instance-attribute
transit_gateway_attachment_id: str | None = ...

The ID of the transit gateway attachment.

Output

ModifyTransitGatewayAttachmentNatConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyTransitGatewayAttachmentNatConfigurationOutput structure.

Attributes

nat_gateway_rules class-attribute instance-attribute
nat_gateway_rules: list[TransitGatewayNatRule] | None = ...

The NAT gateway rules for the attachment.

nat_gateway_support class-attribute instance-attribute
nat_gateway_support: str | None = ...

The state of NAT gateway support for the attachment.

nat_system_route_support class-attribute instance-attribute
nat_system_route_support: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

transit_gateway_attachment_id class-attribute instance-attribute
transit_gateway_attachment_id: str | None = ...

The ID of the transit gateway attachment.