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.
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]
> Note: This function is named LookupTransitGatewayAttachmentNatConfiguration in the Go SDK.
fn::invoke:
function: aws-native:ec2:getTransitGatewayAttachmentNatConfiguration
arguments:
# arguments dictionary
data "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.
- NatGatewayRules
List<Pulumi.AwsNative.Ec2.Outputs.TransitGatewayAttachmentNatConfigurationNatRule>
- 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.
- NatGatewaySupport
Pulumi.AwsNative.Ec2.TransitGatewayAttachmentNatConfigurationNatGatewaySupport
- 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.
- NatSystemRouteSupport
Pulumi.AwsNative.Ec2.TransitGatewayAttachmentNatConfigurationNatSystemRouteSupport
- 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.
- NatGatewayRules
[]TransitGatewayAttachmentNatConfigurationNatRule
- 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.
- NatGatewaySupport
TransitGatewayAttachmentNatConfigurationNatGatewaySupport
- 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.
- NatSystemRouteSupport
TransitGatewayAttachmentNatConfigurationNatSystemRouteSupport
- 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_rules
list(object)
- 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_support
"enable" | "disable"
- 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_route_support
"enable" | "disable"
- 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.
- natGatewayRules
List<TransitGatewayAttachmentNatConfigurationNatRule>
- 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.
- natGatewaySupport
TransitGatewayAttachmentNatConfigurationNatGatewaySupport
- 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.
- natSystemRouteSupport
TransitGatewayAttachmentNatConfigurationNatSystemRouteSupport
- 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.
- natGatewayRules
TransitGatewayAttachmentNatConfigurationNatRule[]
- 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.
- natGatewaySupport
TransitGatewayAttachmentNatConfigurationNatGatewaySupport
- 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.
- natSystemRouteSupport
TransitGatewayAttachmentNatConfigurationNatSystemRouteSupport
- 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_rules
Sequence[TransitGatewayAttachmentNatConfigurationNatRule]
- 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_support
TransitGatewayAttachmentNatConfigurationNatGatewaySupport
- 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_route_support
TransitGatewayAttachmentNatConfigurationNatSystemRouteSupport
- 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.
- natGatewayRules
List<Property Map>
- 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.
- natGatewaySupport
"enable" | "disable"
- 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.
- natSystemRouteSupport
"enable" | "disable"
- 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
| Name | Value |
|---|
| Enable | enable |
| Disable | disable |
| Name | Value |
|---|
| TransitGatewayAttachmentNatConfigurationNatGatewaySupportEnable | enable |
| TransitGatewayAttachmentNatConfigurationNatGatewaySupportDisable | disable |
| Name | Value |
|---|
| Enable | enable |
| Disable | disable |
| Name | Value |
|---|
| Enable | enable |
| Disable | disable |
| Name | Value |
|---|
| ENABLE | enable |
| DISABLE | disable |
TransitGatewayAttachmentNatConfigurationNatRule
- MatchSourceCidr
string
- The source CIDR that the rule matches on.
- NatCidr
string
- The CIDR that the matched source addresses are translated to.
- RuleNumber
int
- The rule number.
- MatchSourceCidr
string
- The source CIDR that the rule matches on.
- NatCidr
string
- The CIDR that the matched source addresses are translated to.
- RuleNumber
int
- The rule number.
- matchSourceCidr
String
- The source CIDR that the rule matches on.
- natCidr
String
- The CIDR that the matched source addresses are translated to.
- ruleNumber
Integer
- The rule number.
- matchSourceCidr
string
- The source CIDR that the rule matches on.
- natCidr
string
- The CIDR that the matched source addresses are translated to.
- ruleNumber
number
- The rule number.
- matchSourceCidr
String
- The source CIDR that the rule matches on.
- natCidr
String
- The CIDR that the matched source addresses are translated to.
- ruleNumber
Number
- The rule number.
TransitGatewayAttachmentNatConfigurationNatSystemRouteSupport
| Name | Value |
|---|
| Enable | enable |
| Disable | disable |
| Name | Value |
|---|
| TransitGatewayAttachmentNatConfigurationNatSystemRouteSupportEnable | enable |
| TransitGatewayAttachmentNatConfigurationNatSystemRouteSupportDisable | disable |
| Name | Value |
|---|
| Enable | enable |
| Disable | disable |
| Name | Value |
|---|
| Enable | enable |
| Disable | disable |
| Name | Value |
|---|
| ENABLE | enable |
| DISABLE | disable |
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0