nat_gateways

Creates, updates, deletes, gets or lists a nat_gateways resource.

Overview

Name	`nat_gateways`
Type	Resource
Id	`oci.network.nat_gateways`

Fields

The following fields are returned by SELECT queries:

get
list

The NAT gateway was retrieved.

Name	Datatype	Description
`id`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the NAT gateway.
`blockTraffic`	`boolean`	Whether the NAT gateway blocks traffic through it. The default is `false`. Example: `true`
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the NAT gateway.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`freeformTags`	`object`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleState`	`string`	The NAT gateway's current state. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED)
`natIp`	`string`	The IP address associated with the NAT gateway.
`publicIpId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway.
`routeTableId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.
`timeCreated`	`string (date-time)`	The date and time the NAT gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
`vcnId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the NAT gateway belongs to.

A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic. For more information, see [NAT Gateway](/iaas/Content/Network/Tasks/NATgateway.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).

Name	Datatype	Description
`id`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the NAT gateway.
`blockTraffic`	`boolean`	Whether the NAT gateway blocks traffic through it. The default is `false`. Example: `true`
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the NAT gateway.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`freeformTags`	`object`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleState`	`string`	The NAT gateway's current state. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED)
`natIp`	`string`	The IP address associated with the NAT gateway.
`publicIpId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway.
`routeTableId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.
`timeCreated`	`string (date-time)`	The date and time the NAT gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
`vcnId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the NAT gateway belongs to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`natGatewayId`, `region`		Gets the specified NAT gateway's information.
`list`	`select`	`compartmentId`, `region`	`vcnId`, `limit`, `page`, `displayName`, `sortBy`, `sortOrder`, `lifecycleState`	Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID<br />to filter the results by VCN.<br />
`create`	`insert`	`region`, `compartmentId`, `vcnId`	`opc-retry-token`	Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the<br />NAT gateway as the rule's target. See [Route Table](#/en/iaas/latest/RouteTable/).<br />
`update`	`update`	`natGatewayId`, `region`	`if-match`	Updates the specified NAT gateway.<br />
`delete`	`delete`	`natGatewayId`, `region`	`if-match`	Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there<br />must not be a route rule that lists the NAT gateway as a target.<br /><br />This is an asynchronous operation. The NAT gateway's `lifecycleState` will change to<br />TERMINATING temporarily until the NAT gateway is completely removed.<br />
`change_compartment`	`exec`	`natGatewayId`, `region`, `compartmentId`	`opc-request-id`, `opc-retry-token`	Moves a NAT gateway into a different compartment within the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
`natGatewayId`	`string`	The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm).
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`displayName`	`string`	A filter to return only resources that match the given display name exactly.
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`lifecycleState`	`string`	A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
`limit`	`integer`	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50`
`opc-request-id`	`string`	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
`sortBy`	`string`	The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
`sortOrder`	`string`	The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
`vcnId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.

`SELECT` examples

get
list

Gets the specified NAT gateway's information.

SELECT
id,
blockTraffic,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
natIp,
publicIpId,
routeTableId,
timeCreated,
vcnId
FROM oci.network.nat_gateways
WHERE natGatewayId = '{{ natGatewayId }}' -- required
AND region = '{{ region }}' -- required
;

Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

SELECT
id,
blockTraffic,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
natIp,
publicIpId,
routeTableId,
timeCreated,
vcnId
FROM oci.network.nat_gateways
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND vcnId = '{{ vcnId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND displayName = '{{ displayName }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
;

`INSERT` examples

create
Manifest

Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the NAT gateway as the rule's target. See [Route Table](#/en/iaas/latest/RouteTable/).

INSERT INTO oci.network.nat_gateways (
blockTraffic,
compartmentId,
definedTags,
displayName,
freeformTags,
publicIpId,
routeTableId,
vcnId,
region,
opc-retry-token
)
SELECT 
{{ blockTraffic }},
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ publicIpId }}',
'{{ routeTableId }}',
'{{ vcnId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
blockTraffic,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
natIp,
publicIpId,
routeTableId,
timeCreated,
vcnId
;

# Description fields are for documentation purposes
- name: nat_gateways
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the nat_gateways resource.
  - name: blockTraffic
    value: {{ blockTraffic }}
    description: |
      Whether the NAT gateway blocks traffic through it. The default is `false`.
      Example: `true`
    default: false
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the
      NAT gateway.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      Free-form tags for this resource. Each tag is a simple key-value pair with no
      predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: publicIpId
    value: "{{ publicIpId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway.
  - name: routeTableId
    value: "{{ routeTableId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway.
      If you don't specify a route table here, the NAT gateway is created without an associated route
      table. The Networking service does NOT automatically associate the attached VCN's default route table
      with the NAT gateway.
  - name: vcnId
    value: "{{ vcnId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the gateway belongs to.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

`UPDATE` examples

update

Updates the specified NAT gateway.

UPDATE oci.network.nat_gateways
SET 
blockTraffic = {{ blockTraffic }},
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
routeTableId = '{{ routeTableId }}'
WHERE 
natGatewayId = '{{ natGatewayId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
blockTraffic,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
natIp,
publicIpId,
routeTableId,
timeCreated,
vcnId;

`DELETE` examples

delete

Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there must not be a route rule that lists the NAT gateway as a target. This is an asynchronous operation. The NAT gateway's lifecycleState will change to TERMINATING temporarily until the NAT gateway is completely removed.

DELETE FROM oci.network.nat_gateways
WHERE natGatewayId = '{{ natGatewayId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves a NAT gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

EXEC oci.network.nat_gateways.change_compartment 
@natGatewayId='{{ natGatewayId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​