EipAssociation

Provides an AWS EIP Association as a top level resource, to associate and disassociate Elastic IPs from AWS Instances and Network Interfaces.

NOTE: Do not use this resource to associate an 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.

NOTE: aws.ec2.EipAssociation is useful in scenarios where EIPs are either pre-existing or distributed to customers or users and therefore cannot be changed.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var web = new Aws.Ec2.Instance("web", new Aws.Ec2.InstanceArgs
        {
            Ami = "ami-21f78e11",
            AvailabilityZone = "us-west-2a",
            InstanceType = "t2.micro",
            Tags = 
            {
                { "Name", "HelloWorld" },
            },
        });
        var example = new Aws.Ec2.Eip("example", new Aws.Ec2.EipArgs
        {
            Vpc = true,
        });
        var eipAssoc = new Aws.Ec2.EipAssociation("eipAssoc", new Aws.Ec2.EipAssociationArgs
        {
            InstanceId = web.Id,
            AllocationId = example.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		web, err := ec2.NewInstance(ctx, "web", &ec2.InstanceArgs{
			Ami:              pulumi.String("ami-21f78e11"),
			AvailabilityZone: pulumi.String("us-west-2a"),
			InstanceType:     pulumi.String("t2.micro"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("HelloWorld"),
			},
		})
		if err != nil {
			return err
		}
		example, err := ec2.NewEip(ctx, "example", &ec2.EipArgs{
			Vpc: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = ec2.NewEipAssociation(ctx, "eipAssoc", &ec2.EipAssociationArgs{
			InstanceId:   web.ID(),
			AllocationId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

web = aws.ec2.Instance("web",
    ami="ami-21f78e11",
    availability_zone="us-west-2a",
    instance_type="t2.micro",
    tags={
        "Name": "HelloWorld",
    })
example = aws.ec2.Eip("example", vpc=True)
eip_assoc = aws.ec2.EipAssociation("eipAssoc",
    instance_id=web.id,
    allocation_id=example.id)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const web = new aws.ec2.Instance("web", {
    ami: "ami-21f78e11",
    availabilityZone: "us-west-2a",
    instanceType: "t2.micro",
    tags: {
        Name: "HelloWorld",
    },
});
const example = new aws.ec2.Eip("example", {vpc: true});
const eipAssoc = new aws.ec2.EipAssociation("eipAssoc", {
    instanceId: web.id,
    allocationId: example.id,
});

Create a EipAssociation Resource

new EipAssociation(name: string, args?: EipAssociationArgs, opts?: CustomResourceOptions);
@overload
def EipAssociation(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   allocation_id: Optional[str] = None,
                   allow_reassociation: Optional[bool] = None,
                   instance_id: Optional[str] = None,
                   network_interface_id: Optional[str] = None,
                   private_ip_address: Optional[str] = None,
                   public_ip: Optional[str] = None)
@overload
def EipAssociation(resource_name: str,
                   args: Optional[EipAssociationArgs] = None,
                   opts: Optional[ResourceOptions] = None)
func NewEipAssociation(ctx *Context, name string, args *EipAssociationArgs, opts ...ResourceOption) (*EipAssociation, error)
public EipAssociation(string name, EipAssociationArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args EipAssociationArgs
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 EipAssociationArgs
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 EipAssociationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EipAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

EipAssociation Resource Properties

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

Inputs

The EipAssociation resource accepts the following input properties:

AllocationId string
The allocation ID. This is required for EC2-VPC.
AllowReassociation bool
Whether to allow an Elastic IP to be re-associated. Defaults to true in VPC.
InstanceId string
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
NetworkInterfaceId string
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
PrivateIpAddress string
The 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.
PublicIp string
The Elastic IP address. This is required for EC2-Classic.
AllocationId string
The allocation ID. This is required for EC2-VPC.
AllowReassociation bool
Whether to allow an Elastic IP to be re-associated. Defaults to true in VPC.
InstanceId string
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
NetworkInterfaceId string
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
PrivateIpAddress string
The 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.
PublicIp string
The Elastic IP address. This is required for EC2-Classic.
allocationId string
The allocation ID. This is required for EC2-VPC.
allowReassociation boolean
Whether to allow an Elastic IP to be re-associated. Defaults to true in VPC.
instanceId string
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
networkInterfaceId string
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
privateIpAddress string
The 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.
publicIp string
The Elastic IP address. This is required for EC2-Classic.
allocation_id str
The allocation ID. This is required for EC2-VPC.
allow_reassociation bool
Whether to allow an Elastic IP to be re-associated. Defaults to true in VPC.
instance_id str
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
network_interface_id str
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
private_ip_address str
The 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.
public_ip str
The Elastic IP address. This is required for EC2-Classic.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing EipAssociation Resource

Get an existing EipAssociation 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?: EipAssociationState, opts?: CustomResourceOptions): EipAssociation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation_id: Optional[str] = None,
        allow_reassociation: Optional[bool] = None,
        instance_id: Optional[str] = None,
        network_interface_id: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        public_ip: Optional[str] = None) -> EipAssociation
func GetEipAssociation(ctx *Context, name string, id IDInput, state *EipAssociationState, opts ...ResourceOption) (*EipAssociation, error)
public static EipAssociation Get(string name, Input<string> id, EipAssociationState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AllocationId string
The allocation ID. This is required for EC2-VPC.
AllowReassociation bool
Whether to allow an Elastic IP to be re-associated. Defaults to true in VPC.
InstanceId string
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
NetworkInterfaceId string
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
PrivateIpAddress string
The 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.
PublicIp string
The Elastic IP address. This is required for EC2-Classic.
AllocationId string
The allocation ID. This is required for EC2-VPC.
AllowReassociation bool
Whether to allow an Elastic IP to be re-associated. Defaults to true in VPC.
InstanceId string
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
NetworkInterfaceId string
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
PrivateIpAddress string
The 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.
PublicIp string
The Elastic IP address. This is required for EC2-Classic.
allocationId string
The allocation ID. This is required for EC2-VPC.
allowReassociation boolean
Whether to allow an Elastic IP to be re-associated. Defaults to true in VPC.
instanceId string
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
networkInterfaceId string
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
privateIpAddress string
The 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.
publicIp string
The Elastic IP address. This is required for EC2-Classic.
allocation_id str
The allocation ID. This is required for EC2-VPC.
allow_reassociation bool
Whether to allow an Elastic IP to be re-associated. Defaults to true in VPC.
instance_id str
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
network_interface_id str
The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
private_ip_address str
The 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.
public_ip str
The Elastic IP address. This is required for EC2-Classic.

Import

EIP Assocations can be imported using their association ID.

 $ pulumi import aws:ec2/eipAssociation:EipAssociation test eipassoc-ab12c345

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.