pulumi-alicloud-kotlin/com.pulumi.alicloud.vpc.kotlin/VpcFunctions/getNatIps

getNatIps

suspend fun getNatIps(argument: GetNatIpsPlainArgs): GetNatIpsResult

This data source provides the Vpc Nat Ips of the current Alibaba Cloud user.

NOTE: Available in v1.136.0+.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const ids = alicloud.vpc.getNatIps({
    natGatewayId: "example_value",
    ids: [
        "example_value-1",
        "example_value-2",
    ],
});
export const vpcNatIpId1 = ids.then(ids => ids.ips?.[0]?.id);
const nameRegex = alicloud.vpc.getNatIps({
    natGatewayId: "example_value",
    nameRegex: "^my-NatIp",
});
export const vpcNatIpId2 = nameRegex.then(nameRegex => nameRegex.ips?.[0]?.id);
const natIpCidr = alicloud.vpc.getNatIps({
    natGatewayId: "example_value",
    natIpCidr: "example_value",
    nameRegex: "^my-NatIp",
});
export const vpcNatIpId3 = natIpCidr.then(natIpCidr => natIpCidr.ips?.[0]?.id);
const natIpName = alicloud.vpc.getNatIps({
    natGatewayId: "example_value",
    ids: ["example_value"],
    natIpNames: ["example_value"],
});
export const vpcNatIpId4 = natIpName.then(natIpName => natIpName.ips?.[0]?.id);
const natIpIds = alicloud.vpc.getNatIps({
    natGatewayId: "example_value",
    ids: ["example_value"],
    natIpIds: ["example_value"],
});
export const vpcNatIpId5 = natIpIds.then(natIpIds => natIpIds.ips?.[0]?.id);
const status = alicloud.vpc.getNatIps({
    natGatewayId: "example_value",
    ids: ["example_value"],
    status: "example_value",
});
export const vpcNatIpId6 = status.then(status => status.ips?.[0]?.id);
Content copied to clipboard
import pulumi
import pulumi_alicloud as alicloud
ids = alicloud.vpc.get_nat_ips(nat_gateway_id="example_value",
    ids=[
        "example_value-1",
        "example_value-2",
    ])
pulumi.export("vpcNatIpId1", ids.ips[0].id)
name_regex = alicloud.vpc.get_nat_ips(nat_gateway_id="example_value",
    name_regex="^my-NatIp")
pulumi.export("vpcNatIpId2", name_regex.ips[0].id)
nat_ip_cidr = alicloud.vpc.get_nat_ips(nat_gateway_id="example_value",
    nat_ip_cidr="example_value",
    name_regex="^my-NatIp")
pulumi.export("vpcNatIpId3", nat_ip_cidr.ips[0].id)
nat_ip_name = alicloud.vpc.get_nat_ips(nat_gateway_id="example_value",
    ids=["example_value"],
    nat_ip_names=["example_value"])
pulumi.export("vpcNatIpId4", nat_ip_name.ips[0].id)
nat_ip_ids = alicloud.vpc.get_nat_ips(nat_gateway_id="example_value",
    ids=["example_value"],
    nat_ip_ids=["example_value"])
pulumi.export("vpcNatIpId5", nat_ip_ids.ips[0].id)
status = alicloud.vpc.get_nat_ips(nat_gateway_id="example_value",
    ids=["example_value"],
    status="example_value")
pulumi.export("vpcNatIpId6", status.ips[0].id)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
    var ids = AliCloud.Vpc.GetNatIps.Invoke(new()
    {
        NatGatewayId = "example_value",
        Ids = new[]
        {
            "example_value-1",
            "example_value-2",
        },
    });
    var nameRegex = AliCloud.Vpc.GetNatIps.Invoke(new()
    {
        NatGatewayId = "example_value",
        NameRegex = "^my-NatIp",
    });
    var natIpCidr = AliCloud.Vpc.GetNatIps.Invoke(new()
    {
        NatGatewayId = "example_value",
        NatIpCidr = "example_value",
        NameRegex = "^my-NatIp",
    });
    var natIpName = AliCloud.Vpc.GetNatIps.Invoke(new()
    {
        NatGatewayId = "example_value",
        Ids = new[]
        {
            "example_value",
        },
        NatIpNames = new[]
        {
            "example_value",
        },
    });
    var natIpIds = AliCloud.Vpc.GetNatIps.Invoke(new()
    {
        NatGatewayId = "example_value",
        Ids = new[]
        {
            "example_value",
        },
        NatIpIds = new[]
        {
            "example_value",
        },
    });
    var status = AliCloud.Vpc.GetNatIps.Invoke(new()
    {
        NatGatewayId = "example_value",
        Ids = new[]
        {
            "example_value",
        },
        Status = "example_value",
    });
    return new Dictionary<string, object?>
    {
        ["vpcNatIpId1"] = ids&#46;Apply(getNatIpsResult => getNatIpsResult&#46;Ips[0]?.Id),
        ["vpcNatIpId2"] = nameRegex&#46;Apply(getNatIpsResult => getNatIpsResult&#46;Ips[0]?.Id),
        ["vpcNatIpId3"] = natIpCidr&#46;Apply(getNatIpsResult => getNatIpsResult&#46;Ips[0]?.Id),
        ["vpcNatIpId4"] = natIpName&#46;Apply(getNatIpsResult => getNatIpsResult&#46;Ips[0]?.Id),
        ["vpcNatIpId5"] = natIpIds&#46;Apply(getNatIpsResult => getNatIpsResult&#46;Ips[0]?.Id),
        ["vpcNatIpId6"] = status&#46;Apply(getNatIpsResult => getNatIpsResult&#46;Ips[0]?.Id),
    };
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := vpc.GetNatIps(ctx, &vpc.GetNatIpsArgs{
			NatGatewayId: "example_value",
			Ids: []string{
				"example_value-1",
				"example_value-2",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpcNatIpId1", ids.Ips[0].Id)
		nameRegex, err := vpc.GetNatIps(ctx, &vpc.GetNatIpsArgs{
			NatGatewayId: "example_value",
			NameRegex:    pulumi.StringRef("^my-NatIp"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpcNatIpId2", nameRegex.Ips[0].Id)
		natIpCidr, err := vpc.GetNatIps(ctx, &vpc.GetNatIpsArgs{
			NatGatewayId: "example_value",
			NatIpCidr:    pulumi.StringRef("example_value"),
			NameRegex:    pulumi.StringRef("^my-NatIp"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpcNatIpId3", natIpCidr.Ips[0].Id)
		natIpName, err := vpc.GetNatIps(ctx, &vpc.GetNatIpsArgs{
			NatGatewayId: "example_value",
			Ids: []string{
				"example_value",
			},
			NatIpNames: []string{
				"example_value",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpcNatIpId4", natIpName.Ips[0].Id)
		natIpIds, err := vpc.GetNatIps(ctx, &vpc.GetNatIpsArgs{
			NatGatewayId: "example_value",
			Ids: []string{
				"example_value",
			},
			NatIpIds: []string{
				"example_value",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpcNatIpId5", natIpIds.Ips[0].Id)
		status, err := vpc.GetNatIps(ctx, &vpc.GetNatIpsArgs{
			NatGatewayId: "example_value",
			Ids: []string{
				"example_value",
			},
			Status: pulumi.StringRef("example_value"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpcNatIpId6", status.Ips[0].Id)
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNatIpsArgs;
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 ids = VpcFunctions.getNatIps(GetNatIpsArgs.builder()
            .natGatewayId("example_value")
            .ids(
                "example_value-1",
                "example_value-2")
            .build());
        ctx.export("vpcNatIpId1", ids.applyValue(getNatIpsResult -> getNatIpsResult.ips()[0].id()));
        final var nameRegex = VpcFunctions.getNatIps(GetNatIpsArgs.builder()
            .natGatewayId("example_value")
            .nameRegex("^my-NatIp")
            .build());
        ctx.export("vpcNatIpId2", nameRegex.applyValue(getNatIpsResult -> getNatIpsResult.ips()[0].id()));
        final var natIpCidr = VpcFunctions.getNatIps(GetNatIpsArgs.builder()
            .natGatewayId("example_value")
            .natIpCidr("example_value")
            .nameRegex("^my-NatIp")
            .build());
        ctx.export("vpcNatIpId3", natIpCidr.applyValue(getNatIpsResult -> getNatIpsResult.ips()[0].id()));
        final var natIpName = VpcFunctions.getNatIps(GetNatIpsArgs.builder()
            .natGatewayId("example_value")
            .ids("example_value")
            .natIpNames("example_value")
            .build());
        ctx.export("vpcNatIpId4", natIpName.applyValue(getNatIpsResult -> getNatIpsResult.ips()[0].id()));
        final var natIpIds = VpcFunctions.getNatIps(GetNatIpsArgs.builder()
            .natGatewayId("example_value")
            .ids("example_value")
            .natIpIds("example_value")
            .build());
        ctx.export("vpcNatIpId5", natIpIds.applyValue(getNatIpsResult -> getNatIpsResult.ips()[0].id()));
        final var status = VpcFunctions.getNatIps(GetNatIpsArgs.builder()
            .natGatewayId("example_value")
            .ids("example_value")
            .status("example_value")
            .build());
        ctx.export("vpcNatIpId6", status.applyValue(getNatIpsResult -> getNatIpsResult.ips()[0].id()));
    }
}
Content copied to clipboard
variables:
  ids:
    fn::invoke:
      function: alicloud:vpc:getNatIps
      arguments:
        natGatewayId: example_value
        ids:
          - example_value-1
          - example_value-2
  nameRegex:
    fn::invoke:
      function: alicloud:vpc:getNatIps
      arguments:
        natGatewayId: example_value
        nameRegex: ^my-NatIp
  natIpCidr:
    fn::invoke:
      function: alicloud:vpc:getNatIps
      arguments:
        natGatewayId: example_value
        natIpCidr: example_value
        nameRegex: ^my-NatIp
  natIpName:
    fn::invoke:
      function: alicloud:vpc:getNatIps
      arguments:
        natGatewayId: example_value
        ids:
          - example_value
        natIpNames:
          - example_value
  natIpIds:
    fn::invoke:
      function: alicloud:vpc:getNatIps
      arguments:
        natGatewayId: example_value
        ids:
          - example_value
        natIpIds:
          - example_value
  status:
    fn::invoke:
      function: alicloud:vpc:getNatIps
      arguments:
        natGatewayId: example_value
        ids:
          - example_value
        status: example_value
outputs:
  vpcNatIpId1: ${ids.ips[0].id}
  vpcNatIpId2: ${nameRegex.ips[0].id}
  vpcNatIpId3: ${natIpCidr.ips[0].id}
  vpcNatIpId4: ${natIpName.ips[0].id}
  vpcNatIpId5: ${natIpIds.ips[0].id}
  vpcNatIpId6: ${status.ips[0].id}
Content copied to clipboard

Return

A collection of values returned by getNatIps.

Parameters

argument

A collection of arguments for invoking getNatIps.

suspend fun getNatIps(ids: List<String>? = null, nameRegex: String? = null, natGatewayId: String, natIpCidr: String? = null, natIpIds: List<String>? = null, natIpNames: List<String>? = null, outputFile: String? = null, status: String? = null): GetNatIpsResult

Return

A collection of values returned by getNatIps.

Parameters

ids

A list of Nat Ip IDs.

nameRegex

A regex string to filter results by Nat Ip name.

natGatewayId

The ID of the Virtual Private Cloud (VPC) NAT gateway for which you want to create the NAT IP address.

natIpCidr

NAT IP ADDRESS of the address segment.

natIpIds
natIpNames

NAT IP ADDRESS the name of the root directory. Length is from 2 to 128 characters, must start with a letter or the Chinese at the beginning can contain numbers, half a period (.), underscore (_) and dash (-). But do not start with http:// or https:// at the beginning.

outputFile

File name where to save data source results (after running pulumi preview).

status

The status of the NAT IP address. Valid values: Available, Deleting and Creating.

See also

.

suspend fun getNatIps(argument: suspend GetNatIpsPlainArgsBuilder.() -> Unit): GetNatIpsResult

Return

A collection of values returned by getNatIps.

Parameters

argument

Builder for com.pulumi.alicloud.vpc.kotlin.inputs.GetNatIpsPlainArgs.

See also

.