1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. NatAddress
Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

gcp.apigee.NatAddress

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

    Apigee NAT (network address translation) address. A NAT address is a static external IP address used for Internet egress traffic. This is not avaible for Apigee hybrid. Apigee NAT addresses are not automatically activated because they might require explicit allow entries on the target systems first. See https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances.natAddresses/activate

    To get more information about NatAddress, see:

    Example Usage

    Apigee Nat Address Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const current = gcp.organizations.getClientConfig({});
    const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
    const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
        name: "apigee-range",
        purpose: "VPC_PEERING",
        addressType: "INTERNAL",
        prefixLength: 21,
        network: apigeeNetwork.id,
    });
    const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
        network: apigeeNetwork.id,
        service: "servicenetworking.googleapis.com",
        reservedPeeringRanges: [apigeeRange.name],
    });
    const apigeeKeyring = new gcp.kms.KeyRing("apigee_keyring", {
        name: "apigee-keyring",
        location: "us-central1",
    });
    const apigeeKey = new gcp.kms.CryptoKey("apigee_key", {
        name: "apigee-key",
        keyRing: apigeeKeyring.id,
    });
    const apigeeSa = new gcp.projects.ServiceIdentity("apigee_sa", {
        project: project.projectId,
        service: apigee.service,
    });
    const apigeeSaKeyuser = new gcp.kms.CryptoKeyIAMMember("apigee_sa_keyuser", {
        cryptoKeyId: apigeeKey.id,
        role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
        member: pulumi.interpolate`serviceAccount:${apigeeSa.email}`,
    });
    const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
        analyticsRegion: "us-central1",
        displayName: "apigee-org",
        description: "Terraform-provisioned Apigee Org.",
        projectId: current.then(current => current.project),
        authorizedNetwork: apigeeNetwork.id,
        runtimeDatabaseEncryptionKeyName: apigeeKey.id,
    });
    const apigeeInstance = new gcp.apigee.Instance("apigee_instance", {
        name: "apigee-instance",
        location: "us-central1",
        description: "Terraform-managed Apigee Runtime Instance",
        displayName: "apigee-instance",
        orgId: apigeeOrg.id,
        diskEncryptionKeyName: apigeeKey.id,
    });
    const apigee_nat = new gcp.apigee.NatAddress("apigee-nat", {
        name: "my-nat-address",
        instanceId: apigeeInstance.id,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    current = gcp.organizations.get_client_config()
    apigee_network = gcp.compute.Network("apigee_network", name="apigee-network")
    apigee_range = gcp.compute.GlobalAddress("apigee_range",
        name="apigee-range",
        purpose="VPC_PEERING",
        address_type="INTERNAL",
        prefix_length=21,
        network=apigee_network.id)
    apigee_vpc_connection = gcp.servicenetworking.Connection("apigee_vpc_connection",
        network=apigee_network.id,
        service="servicenetworking.googleapis.com",
        reserved_peering_ranges=[apigee_range.name])
    apigee_keyring = gcp.kms.KeyRing("apigee_keyring",
        name="apigee-keyring",
        location="us-central1")
    apigee_key = gcp.kms.CryptoKey("apigee_key",
        name="apigee-key",
        key_ring=apigee_keyring.id)
    apigee_sa = gcp.projects.ServiceIdentity("apigee_sa",
        project=project["projectId"],
        service=apigee["service"])
    apigee_sa_keyuser = gcp.kms.CryptoKeyIAMMember("apigee_sa_keyuser",
        crypto_key_id=apigee_key.id,
        role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
        member=apigee_sa.email.apply(lambda email: f"serviceAccount:{email}"))
    apigee_org = gcp.apigee.Organization("apigee_org",
        analytics_region="us-central1",
        display_name="apigee-org",
        description="Terraform-provisioned Apigee Org.",
        project_id=current.project,
        authorized_network=apigee_network.id,
        runtime_database_encryption_key_name=apigee_key.id)
    apigee_instance = gcp.apigee.Instance("apigee_instance",
        name="apigee-instance",
        location="us-central1",
        description="Terraform-managed Apigee Runtime Instance",
        display_name="apigee-instance",
        org_id=apigee_org.id,
        disk_encryption_key_name=apigee_key.id)
    apigee_nat = gcp.apigee.NatAddress("apigee-nat",
        name="my-nat-address",
        instance_id=apigee_instance.id)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigee"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/projects"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/servicenetworking"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := organizations.GetClientConfig(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		apigeeNetwork, err := compute.NewNetwork(ctx, "apigee_network", &compute.NetworkArgs{
    			Name: pulumi.String("apigee-network"),
    		})
    		if err != nil {
    			return err
    		}
    		apigeeRange, err := compute.NewGlobalAddress(ctx, "apigee_range", &compute.GlobalAddressArgs{
    			Name:         pulumi.String("apigee-range"),
    			Purpose:      pulumi.String("VPC_PEERING"),
    			AddressType:  pulumi.String("INTERNAL"),
    			PrefixLength: pulumi.Int(21),
    			Network:      apigeeNetwork.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = servicenetworking.NewConnection(ctx, "apigee_vpc_connection", &servicenetworking.ConnectionArgs{
    			Network: apigeeNetwork.ID(),
    			Service: pulumi.String("servicenetworking.googleapis.com"),
    			ReservedPeeringRanges: pulumi.StringArray{
    				apigeeRange.Name,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		apigeeKeyring, err := kms.NewKeyRing(ctx, "apigee_keyring", &kms.KeyRingArgs{
    			Name:     pulumi.String("apigee-keyring"),
    			Location: pulumi.String("us-central1"),
    		})
    		if err != nil {
    			return err
    		}
    		apigeeKey, err := kms.NewCryptoKey(ctx, "apigee_key", &kms.CryptoKeyArgs{
    			Name:    pulumi.String("apigee-key"),
    			KeyRing: apigeeKeyring.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		apigeeSa, err := projects.NewServiceIdentity(ctx, "apigee_sa", &projects.ServiceIdentityArgs{
    			Project: pulumi.Any(project.ProjectId),
    			Service: pulumi.Any(apigee.Service),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = kms.NewCryptoKeyIAMMember(ctx, "apigee_sa_keyuser", &kms.CryptoKeyIAMMemberArgs{
    			CryptoKeyId: apigeeKey.ID(),
    			Role:        pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
    			Member: apigeeSa.Email.ApplyT(func(email string) (string, error) {
    				return fmt.Sprintf("serviceAccount:%v", email), nil
    			}).(pulumi.StringOutput),
    		})
    		if err != nil {
    			return err
    		}
    		apigeeOrg, err := apigee.NewOrganization(ctx, "apigee_org", &apigee.OrganizationArgs{
    			AnalyticsRegion:                  pulumi.String("us-central1"),
    			DisplayName:                      pulumi.String("apigee-org"),
    			Description:                      pulumi.String("Terraform-provisioned Apigee Org."),
    			ProjectId:                        pulumi.String(current.Project),
    			AuthorizedNetwork:                apigeeNetwork.ID(),
    			RuntimeDatabaseEncryptionKeyName: apigeeKey.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		apigeeInstance, err := apigee.NewInstance(ctx, "apigee_instance", &apigee.InstanceArgs{
    			Name:                  pulumi.String("apigee-instance"),
    			Location:              pulumi.String("us-central1"),
    			Description:           pulumi.String("Terraform-managed Apigee Runtime Instance"),
    			DisplayName:           pulumi.String("apigee-instance"),
    			OrgId:                 apigeeOrg.ID(),
    			DiskEncryptionKeyName: apigeeKey.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apigee.NewNatAddress(ctx, "apigee-nat", &apigee.NatAddressArgs{
    			Name:       pulumi.String("my-nat-address"),
    			InstanceId: apigeeInstance.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Gcp.Organizations.GetClientConfig.Invoke();
    
        var apigeeNetwork = new Gcp.Compute.Network("apigee_network", new()
        {
            Name = "apigee-network",
        });
    
        var apigeeRange = new Gcp.Compute.GlobalAddress("apigee_range", new()
        {
            Name = "apigee-range",
            Purpose = "VPC_PEERING",
            AddressType = "INTERNAL",
            PrefixLength = 21,
            Network = apigeeNetwork.Id,
        });
    
        var apigeeVpcConnection = new Gcp.ServiceNetworking.Connection("apigee_vpc_connection", new()
        {
            Network = apigeeNetwork.Id,
            Service = "servicenetworking.googleapis.com",
            ReservedPeeringRanges = new[]
            {
                apigeeRange.Name,
            },
        });
    
        var apigeeKeyring = new Gcp.Kms.KeyRing("apigee_keyring", new()
        {
            Name = "apigee-keyring",
            Location = "us-central1",
        });
    
        var apigeeKey = new Gcp.Kms.CryptoKey("apigee_key", new()
        {
            Name = "apigee-key",
            KeyRing = apigeeKeyring.Id,
        });
    
        var apigeeSa = new Gcp.Projects.ServiceIdentity("apigee_sa", new()
        {
            Project = project.ProjectId,
            Service = apigee.Service,
        });
    
        var apigeeSaKeyuser = new Gcp.Kms.CryptoKeyIAMMember("apigee_sa_keyuser", new()
        {
            CryptoKeyId = apigeeKey.Id,
            Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
            Member = apigeeSa.Email.Apply(email => $"serviceAccount:{email}"),
        });
    
        var apigeeOrg = new Gcp.Apigee.Organization("apigee_org", new()
        {
            AnalyticsRegion = "us-central1",
            DisplayName = "apigee-org",
            Description = "Terraform-provisioned Apigee Org.",
            ProjectId = current.Apply(getClientConfigResult => getClientConfigResult.Project),
            AuthorizedNetwork = apigeeNetwork.Id,
            RuntimeDatabaseEncryptionKeyName = apigeeKey.Id,
        });
    
        var apigeeInstance = new Gcp.Apigee.Instance("apigee_instance", new()
        {
            Name = "apigee-instance",
            Location = "us-central1",
            Description = "Terraform-managed Apigee Runtime Instance",
            DisplayName = "apigee-instance",
            OrgId = apigeeOrg.Id,
            DiskEncryptionKeyName = apigeeKey.Id,
        });
    
        var apigee_nat = new Gcp.Apigee.NatAddress("apigee-nat", new()
        {
            Name = "my-nat-address",
            InstanceId = apigeeInstance.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.organizations.OrganizationsFunctions;
    import com.pulumi.gcp.compute.Network;
    import com.pulumi.gcp.compute.NetworkArgs;
    import com.pulumi.gcp.compute.GlobalAddress;
    import com.pulumi.gcp.compute.GlobalAddressArgs;
    import com.pulumi.gcp.servicenetworking.Connection;
    import com.pulumi.gcp.servicenetworking.ConnectionArgs;
    import com.pulumi.gcp.kms.KeyRing;
    import com.pulumi.gcp.kms.KeyRingArgs;
    import com.pulumi.gcp.kms.CryptoKey;
    import com.pulumi.gcp.kms.CryptoKeyArgs;
    import com.pulumi.gcp.projects.ServiceIdentity;
    import com.pulumi.gcp.projects.ServiceIdentityArgs;
    import com.pulumi.gcp.kms.CryptoKeyIAMMember;
    import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
    import com.pulumi.gcp.apigee.Organization;
    import com.pulumi.gcp.apigee.OrganizationArgs;
    import com.pulumi.gcp.apigee.Instance;
    import com.pulumi.gcp.apigee.InstanceArgs;
    import com.pulumi.gcp.apigee.NatAddress;
    import com.pulumi.gcp.apigee.NatAddressArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var current = OrganizationsFunctions.getClientConfig();
    
            var apigeeNetwork = new Network("apigeeNetwork", NetworkArgs.builder()        
                .name("apigee-network")
                .build());
    
            var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()        
                .name("apigee-range")
                .purpose("VPC_PEERING")
                .addressType("INTERNAL")
                .prefixLength(21)
                .network(apigeeNetwork.id())
                .build());
    
            var apigeeVpcConnection = new Connection("apigeeVpcConnection", ConnectionArgs.builder()        
                .network(apigeeNetwork.id())
                .service("servicenetworking.googleapis.com")
                .reservedPeeringRanges(apigeeRange.name())
                .build());
    
            var apigeeKeyring = new KeyRing("apigeeKeyring", KeyRingArgs.builder()        
                .name("apigee-keyring")
                .location("us-central1")
                .build());
    
            var apigeeKey = new CryptoKey("apigeeKey", CryptoKeyArgs.builder()        
                .name("apigee-key")
                .keyRing(apigeeKeyring.id())
                .build());
    
            var apigeeSa = new ServiceIdentity("apigeeSa", ServiceIdentityArgs.builder()        
                .project(project.projectId())
                .service(apigee.service())
                .build());
    
            var apigeeSaKeyuser = new CryptoKeyIAMMember("apigeeSaKeyuser", CryptoKeyIAMMemberArgs.builder()        
                .cryptoKeyId(apigeeKey.id())
                .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
                .member(apigeeSa.email().applyValue(email -> String.format("serviceAccount:%s", email)))
                .build());
    
            var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()        
                .analyticsRegion("us-central1")
                .displayName("apigee-org")
                .description("Terraform-provisioned Apigee Org.")
                .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
                .authorizedNetwork(apigeeNetwork.id())
                .runtimeDatabaseEncryptionKeyName(apigeeKey.id())
                .build());
    
            var apigeeInstance = new Instance("apigeeInstance", InstanceArgs.builder()        
                .name("apigee-instance")
                .location("us-central1")
                .description("Terraform-managed Apigee Runtime Instance")
                .displayName("apigee-instance")
                .orgId(apigeeOrg.id())
                .diskEncryptionKeyName(apigeeKey.id())
                .build());
    
            var apigee_nat = new NatAddress("apigee-nat", NatAddressArgs.builder()        
                .name("my-nat-address")
                .instanceId(apigeeInstance.id())
                .build());
    
        }
    }
    
    resources:
      apigeeNetwork:
        type: gcp:compute:Network
        name: apigee_network
        properties:
          name: apigee-network
      apigeeRange:
        type: gcp:compute:GlobalAddress
        name: apigee_range
        properties:
          name: apigee-range
          purpose: VPC_PEERING
          addressType: INTERNAL
          prefixLength: 21
          network: ${apigeeNetwork.id}
      apigeeVpcConnection:
        type: gcp:servicenetworking:Connection
        name: apigee_vpc_connection
        properties:
          network: ${apigeeNetwork.id}
          service: servicenetworking.googleapis.com
          reservedPeeringRanges:
            - ${apigeeRange.name}
      apigeeKeyring:
        type: gcp:kms:KeyRing
        name: apigee_keyring
        properties:
          name: apigee-keyring
          location: us-central1
      apigeeKey:
        type: gcp:kms:CryptoKey
        name: apigee_key
        properties:
          name: apigee-key
          keyRing: ${apigeeKeyring.id}
      apigeeSa:
        type: gcp:projects:ServiceIdentity
        name: apigee_sa
        properties:
          project: ${project.projectId}
          service: ${apigee.service}
      apigeeSaKeyuser:
        type: gcp:kms:CryptoKeyIAMMember
        name: apigee_sa_keyuser
        properties:
          cryptoKeyId: ${apigeeKey.id}
          role: roles/cloudkms.cryptoKeyEncrypterDecrypter
          member: serviceAccount:${apigeeSa.email}
      apigeeOrg:
        type: gcp:apigee:Organization
        name: apigee_org
        properties:
          analyticsRegion: us-central1
          displayName: apigee-org
          description: Terraform-provisioned Apigee Org.
          projectId: ${current.project}
          authorizedNetwork: ${apigeeNetwork.id}
          runtimeDatabaseEncryptionKeyName: ${apigeeKey.id}
      apigeeInstance:
        type: gcp:apigee:Instance
        name: apigee_instance
        properties:
          name: apigee-instance
          location: us-central1
          description: Terraform-managed Apigee Runtime Instance
          displayName: apigee-instance
          orgId: ${apigeeOrg.id}
          diskEncryptionKeyName: ${apigeeKey.id}
      apigee-nat:
        type: gcp:apigee:NatAddress
        properties:
          name: my-nat-address
          instanceId: ${apigeeInstance.id}
    variables:
      current:
        fn::invoke:
          Function: gcp:organizations:getClientConfig
          Arguments: {}
    

    Create NatAddress Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NatAddress(name: string, args: NatAddressArgs, opts?: CustomResourceOptions);
    @overload
    def NatAddress(resource_name: str,
                   args: NatAddressArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def NatAddress(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_id: Optional[str] = None,
                   name: Optional[str] = None)
    func NewNatAddress(ctx *Context, name string, args NatAddressArgs, opts ...ResourceOption) (*NatAddress, error)
    public NatAddress(string name, NatAddressArgs args, CustomResourceOptions? opts = null)
    public NatAddress(String name, NatAddressArgs args)
    public NatAddress(String name, NatAddressArgs args, CustomResourceOptions options)
    
    type: gcp:apigee:NatAddress
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args NatAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NatAddressArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NatAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NatAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NatAddressArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var natAddressResource = new Gcp.Apigee.NatAddress("natAddressResource", new()
    {
        InstanceId = "string",
        Name = "string",
    });
    
    example, err := apigee.NewNatAddress(ctx, "natAddressResource", &apigee.NatAddressArgs{
    	InstanceId: pulumi.String("string"),
    	Name:       pulumi.String("string"),
    })
    
    var natAddressResource = new NatAddress("natAddressResource", NatAddressArgs.builder()        
        .instanceId("string")
        .name("string")
        .build());
    
    nat_address_resource = gcp.apigee.NatAddress("natAddressResource",
        instance_id="string",
        name="string")
    
    const natAddressResource = new gcp.apigee.NatAddress("natAddressResource", {
        instanceId: "string",
        name: "string",
    });
    
    type: gcp:apigee:NatAddress
    properties:
        instanceId: string
        name: string
    

    NatAddress Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The NatAddress resource accepts the following input properties:

    InstanceId string
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    Name string
    Resource ID of the NAT address.
    InstanceId string
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    Name string
    Resource ID of the NAT address.
    instanceId String
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    name String
    Resource ID of the NAT address.
    instanceId string
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    name string
    Resource ID of the NAT address.
    instance_id str
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    name str
    Resource ID of the NAT address.
    instanceId String
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    name String
    Resource ID of the NAT address.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NatAddress resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The allocated NAT IP address.
    State string
    State of the NAT IP address.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The allocated NAT IP address.
    State string
    State of the NAT IP address.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The allocated NAT IP address.
    state String
    State of the NAT IP address.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    The allocated NAT IP address.
    state string
    State of the NAT IP address.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    The allocated NAT IP address.
    state str
    State of the NAT IP address.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The allocated NAT IP address.
    state String
    State of the NAT IP address.

    Look up Existing NatAddress Resource

    Get an existing NatAddress resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NatAddressState, opts?: CustomResourceOptions): NatAddress
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            instance_id: Optional[str] = None,
            ip_address: Optional[str] = None,
            name: Optional[str] = None,
            state: Optional[str] = None) -> NatAddress
    func GetNatAddress(ctx *Context, name string, id IDInput, state *NatAddressState, opts ...ResourceOption) (*NatAddress, error)
    public static NatAddress Get(string name, Input<string> id, NatAddressState? state, CustomResourceOptions? opts = null)
    public static NatAddress get(String name, Output<String> id, NatAddressState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    InstanceId string
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    IpAddress string
    The allocated NAT IP address.
    Name string
    Resource ID of the NAT address.
    State string
    State of the NAT IP address.
    InstanceId string
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    IpAddress string
    The allocated NAT IP address.
    Name string
    Resource ID of the NAT address.
    State string
    State of the NAT IP address.
    instanceId String
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    ipAddress String
    The allocated NAT IP address.
    name String
    Resource ID of the NAT address.
    state String
    State of the NAT IP address.
    instanceId string
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    ipAddress string
    The allocated NAT IP address.
    name string
    Resource ID of the NAT address.
    state string
    State of the NAT IP address.
    instance_id str
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    ip_address str
    The allocated NAT IP address.
    name str
    Resource ID of the NAT address.
    state str
    State of the NAT IP address.
    instanceId String
    The Apigee instance associated with the Apigee environment, in the format organizations/{{org_name}}/instances/{{instance_name}}.


    ipAddress String
    The allocated NAT IP address.
    name String
    Resource ID of the NAT address.
    state String
    State of the NAT IP address.

    Import

    NatAddress can be imported using any of these accepted formats:

    • {{instance_id}}/natAddresses/{{name}}

    • {{instance_id}}/{{name}}

    When using the pulumi import command, NatAddress can be imported using one of the formats above. For example:

    $ pulumi import gcp:apigee/natAddress:NatAddress default {{instance_id}}/natAddresses/{{name}}
    
    $ pulumi import gcp:apigee/natAddress:NatAddress default {{instance_id}}/{{name}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi