1. Packages
  2. DigitalOcean
  3. API Docs
  4. ReservedIp
DigitalOcean v4.30.2 published on Wednesday, Jun 5, 2024 by Pulumi

digitalocean.ReservedIp

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.30.2 published on Wednesday, Jun 5, 2024 by Pulumi

    Provides a DigitalOcean reserved IP to represent a publicly-accessible static IP addresses that can be mapped to one of your Droplets.

    NOTE: Reserved IPs can be assigned to a Droplet either directly on the digitalocean.ReservedIp resource by setting a droplet_id or using the digitalocean.ReservedIpAssignment resource, but the two cannot be used together.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const example = new digitalocean.Droplet("example", {
        name: "example",
        size: digitalocean.DropletSlug.DropletS1VCPU1GB,
        image: "ubuntu-22-04-x64",
        region: digitalocean.Region.NYC3,
        ipv6: true,
        privateNetworking: true,
    });
    const exampleReservedIp = new digitalocean.ReservedIp("example", {
        dropletId: example.id,
        region: example.region,
    });
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    example = digitalocean.Droplet("example",
        name="example",
        size=digitalocean.DropletSlug.DROPLET_S1_VCPU1_GB,
        image="ubuntu-22-04-x64",
        region=digitalocean.Region.NYC3,
        ipv6=True,
        private_networking=True)
    example_reserved_ip = digitalocean.ReservedIp("example",
        droplet_id=example.id,
        region=example.region)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := digitalocean.NewDroplet(ctx, "example", &digitalocean.DropletArgs{
    			Name:              pulumi.String("example"),
    			Size:              pulumi.String(digitalocean.DropletSlugDropletS1VCPU1GB),
    			Image:             pulumi.String("ubuntu-22-04-x64"),
    			Region:            pulumi.String(digitalocean.RegionNYC3),
    			Ipv6:              pulumi.Bool(true),
    			PrivateNetworking: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = digitalocean.NewReservedIp(ctx, "example", &digitalocean.ReservedIpArgs{
    			DropletId: example.ID(),
    			Region:    example.Region,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new DigitalOcean.Droplet("example", new()
        {
            Name = "example",
            Size = DigitalOcean.DropletSlug.DropletS1VCPU1GB,
            Image = "ubuntu-22-04-x64",
            Region = DigitalOcean.Region.NYC3,
            Ipv6 = true,
            PrivateNetworking = true,
        });
    
        var exampleReservedIp = new DigitalOcean.ReservedIp("example", new()
        {
            DropletId = example.Id,
            Region = example.Region,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.Droplet;
    import com.pulumi.digitalocean.DropletArgs;
    import com.pulumi.digitalocean.ReservedIp;
    import com.pulumi.digitalocean.ReservedIpArgs;
    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 example = new Droplet("example", DropletArgs.builder()
                .name("example")
                .size("s-1vcpu-1gb")
                .image("ubuntu-22-04-x64")
                .region("nyc3")
                .ipv6(true)
                .privateNetworking(true)
                .build());
    
            var exampleReservedIp = new ReservedIp("exampleReservedIp", ReservedIpArgs.builder()
                .dropletId(example.id())
                .region(example.region())
                .build());
    
        }
    }
    
    resources:
      example:
        type: digitalocean:Droplet
        properties:
          name: example
          size: s-1vcpu-1gb
          image: ubuntu-22-04-x64
          region: nyc3
          ipv6: true
          privateNetworking: true
      exampleReservedIp:
        type: digitalocean:ReservedIp
        name: example
        properties:
          dropletId: ${example.id}
          region: ${example.region}
    

    Create ReservedIp Resource

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

    Constructor syntax

    new ReservedIp(name: string, args: ReservedIpArgs, opts?: CustomResourceOptions);
    @overload
    def ReservedIp(resource_name: str,
                   args: ReservedIpArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ReservedIp(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   region: Optional[str] = None,
                   droplet_id: Optional[int] = None,
                   ip_address: Optional[str] = None)
    func NewReservedIp(ctx *Context, name string, args ReservedIpArgs, opts ...ResourceOption) (*ReservedIp, error)
    public ReservedIp(string name, ReservedIpArgs args, CustomResourceOptions? opts = null)
    public ReservedIp(String name, ReservedIpArgs args)
    public ReservedIp(String name, ReservedIpArgs args, CustomResourceOptions options)
    
    type: digitalocean:ReservedIp
    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 ReservedIpArgs
    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 ReservedIpArgs
    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 ReservedIpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReservedIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReservedIpArgs
    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 reservedIpResource = new DigitalOcean.ReservedIp("reservedIpResource", new()
    {
        Region = "string",
        DropletId = 0,
        IpAddress = "string",
    });
    
    example, err := digitalocean.NewReservedIp(ctx, "reservedIpResource", &digitalocean.ReservedIpArgs{
    	Region:    pulumi.String("string"),
    	DropletId: pulumi.Int(0),
    	IpAddress: pulumi.String("string"),
    })
    
    var reservedIpResource = new ReservedIp("reservedIpResource", ReservedIpArgs.builder()
        .region("string")
        .dropletId(0)
        .ipAddress("string")
        .build());
    
    reserved_ip_resource = digitalocean.ReservedIp("reservedIpResource",
        region="string",
        droplet_id=0,
        ip_address="string")
    
    const reservedIpResource = new digitalocean.ReservedIp("reservedIpResource", {
        region: "string",
        dropletId: 0,
        ipAddress: "string",
    });
    
    type: digitalocean:ReservedIp
    properties:
        dropletId: 0
        ipAddress: string
        region: string
    

    ReservedIp 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 ReservedIp resource accepts the following input properties:

    Region string
    The region that the reserved IP is reserved to.
    DropletId int
    The ID of Droplet that the reserved IP will be assigned to.
    IpAddress string
    The IP Address of the resource
    Region string
    The region that the reserved IP is reserved to.
    DropletId int
    The ID of Droplet that the reserved IP will be assigned to.
    IpAddress string
    The IP Address of the resource
    region String
    The region that the reserved IP is reserved to.
    dropletId Integer
    The ID of Droplet that the reserved IP will be assigned to.
    ipAddress String
    The IP Address of the resource
    region string
    The region that the reserved IP is reserved to.
    dropletId number
    The ID of Droplet that the reserved IP will be assigned to.
    ipAddress string
    The IP Address of the resource
    region str
    The region that the reserved IP is reserved to.
    droplet_id int
    The ID of Droplet that the reserved IP will be assigned to.
    ip_address str
    The IP Address of the resource
    region String
    The region that the reserved IP is reserved to.
    dropletId Number
    The ID of Droplet that the reserved IP will be assigned to.
    ipAddress String
    The IP Address of the resource

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ReservedIpUrn string
    The uniform resource name of the reserved ip
    Id string
    The provider-assigned unique ID for this managed resource.
    ReservedIpUrn string
    The uniform resource name of the reserved ip
    id String
    The provider-assigned unique ID for this managed resource.
    reservedIpUrn String
    The uniform resource name of the reserved ip
    id string
    The provider-assigned unique ID for this managed resource.
    reservedIpUrn string
    The uniform resource name of the reserved ip
    id str
    The provider-assigned unique ID for this managed resource.
    reserved_ip_urn str
    The uniform resource name of the reserved ip
    id String
    The provider-assigned unique ID for this managed resource.
    reservedIpUrn String
    The uniform resource name of the reserved ip

    Look up Existing ReservedIp Resource

    Get an existing ReservedIp 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?: ReservedIpState, opts?: CustomResourceOptions): ReservedIp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            droplet_id: Optional[int] = None,
            ip_address: Optional[str] = None,
            region: Optional[str] = None,
            reserved_ip_urn: Optional[str] = None) -> ReservedIp
    func GetReservedIp(ctx *Context, name string, id IDInput, state *ReservedIpState, opts ...ResourceOption) (*ReservedIp, error)
    public static ReservedIp Get(string name, Input<string> id, ReservedIpState? state, CustomResourceOptions? opts = null)
    public static ReservedIp get(String name, Output<String> id, ReservedIpState 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:
    DropletId int
    The ID of Droplet that the reserved IP will be assigned to.
    IpAddress string
    The IP Address of the resource
    Region string
    The region that the reserved IP is reserved to.
    ReservedIpUrn string
    The uniform resource name of the reserved ip
    DropletId int
    The ID of Droplet that the reserved IP will be assigned to.
    IpAddress string
    The IP Address of the resource
    Region string
    The region that the reserved IP is reserved to.
    ReservedIpUrn string
    The uniform resource name of the reserved ip
    dropletId Integer
    The ID of Droplet that the reserved IP will be assigned to.
    ipAddress String
    The IP Address of the resource
    region String
    The region that the reserved IP is reserved to.
    reservedIpUrn String
    The uniform resource name of the reserved ip
    dropletId number
    The ID of Droplet that the reserved IP will be assigned to.
    ipAddress string
    The IP Address of the resource
    region string
    The region that the reserved IP is reserved to.
    reservedIpUrn string
    The uniform resource name of the reserved ip
    droplet_id int
    The ID of Droplet that the reserved IP will be assigned to.
    ip_address str
    The IP Address of the resource
    region str
    The region that the reserved IP is reserved to.
    reserved_ip_urn str
    The uniform resource name of the reserved ip
    dropletId Number
    The ID of Droplet that the reserved IP will be assigned to.
    ipAddress String
    The IP Address of the resource
    region String
    The region that the reserved IP is reserved to.
    reservedIpUrn String
    The uniform resource name of the reserved ip

    Import

    Reserved IPs can be imported using the ip, e.g.

    $ pulumi import digitalocean:index/reservedIp:ReservedIp myip 192.168.0.1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.30.2 published on Wednesday, Jun 5, 2024 by Pulumi