Skip to main content

nat_addresses

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

Overview

Namenat_addresses
TypeResource
Idgoogle.apigee.nat_addresses

Fields

NameDatatypeDescription
namestringRequired. Resource ID of the NAT address.
ipAddressstringOutput only. The static IPV4 address.
statestringOutput only. State of the nat address.

Methods

NameAccessible byRequired ParamsDescription
organizations_instances_nat_addresses_getSELECTinstancesId, natAddressesId, organizationsIdGets the details of a NAT address. Note: Not supported for Apigee hybrid.
organizations_instances_nat_addresses_listSELECTinstancesId, organizationsIdLists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid.
organizations_instances_nat_addresses_createINSERTinstancesId, organizationsIdCreates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. Note: Not supported for Apigee hybrid.
organizations_instances_nat_addresses_deleteDELETEinstancesId, natAddressesId, organizationsIdDeletes the NAT address. Connections that are actively using the address are drained before it is removed. Note: Not supported for Apigee hybrid.
organizations_instances_nat_addresses_activateEXECinstancesId, natAddressesId, organizationsIdActivates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.

SELECT examples

Lists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid.

SELECT
name,
ipAddress,
state
FROM google.apigee.nat_addresses
WHERE instancesId = '{{ instancesId }}'
AND organizationsId = '{{ organizationsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new nat_addresses resource.

/*+ create */
INSERT INTO google.apigee.nat_addresses (
instancesId,
organizationsId,
name
)
SELECT
'{{ instancesId }}',
'{{ organizationsId }}',
'{{ name }}'
;

DELETE example

Deletes the specified nat_addresses resource.

/*+ delete */
DELETE FROM google.apigee.nat_addresses
WHERE instancesId = '{{ instancesId }}'
AND natAddressesId = '{{ natAddressesId }}'
AND organizationsId = '{{ organizationsId }}';