We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi
Resource Type definition for AWS::EC2::TransitGatewayAttachmentNatConfiguration. Configures static 1:1 NAT on a transit gateway attachment. Each rule translates a source CIDR to a NAT CIDR. NatGatewaySupport controls whether creating this resource activates the rules or stages them; deleting this resource disables NAT gateway support and removes all NAT rules. This resource must be managed from the account that owns the transit gateway. NAT support depends on the attachment type, and the transit gateway rejects a request to configure NAT on an attachment type that does not support it.
Using getTransitGatewayAttachmentNatConfiguration
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTransitGatewayAttachmentNatConfiguration(args: GetTransitGatewayAttachmentNatConfigurationArgs, opts?: InvokeOptions): Promise<GetTransitGatewayAttachmentNatConfigurationResult>
function getTransitGatewayAttachmentNatConfigurationOutput(args: GetTransitGatewayAttachmentNatConfigurationOutputArgs, opts?: InvokeOutputOptions): Output<GetTransitGatewayAttachmentNatConfigurationResult>def get_transit_gateway_attachment_nat_configuration(arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTransitGatewayAttachmentNatConfigurationResult
def get_transit_gateway_attachment_nat_configuration_output(arn: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetTransitGatewayAttachmentNatConfigurationResult]func LookupTransitGatewayAttachmentNatConfiguration(ctx *Context, args *LookupTransitGatewayAttachmentNatConfigurationArgs, opts ...InvokeOption) (*LookupTransitGatewayAttachmentNatConfigurationResult, error)
func LookupTransitGatewayAttachmentNatConfigurationOutput(ctx *Context, args *LookupTransitGatewayAttachmentNatConfigurationOutputArgs, opts ...InvokeOption) LookupTransitGatewayAttachmentNatConfigurationResultOutput> Note: This function is named LookupTransitGatewayAttachmentNatConfiguration in the Go SDK.
public static class GetTransitGatewayAttachmentNatConfiguration
{
public static Task<GetTransitGatewayAttachmentNatConfigurationResult> InvokeAsync(GetTransitGatewayAttachmentNatConfigurationArgs args, InvokeOptions? opts = null)
public static Output<GetTransitGatewayAttachmentNatConfigurationResult> Invoke(GetTransitGatewayAttachmentNatConfigurationInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetTransitGatewayAttachmentNatConfigurationResult> Invoke(GetTransitGatewayAttachmentNatConfigurationInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetTransitGatewayAttachmentNatConfigurationResult> getTransitGatewayAttachmentNatConfiguration(GetTransitGatewayAttachmentNatConfigurationArgs args, InvokeOptions options)
public static Output<GetTransitGatewayAttachmentNatConfigurationResult> getTransitGatewayAttachmentNatConfiguration(GetTransitGatewayAttachmentNatConfigurationArgs args, InvokeOptions options)
public static Output<GetTransitGatewayAttachmentNatConfigurationResult> getTransitGatewayAttachmentNatConfiguration(GetTransitGatewayAttachmentNatConfigurationArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:ec2:getTransitGatewayAttachmentNatConfiguration
arguments:
# arguments dictionarydata "aws-native_ec2_get_transit_gateway_attachment_nat_configuration" "name" {
# arguments
}The following arguments are supported:
- Arn string
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- Arn string
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- arn string
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- arn String
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- arn string
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- arn str
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- arn String
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
getTransitGatewayAttachmentNatConfiguration Result
The following output properties are available:
- Arn string
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- Nat
Gateway List<Pulumi.Rules Aws Native. Ec2. Outputs. Transit Gateway Attachment Nat Configuration Nat Rule> - The complete set of NAT rules for the attachment. Updating this property replaces the entire rule set: rules omitted from the new value are removed.
- Nat
Gateway Pulumi.Support Aws Native. Ec2. Transit Gateway Attachment Nat Configuration Nat Gateway Support - Whether NAT gateway support is enabled on the attachment. Set to disable to stage NAT rules without activating them; the rules are retained and become active when this is later set to enable.
- Nat
System Pulumi.Route Support Aws Native. Ec2. Transit Gateway Attachment Nat Configuration Nat System Route Support - Whether routes for the NAT CIDRs are installed into the transit gateway route tables associated with the attachment. Whether this is configurable depends on the attachment; where the value is forced, supplying the opposite value is rejected. Omitting this property leaves the setting to the service: on a new configuration the service applies the attachment's default, but on an attachment where the value is configurable it keeps the value already in effect rather than reverting to that default. Removing this property from a template, or deleting this resource, therefore leaves the setting at its last value rather than restoring the default, and a resource later created on the same attachment without this property inherits that value.
- Arn string
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- Nat
Gateway []TransitRules Gateway Attachment Nat Configuration Nat Rule - The complete set of NAT rules for the attachment. Updating this property replaces the entire rule set: rules omitted from the new value are removed.
- Nat
Gateway TransitSupport Gateway Attachment Nat Configuration Nat Gateway Support - Whether NAT gateway support is enabled on the attachment. Set to disable to stage NAT rules without activating them; the rules are retained and become active when this is later set to enable.
- Nat
System TransitRoute Support Gateway Attachment Nat Configuration Nat System Route Support - Whether routes for the NAT CIDRs are installed into the transit gateway route tables associated with the attachment. Whether this is configurable depends on the attachment; where the value is forced, supplying the opposite value is rejected. Omitting this property leaves the setting to the service: on a new configuration the service applies the attachment's default, but on an attachment where the value is configurable it keeps the value already in effect rather than reverting to that default. Removing this property from a template, or deleting this resource, therefore leaves the setting at its last value rather than restoring the default, and a resource later created on the same attachment without this property inherits that value.
- arn string
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- nat_
gateway_ list(object)rules - The complete set of NAT rules for the attachment. Updating this property replaces the entire rule set: rules omitted from the new value are removed.
- nat_
gateway_ "enable" | "disable"support - Whether NAT gateway support is enabled on the attachment. Set to disable to stage NAT rules without activating them; the rules are retained and become active when this is later set to enable.
- nat_
system_ "enable" | "disable"route_ support - Whether routes for the NAT CIDRs are installed into the transit gateway route tables associated with the attachment. Whether this is configurable depends on the attachment; where the value is forced, supplying the opposite value is rejected. Omitting this property leaves the setting to the service: on a new configuration the service applies the attachment's default, but on an attachment where the value is configurable it keeps the value already in effect rather than reverting to that default. Removing this property from a template, or deleting this resource, therefore leaves the setting at its last value rather than restoring the default, and a resource later created on the same attachment without this property inherits that value.
- arn String
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- nat
Gateway List<TransitRules Gateway Attachment Nat Configuration Nat Rule> - The complete set of NAT rules for the attachment. Updating this property replaces the entire rule set: rules omitted from the new value are removed.
- nat
Gateway TransitSupport Gateway Attachment Nat Configuration Nat Gateway Support - Whether NAT gateway support is enabled on the attachment. Set to disable to stage NAT rules without activating them; the rules are retained and become active when this is later set to enable.
- nat
System TransitRoute Support Gateway Attachment Nat Configuration Nat System Route Support - Whether routes for the NAT CIDRs are installed into the transit gateway route tables associated with the attachment. Whether this is configurable depends on the attachment; where the value is forced, supplying the opposite value is rejected. Omitting this property leaves the setting to the service: on a new configuration the service applies the attachment's default, but on an attachment where the value is configurable it keeps the value already in effect rather than reverting to that default. Removing this property from a template, or deleting this resource, therefore leaves the setting at its last value rather than restoring the default, and a resource later created on the same attachment without this property inherits that value.
- arn string
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- nat
Gateway TransitRules Gateway Attachment Nat Configuration Nat Rule[] - The complete set of NAT rules for the attachment. Updating this property replaces the entire rule set: rules omitted from the new value are removed.
- nat
Gateway TransitSupport Gateway Attachment Nat Configuration Nat Gateway Support - Whether NAT gateway support is enabled on the attachment. Set to disable to stage NAT rules without activating them; the rules are retained and become active when this is later set to enable.
- nat
System TransitRoute Support Gateway Attachment Nat Configuration Nat System Route Support - Whether routes for the NAT CIDRs are installed into the transit gateway route tables associated with the attachment. Whether this is configurable depends on the attachment; where the value is forced, supplying the opposite value is rejected. Omitting this property leaves the setting to the service: on a new configuration the service applies the attachment's default, but on an attachment where the value is configurable it keeps the value already in effect rather than reverting to that default. Removing this property from a template, or deleting this resource, therefore leaves the setting at its last value rather than restoring the default, and a resource later created on the same attachment without this property inherits that value.
- arn str
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- nat_
gateway_ Sequence[Transitrules Gateway Attachment Nat Configuration Nat Rule] - The complete set of NAT rules for the attachment. Updating this property replaces the entire rule set: rules omitted from the new value are removed.
- nat_
gateway_ Transitsupport Gateway Attachment Nat Configuration Nat Gateway Support - Whether NAT gateway support is enabled on the attachment. Set to disable to stage NAT rules without activating them; the rules are retained and become active when this is later set to enable.
- nat_
system_ Transitroute_ support Gateway Attachment Nat Configuration Nat System Route Support - Whether routes for the NAT CIDRs are installed into the transit gateway route tables associated with the attachment. Whether this is configurable depends on the attachment; where the value is forced, supplying the opposite value is rejected. Omitting this property leaves the setting to the service: on a new configuration the service applies the attachment's default, but on an attachment where the value is configurable it keeps the value already in effect rather than reverting to that default. Removing this property from a template, or deleting this resource, therefore leaves the setting at its last value rather than restoring the default, and a resource later created on the same attachment without this property inherits that value.
- arn String
- Synthetic ARN encoding the NAT configuration's identity (the transit gateway attachment ID). Transit Gateway does not issue an ARN for a NAT configuration; this value exists so the configuration has a primary identifier, and it is not accepted by any EC2 API.
- nat
Gateway List<Property Map>Rules - The complete set of NAT rules for the attachment. Updating this property replaces the entire rule set: rules omitted from the new value are removed.
- nat
Gateway "enable" | "disable"Support - Whether NAT gateway support is enabled on the attachment. Set to disable to stage NAT rules without activating them; the rules are retained and become active when this is later set to enable.
- nat
System "enable" | "disable"Route Support - Whether routes for the NAT CIDRs are installed into the transit gateway route tables associated with the attachment. Whether this is configurable depends on the attachment; where the value is forced, supplying the opposite value is rejected. Omitting this property leaves the setting to the service: on a new configuration the service applies the attachment's default, but on an attachment where the value is configurable it keeps the value already in effect rather than reverting to that default. Removing this property from a template, or deleting this resource, therefore leaves the setting at its last value rather than restoring the default, and a resource later created on the same attachment without this property inherits that value.
Supporting Types
TransitGatewayAttachmentNatConfigurationNatGatewaySupport
TransitGatewayAttachmentNatConfigurationNatRule
- Match
Source stringCidr - The source CIDR that the rule matches on.
- Nat
Cidr string - The CIDR that the matched source addresses are translated to.
- Rule
Number int - The rule number.
- Match
Source stringCidr - The source CIDR that the rule matches on.
- Nat
Cidr string - The CIDR that the matched source addresses are translated to.
- Rule
Number int - The rule number.
- match_
source_ stringcidr - The source CIDR that the rule matches on.
- nat_
cidr string - The CIDR that the matched source addresses are translated to.
- rule_
number number - The rule number.
- match
Source StringCidr - The source CIDR that the rule matches on.
- nat
Cidr String - The CIDR that the matched source addresses are translated to.
- rule
Number Integer - The rule number.
- match
Source stringCidr - The source CIDR that the rule matches on.
- nat
Cidr string - The CIDR that the matched source addresses are translated to.
- rule
Number number - The rule number.
- match_
source_ strcidr - The source CIDR that the rule matches on.
- nat_
cidr str - The CIDR that the matched source addresses are translated to.
- rule_
number int - The rule number.
- match
Source StringCidr - The source CIDR that the rule matches on.
- nat
Cidr String - The CIDR that the matched source addresses are translated to.
- rule
Number Number - The rule number.
TransitGatewayAttachmentNatConfigurationNatSystemRouteSupport
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi