1. Packages
  2. Equinix
  3. API Docs
  4. metal
  5. IpAttachment
Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix

equinix.metal.IpAttachment

Explore with Pulumi AI

equinix logo
Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix

    Provides a resource to attach elastic IP subnets to devices.

    To attach an IP subnet from a reserved block to a provisioned device, you must derive a subnet CIDR belonging to one of your reserved blocks in the same project and metro as the target device.

    For example, you have reserved IPv4 address block 147.229.10.152/30, you can choose to assign either the whole block as one subnet to a device; or 2 subnets with CIDRs 147.229.10.152/31 and 147.229.10.154/31; or 4 subnets with mask prefix length 32. More about the elastic IP subnets is here.

    Device and reserved block must be in the same metro.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Equinix = Pulumi.Equinix;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var deviceId = config.Require("deviceId");
        var subnetCidr = config.Get("subnetCidr") ?? "147.229.10.152/31";
        var ipAttachResource = new Equinix.Metal.IpAttachment("ipAttach", new()
        {
            DeviceId = deviceId,
            CidrNotation = subnetCidr,
        });
    
        return new Dictionary<string, object?>
        {
            ["ipAttach"] = ipAttachResource.Id,
            ["ipNetmask"] = ipAttachResource.Netmask,
        };
    });
    
    package main
    
    import (
    	"github.com/equinix/pulumi-equinix/sdk/go/equinix/metal"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		deviceId := cfg.Require("deviceId")
    		subnetCidr := "147.229.10.152/31"
    		if param := cfg.Get("subnetCidr"); param != "" {
    			subnetCidr = param
    		}
    		ipAttachResource, err := metal.NewIpAttachment(ctx, "ipAttach", &metal.IpAttachmentArgs{
    			DeviceId:     pulumi.String(deviceId),
    			CidrNotation: pulumi.String(subnetCidr),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("ipAttach", ipAttachResource.ID())
    		ctx.Export("ipNetmask", ipAttachResource.Netmask)
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.equinix.pulumi.metal.IpAttachment;
    import com.equinix.pulumi.metal.IpAttachmentArgs;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var config = ctx.config();
            final var deviceId = config.get("deviceId").get();
            final var subnetCidr = config.get("subnetCidr").orElse("147.229.10.152/31");
            var ipAttachResource = new IpAttachment("ipAttachResource", IpAttachmentArgs.builder()        
                .deviceId(deviceId)
                .cidrNotation(subnetCidr)
                .build());
    
            ctx.export("ipAttach", ipAttachResource.id());
            ctx.export("ipNetmask", ipAttachResource.netmask());
        }
    }
    
    import pulumi
    import pulumi_equinix as equinix
    
    config = pulumi.Config()
    device_id = config.require("deviceId")
    subnet_cidr = config.get("subnetCidr")
    if subnet_cidr is None:
        subnet_cidr = "147.229.10.152/31"
    ip_attach_resource = equinix.metal.IpAttachment("ipAttach",
        device_id=device_id,
        cidr_notation=subnet_cidr)
    pulumi.export("ipAttach", ip_attach_resource.id)
    pulumi.export("ipNetmask", ip_attach_resource.netmask)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as equinix from "@equinix-labs/pulumi-equinix";
    
    const config = new pulumi.Config();
    const deviceId = config.require("deviceId");
    const subnetCidr = config.get("subnetCidr") || "147.229.10.152/31";
    const ipAttachResource = new equinix.metal.IpAttachment("ipAttach", {
        deviceId: deviceId,
        cidrNotation: subnetCidr,
    });
    export const ipAttach = ipAttachResource.id;
    export const ipNetmask = ipAttachResource.netmask;
    
    config:
      deviceId:
        type: string
      subnetCidr:
        type: string
        default: 147.229.10.152/31
    resources:
      ipAttach:
        type: equinix:metal:IpAttachment
        properties:
          deviceId: ${deviceId}
          cidrNotation: ${subnetCidr}
    outputs:
      ipAttach: ${ipAttach.id}
      ipNetmask: ${ipAttach.netmask}
    

    Create IpAttachment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IpAttachment(name: string, args: IpAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def IpAttachment(resource_name: str,
                     args: IpAttachmentArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def IpAttachment(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     cidr_notation: Optional[str] = None,
                     device_id: Optional[str] = None)
    func NewIpAttachment(ctx *Context, name string, args IpAttachmentArgs, opts ...ResourceOption) (*IpAttachment, error)
    public IpAttachment(string name, IpAttachmentArgs args, CustomResourceOptions? opts = null)
    public IpAttachment(String name, IpAttachmentArgs args)
    public IpAttachment(String name, IpAttachmentArgs args, CustomResourceOptions options)
    
    type: equinix:metal:IpAttachment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args IpAttachmentArgs
    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 IpAttachmentArgs
    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 IpAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpAttachmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var ipAttachmentResource = new Equinix.Metal.IpAttachment("ipAttachmentResource", new()
    {
        CidrNotation = "string",
        DeviceId = "string",
    });
    
    example, err := metal.NewIpAttachment(ctx, "ipAttachmentResource", &metal.IpAttachmentArgs{
    	CidrNotation: pulumi.String("string"),
    	DeviceId:     pulumi.String("string"),
    })
    
    var ipAttachmentResource = new IpAttachment("ipAttachmentResource", IpAttachmentArgs.builder()        
        .cidrNotation("string")
        .deviceId("string")
        .build());
    
    ip_attachment_resource = equinix.metal.IpAttachment("ipAttachmentResource",
        cidr_notation="string",
        device_id="string")
    
    const ipAttachmentResource = new equinix.metal.IpAttachment("ipAttachmentResource", {
        cidrNotation: "string",
        deviceId: "string",
    });
    
    type: equinix:metal:IpAttachment
    properties:
        cidrNotation: string
        deviceId: string
    

    IpAttachment Resource Properties

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

    Inputs

    The IpAttachment resource accepts the following input properties:

    CidrNotation string
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    DeviceId string
    ID of device to which to assign the subnet.
    CidrNotation string
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    DeviceId string
    ID of device to which to assign the subnet.
    cidrNotation String
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    deviceId String
    ID of device to which to assign the subnet.
    cidrNotation string
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    deviceId string
    ID of device to which to assign the subnet.
    cidr_notation str
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    device_id str
    ID of device to which to assign the subnet.
    cidrNotation String
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    deviceId String
    ID of device to which to assign the subnet.

    Outputs

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

    Address string
    AddressFamily int
    Address family as integer. One of 4 or 6.
    Cidr int
    Length of CIDR prefix of the subnet as integer.
    Gateway string
    IP address of gateway for the subnet.
    Global bool
    Flag indicating whether IP block is global, i.e. assignable in any location
    Id string
    The provider-assigned unique ID for this managed resource.
    Manageable bool
    Management bool
    Netmask string
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    Network string
    Subnet network address.
    Public bool
    Boolean flag whether subnet is reachable from the Internet.
    VrfId string
    Address string
    AddressFamily int
    Address family as integer. One of 4 or 6.
    Cidr int
    Length of CIDR prefix of the subnet as integer.
    Gateway string
    IP address of gateway for the subnet.
    Global bool
    Flag indicating whether IP block is global, i.e. assignable in any location
    Id string
    The provider-assigned unique ID for this managed resource.
    Manageable bool
    Management bool
    Netmask string
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    Network string
    Subnet network address.
    Public bool
    Boolean flag whether subnet is reachable from the Internet.
    VrfId string
    address String
    addressFamily Integer
    Address family as integer. One of 4 or 6.
    cidr Integer
    Length of CIDR prefix of the subnet as integer.
    gateway String
    IP address of gateway for the subnet.
    global Boolean
    Flag indicating whether IP block is global, i.e. assignable in any location
    id String
    The provider-assigned unique ID for this managed resource.
    manageable Boolean
    management Boolean
    netmask String
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    network String
    Subnet network address.
    public_ Boolean
    Boolean flag whether subnet is reachable from the Internet.
    vrfId String
    address string
    addressFamily number
    Address family as integer. One of 4 or 6.
    cidr number
    Length of CIDR prefix of the subnet as integer.
    gateway string
    IP address of gateway for the subnet.
    global boolean
    Flag indicating whether IP block is global, i.e. assignable in any location
    id string
    The provider-assigned unique ID for this managed resource.
    manageable boolean
    management boolean
    netmask string
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    network string
    Subnet network address.
    public boolean
    Boolean flag whether subnet is reachable from the Internet.
    vrfId string
    address str
    address_family int
    Address family as integer. One of 4 or 6.
    cidr int
    Length of CIDR prefix of the subnet as integer.
    gateway str
    IP address of gateway for the subnet.
    global_ bool
    Flag indicating whether IP block is global, i.e. assignable in any location
    id str
    The provider-assigned unique ID for this managed resource.
    manageable bool
    management bool
    netmask str
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    network str
    Subnet network address.
    public bool
    Boolean flag whether subnet is reachable from the Internet.
    vrf_id str
    address String
    addressFamily Number
    Address family as integer. One of 4 or 6.
    cidr Number
    Length of CIDR prefix of the subnet as integer.
    gateway String
    IP address of gateway for the subnet.
    global Boolean
    Flag indicating whether IP block is global, i.e. assignable in any location
    id String
    The provider-assigned unique ID for this managed resource.
    manageable Boolean
    management Boolean
    netmask String
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    network String
    Subnet network address.
    public Boolean
    Boolean flag whether subnet is reachable from the Internet.
    vrfId String

    Look up Existing IpAttachment Resource

    Get an existing IpAttachment 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?: IpAttachmentState, opts?: CustomResourceOptions): IpAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            address_family: Optional[int] = None,
            cidr: Optional[int] = None,
            cidr_notation: Optional[str] = None,
            device_id: Optional[str] = None,
            gateway: Optional[str] = None,
            global_: Optional[bool] = None,
            manageable: Optional[bool] = None,
            management: Optional[bool] = None,
            netmask: Optional[str] = None,
            network: Optional[str] = None,
            public: Optional[bool] = None,
            vrf_id: Optional[str] = None) -> IpAttachment
    func GetIpAttachment(ctx *Context, name string, id IDInput, state *IpAttachmentState, opts ...ResourceOption) (*IpAttachment, error)
    public static IpAttachment Get(string name, Input<string> id, IpAttachmentState? state, CustomResourceOptions? opts = null)
    public static IpAttachment get(String name, Output<String> id, IpAttachmentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    Address string
    AddressFamily int
    Address family as integer. One of 4 or 6.
    Cidr int
    Length of CIDR prefix of the subnet as integer.
    CidrNotation string
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    DeviceId string
    ID of device to which to assign the subnet.
    Gateway string
    IP address of gateway for the subnet.
    Global bool
    Flag indicating whether IP block is global, i.e. assignable in any location
    Manageable bool
    Management bool
    Netmask string
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    Network string
    Subnet network address.
    Public bool
    Boolean flag whether subnet is reachable from the Internet.
    VrfId string
    Address string
    AddressFamily int
    Address family as integer. One of 4 or 6.
    Cidr int
    Length of CIDR prefix of the subnet as integer.
    CidrNotation string
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    DeviceId string
    ID of device to which to assign the subnet.
    Gateway string
    IP address of gateway for the subnet.
    Global bool
    Flag indicating whether IP block is global, i.e. assignable in any location
    Manageable bool
    Management bool
    Netmask string
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    Network string
    Subnet network address.
    Public bool
    Boolean flag whether subnet is reachable from the Internet.
    VrfId string
    address String
    addressFamily Integer
    Address family as integer. One of 4 or 6.
    cidr Integer
    Length of CIDR prefix of the subnet as integer.
    cidrNotation String
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    deviceId String
    ID of device to which to assign the subnet.
    gateway String
    IP address of gateway for the subnet.
    global Boolean
    Flag indicating whether IP block is global, i.e. assignable in any location
    manageable Boolean
    management Boolean
    netmask String
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    network String
    Subnet network address.
    public_ Boolean
    Boolean flag whether subnet is reachable from the Internet.
    vrfId String
    address string
    addressFamily number
    Address family as integer. One of 4 or 6.
    cidr number
    Length of CIDR prefix of the subnet as integer.
    cidrNotation string
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    deviceId string
    ID of device to which to assign the subnet.
    gateway string
    IP address of gateway for the subnet.
    global boolean
    Flag indicating whether IP block is global, i.e. assignable in any location
    manageable boolean
    management boolean
    netmask string
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    network string
    Subnet network address.
    public boolean
    Boolean flag whether subnet is reachable from the Internet.
    vrfId string
    address str
    address_family int
    Address family as integer. One of 4 or 6.
    cidr int
    Length of CIDR prefix of the subnet as integer.
    cidr_notation str
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    device_id str
    ID of device to which to assign the subnet.
    gateway str
    IP address of gateway for the subnet.
    global_ bool
    Flag indicating whether IP block is global, i.e. assignable in any location
    manageable bool
    management bool
    netmask str
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    network str
    Subnet network address.
    public bool
    Boolean flag whether subnet is reachable from the Internet.
    vrf_id str
    address String
    addressFamily Number
    Address family as integer. One of 4 or 6.
    cidr Number
    Length of CIDR prefix of the subnet as integer.
    cidrNotation String
    CIDR notation of subnet from block reserved in the same project and metro as the device.
    deviceId String
    ID of device to which to assign the subnet.
    gateway String
    IP address of gateway for the subnet.
    global Boolean
    Flag indicating whether IP block is global, i.e. assignable in any location
    manageable Boolean
    management Boolean
    netmask String
    Subnet mask in decimal notation, e.g., 255.255.255.0.
    network String
    Subnet network address.
    public Boolean
    Boolean flag whether subnet is reachable from the Internet.
    vrfId String

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix