pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/Ec2Functions/getElasticIp

getElasticIp

suspend fun getElasticIp(argument: GetElasticIpPlainArgs): GetElasticIpResult

aws.ec2.Eip provides details about a specific Elastic IP.

Example Usage

Search By Allocation ID (VPC only)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const byAllocationId = aws.ec2.getElasticIp({
    id: "eipalloc-12345678",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
by_allocation_id = aws.ec2.get_elastic_ip(id="eipalloc-12345678")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var byAllocationId = Aws.Ec2.GetElasticIp.Invoke(new()
    {
        Id = "eipalloc-12345678",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.GetElasticIp(ctx, &ec2.GetElasticIpArgs{
			Id: pulumi.StringRef("eipalloc-12345678"),
		}, nil)
		if err != nil {
			return err
		}
		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.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetElasticIpArgs;
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 byAllocationId = Ec2Functions.getElasticIp(GetElasticIpArgs.builder()
            .id("eipalloc-12345678")
            .build());
    }
}
Content copied to clipboard
variables:
  byAllocationId:
    fn::invoke:
      function: aws:ec2:getElasticIp
      arguments:
        id: eipalloc-12345678
Content copied to clipboard

Search By Filters (EC2-Classic or VPC)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const byFilter = aws.ec2.getElasticIp({
    filters: [{
        name: "tag:Name",
        values: ["exampleNameTagValue"],
    }],
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
by_filter = aws.ec2.get_elastic_ip(filters=[{
    "name": "tag:Name",
    "values": ["exampleNameTagValue"],
}])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var byFilter = Aws.Ec2.GetElasticIp.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetElasticIpFilterInputArgs
            {
                Name = "tag:Name",
                Values = new[]
                {
                    "exampleNameTagValue",
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.GetElasticIp(ctx, &ec2.GetElasticIpArgs{
			Filters: []ec2.GetElasticIpFilter{
				{
					Name: "tag:Name",
					Values: []string{
						"exampleNameTagValue",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		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.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetElasticIpArgs;
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 byFilter = Ec2Functions.getElasticIp(GetElasticIpArgs.builder()
            .filters(GetElasticIpFilterArgs.builder()
                .name("tag:Name")
                .values("exampleNameTagValue")
                .build())
            .build());
    }
}
Content copied to clipboard
variables:
  byFilter:
    fn::invoke:
      function: aws:ec2:getElasticIp
      arguments:
        filters:
          - name: tag:Name
            values:
              - exampleNameTagValue
Content copied to clipboard

Search By Public IP (EC2-Classic or VPC)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const byPublicIp = aws.ec2.getElasticIp({
    publicIp: "1.2.3.4",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
by_public_ip = aws.ec2.get_elastic_ip(public_ip="1.2.3.4")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var byPublicIp = Aws.Ec2.GetElasticIp.Invoke(new()
    {
        PublicIp = "1.2.3.4",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.GetElasticIp(ctx, &ec2.GetElasticIpArgs{
			PublicIp: pulumi.StringRef("1.2.3.4"),
		}, nil)
		if err != nil {
			return err
		}
		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.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetElasticIpArgs;
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 byPublicIp = Ec2Functions.getElasticIp(GetElasticIpArgs.builder()
            .publicIp("1.2.3.4")
            .build());
    }
}
Content copied to clipboard
variables:
  byPublicIp:
    fn::invoke:
      function: aws:ec2:getElasticIp
      arguments:
        publicIp: 1.2.3.4
Content copied to clipboard

Search By Tags (EC2-Classic or VPC)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const byTags = aws.ec2.getElasticIp({
    tags: {
        Name: "exampleNameTagValue",
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
by_tags = aws.ec2.get_elastic_ip(tags={
    "Name": "exampleNameTagValue",
})
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var byTags = Aws.Ec2.GetElasticIp.Invoke(new()
    {
        Tags =
        {
            { "Name", "exampleNameTagValue" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.GetElasticIp(ctx, &ec2.GetElasticIpArgs{
			Tags: map[string]interface{}{
				"Name": "exampleNameTagValue",
			},
		}, nil)
		if err != nil {
			return err
		}
		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.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetElasticIpArgs;
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 byTags = Ec2Functions.getElasticIp(GetElasticIpArgs.builder()
            .tags(Map.of("Name", "exampleNameTagValue"))
            .build());
    }
}
Content copied to clipboard
variables:
  byTags:
    fn::invoke:
      function: aws:ec2:getElasticIp
      arguments:
        tags:
          Name: exampleNameTagValue
Content copied to clipboard

Return

A collection of values returned by getElasticIp.

Parameters

argument

A collection of arguments for invoking getElasticIp.

suspend fun getElasticIp(filters: List<GetElasticIpFilter>? = null, id: String? = null, publicIp: String? = null, tags: Map<String, String>? = null): GetElasticIpResult

Return

A collection of values returned by getElasticIp.

Parameters

filters

One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out the EC2 API Reference.

id

Allocation ID of the specific VPC EIP to retrieve. If a classic EIP is required, do NOT set id, only set public_ip

publicIp

Public IP of the specific EIP to retrieve.

tags

Map of tags, each pair of which must exactly match a pair on the desired Elastic IP

See also

.

suspend fun getElasticIp(argument: suspend GetElasticIpPlainArgsBuilder.() -> Unit): GetElasticIpResult

Return

A collection of values returned by getElasticIp.

Parameters

argument

Builder for com.pulumi.aws.ec2.kotlin.inputs.GetElasticIpPlainArgs.

See also

.