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)

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

Search By Filters (EC2-Classic or VPC)

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

Search By Public IP (EC2-Classic or VPC)

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

Search By Tags (EC2-Classic or VPC)

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

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

.