nat_addresses

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

Overview

Name	nat_addresses
Type	Resource
Id	google.apigee.nat_addresses

Fields

The following fields are returned by SELECT queries:

organizations_instances_nat_addresses_get

Successful response

Name	Datatype	Description
name	string	Required. Resource ID of the NAT address.
ipAddress	string	Output only. The static IPV4 address.
state	string	Output only. State of the nat address.

organizations_instances_nat_addresses_list

Successful response

Name	Datatype	Description
name	string	Required. Resource ID of the NAT address.
ipAddress	string	Output only. The static IPV4 address.
state	string	Output only. State of the nat address.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_instances_nat_addresses_get	select	organizationsId, instancesId, natAddressesId		Gets the details of a NAT address. Note: Not supported for Apigee hybrid.
organizations_instances_nat_addresses_list	select	organizationsId, instancesId	pageSize, pageToken	Lists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid.
organizations_instances_nat_addresses_create	insert	organizationsId, instancesId		Creates 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_delete	delete	organizationsId, instancesId, natAddressesId		Deletes 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_activate	exec	organizationsId, instancesId, natAddressesId		Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.

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
instancesId	string
natAddressesId	string
organizationsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

organizations_instances_nat_addresses_get

Gets the details of a NAT address. Note: Not supported for Apigee hybrid.

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

organizations_instances_nat_addresses_list

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

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

INSERT examples

organizations_instances_nat_addresses_create

Creates 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.

INSERT INTO google.apigee.nat_addresses (
data__name,
organizationsId,
instancesId
)
SELECT 
'{{ name }}',
'{{ organizationsId }}',
'{{ instancesId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: nat_addresses
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the nat_addresses resource.
    - name: instancesId
      value: string
      description: Required parameter for the nat_addresses resource.
    - name: name
      value: string
      description: >
        Required. Resource ID of the NAT address.
        

DELETE examples

organizations_instances_nat_addresses_delete

Deletes the NAT address. Connections that are actively using the address are drained before it is removed. Note: Not supported for Apigee hybrid.

DELETE FROM google.apigee.nat_addresses
WHERE organizationsId = '{{ organizationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND natAddressesId = '{{ natAddressesId }}' --required;

Lifecycle Methods

organizations_instances_nat_addresses_activate

Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.

EXEC google.apigee.nat_addresses.organizations_instances_nat_addresses_activate 
@organizationsId='{{ organizationsId }}' --required, 
@instancesId='{{ instancesId }}' --required, 
@natAddressesId='{{ natAddressesId }}' --required;