pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/EipArgs

EipArgs

data class EipArgs(val address: Output<String>? = null, val associateWithPrivateIp: Output<String>? = null, val customerOwnedIpv4Pool: Output<String>? = null, val instance: Output<String>? = null, val networkBorderGroup: Output<String>? = null, val networkInterface: Output<String>? = null, val publicIpv4Pool: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val vpc: Output<Boolean>? = null) : ConvertibleToJava<EipArgs>

Provides an Elastic IP resource.

Note: EIP may require IGW to exist prior to association. Use depends_on to set an explicit dependency on the IGW. Note: Do not use network_interface to associate the EIP to aws.lb.LoadBalancer or aws.ec2.NatGateway resources. Instead use the allocation_id available in those resources to allow AWS to manage the association, otherwise you will see AuthFailure errors.

Example Usage

Single EIP associated with an instance

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Eip;
import com.pulumi.aws.ec2.EipArgs;
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) {
        var lb = new Eip("lb", EipArgs.builder()
            .instance(aws_instance.web().id())
            .vpc(true)
            .build());
    }
}
Content copied to clipboard

Multiple EIPs associated with a single network interface

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.NetworkInterface;
import com.pulumi.aws.ec2.NetworkInterfaceArgs;
import com.pulumi.aws.ec2.Eip;
import com.pulumi.aws.ec2.EipArgs;
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) {
        var multi_ip = new NetworkInterface("multi-ip", NetworkInterfaceArgs.builder()
            .subnetId(aws_subnet.main().id())
            .privateIps(
                "10.0.0.10",
                "10.0.0.11")
            .build());
        var one = new Eip("one", EipArgs.builder()
            .vpc(true)
            .networkInterface(multi_ip.id())
            .associateWithPrivateIp("10.0.0.10")
            .build());
        var two = new Eip("two", EipArgs.builder()
            .vpc(true)
            .networkInterface(multi_ip.id())
            .associateWithPrivateIp("10.0.0.11")
            .build());
    }
}
Content copied to clipboard

Attaching an EIP to an Instance with a pre-assigned private ip (VPC Only)

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.ec2.InternetGateway;
import com.pulumi.aws.ec2.InternetGatewayArgs;
import com.pulumi.aws.ec2.Subnet;
import com.pulumi.aws.ec2.SubnetArgs;
import com.pulumi.aws.ec2.Instance;
import com.pulumi.aws.ec2.InstanceArgs;
import com.pulumi.aws.ec2.Eip;
import com.pulumi.aws.ec2.EipArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        var default_ = new Vpc("default", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .enableDnsHostnames(true)
            .build());
        var gw = new InternetGateway("gw", InternetGatewayArgs.builder()
            .vpcId(default_.id())
            .build());
        var myTestSubnet = new Subnet("myTestSubnet", SubnetArgs.builder()
            .vpcId(default_.id())
            .cidrBlock("10.0.0.0/24")
            .mapPublicIpOnLaunch(true)
            .build(), CustomResourceOptions.builder()
                .dependsOn(gw)
                .build());
        var foo = new Instance("foo", InstanceArgs.builder()
            .ami("ami-5189a661")
            .instanceType("t2.micro")
            .privateIp("10.0.0.12")
            .subnetId(myTestSubnet.id())
            .build());
        var bar = new Eip("bar", EipArgs.builder()
            .vpc(true)
            .instance(foo.id())
            .associateWithPrivateIp("10.0.0.12")
            .build(), CustomResourceOptions.builder()
                .dependsOn(gw)
                .build());
    }
}
Content copied to clipboard

Allocating EIP from the BYOIP pool

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Eip;
import com.pulumi.aws.ec2.EipArgs;
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) {
        var byoip_ip = new Eip("byoip-ip", EipArgs.builder()
            .publicIpv4Pool("ipv4pool-ec2-012345")
            .vpc(true)
            .build());
    }
}
Content copied to clipboard

Import

EIPs in a VPC can be imported using their Allocation ID, e.g.,

$ pulumi import aws:ec2/eip:Eip bar eipalloc-00a10e96
Content copied to clipboard

EIPs in EC2-Classic can be imported using their Public IP, e.g.,

$ pulumi import aws:ec2/eip:Eip bar 52.0.0.0
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(address: Output<String>? = null, associateWithPrivateIp: Output<String>? = null, customerOwnedIpv4Pool: Output<String>? = null, instance: Output<String>? = null, networkBorderGroup: Output<String>? = null, networkInterface: Output<String>? = null, publicIpv4Pool: Output<String>? = null, tags: Output<Map<String, String>>? = null, vpc: Output<Boolean>? = null)

Properties

Link copied to clipboard
val address: Output<String>? = null

IP address from an EC2 BYOIP pool. This option is only available for VPC EIPs.

Link copied to clipboard
val associateWithPrivateIp: Output<String>? = null

User-specified primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

Link copied to clipboard
val customerOwnedIpv4Pool: Output<String>? = null

ID of a customer-owned address pool. For more on customer owned IP addressed check out Customer-owned IP addresses guide.

Link copied to clipboard
val instance: Output<String>? = null

EC2 instance ID.

Link copied to clipboard
val networkBorderGroup: Output<String>? = null

Location from which the IP address is advertised. Use this parameter to limit the address to this location.

Link copied to clipboard
val networkInterface: Output<String>? = null

Network interface ID to associate with.

Link copied to clipboard
val publicIpv4Pool: Output<String>? = null

EC2 IPv4 address pool identifier or amazon. This option is only available for VPC EIPs.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Map of tags to assign to the resource. Tags can only be applied to EIPs in a VPC. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val vpc: Output<Boolean>? = null

Boolean if the EIP is in a VPC or not. Defaults to true unless the region supports EC2-Classic.

Functions

Link copied to clipboard
open override fun toJava(): EipArgs