Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Civo Provider
  3. API Docs
  4. ReservedIp
civo 1.1.5 published on Thursday, Feb 6, 2025 by civo
civo/terraform-provider-civo

civo.ReservedIp

Explore with Pulumi AI

civo logo
civo 1.1.5 published on Thursday, Feb 6, 2025 by civo
civo/terraform-provider-civo

    Provides a Civo reserved IP to represent a publicly-accessible static IP addresses that can be mapped to one of your Instancesor Load Balancer.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as civo from "@pulumi/civo";

const www = new civo.ReservedIp("www", {});

    import pulumi
import pulumi_civo as civo

www = civo.ReservedIp("www")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/civo/civo"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := civo.NewReservedIp(ctx, "www", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Civo = Pulumi.Civo;

return await Deployment.RunAsync(() => 
{
    var www = new Civo.ReservedIp("www");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.civo.ReservedIp;
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 www = new ReservedIp("www");

    }
}

    resources:
  www:
    type: civo:ReservedIp

    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: Optional[ReservedIpArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def ReservedIp(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               name: Optional[str] = None,
               region: Optional[str] = None,
               reserved_ip_id: Optional[str] = None)
    func NewReservedIp(ctx *Context, name string, args *ReservedIpArgs, opts ...ResourceOption) (*ReservedIp, error)
    public ReservedIp(string name, ReservedIpArgs? args = null, CustomResourceOptions? opts = null)
    public ReservedIp(String name, ReservedIpArgs args)
public ReservedIp(String name, ReservedIpArgs args, CustomResourceOptions options)

    type: civo: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.

    Constructor example

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

    var reservedIpResource = new Civo.ReservedIp("reservedIpResource", new()
{
    Name = "string",
    Region = "string",
    ReservedIpId = "string",
});

    example, err := civo.NewReservedIp(ctx, "reservedIpResource", &civo.ReservedIpArgs{
	Name:         pulumi.String("string"),
	Region:       pulumi.String("string"),
	ReservedIpId: pulumi.String("string"),
})

    var reservedIpResource = new ReservedIp("reservedIpResource", ReservedIpArgs.builder()
    .name("string")
    .region("string")
    .reservedIpId("string")
    .build());

    reserved_ip_resource = civo.ReservedIp("reservedIpResource",
    name="string",
    region="string",
    reserved_ip_id="string")

    const reservedIpResource = new civo.ReservedIp("reservedIpResource", {
    name: "string",
    region: "string",
    reservedIpId: "string",
});

    type: civo:ReservedIp
properties:
    name: string
    region: string
    reservedIpId: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ReservedIp resource accepts the following input properties:

    Name string
    Name for the ip address
    Region string
    The region of the ip
    ReservedIpId string
    The ID of this resource.
    Name string
    Name for the ip address
    Region string
    The region of the ip
    ReservedIpId string
    The ID of this resource.
    name String
    Name for the ip address
    region String
    The region of the ip
    reservedIpId String
    The ID of this resource.
    name string
    Name for the ip address
    region string
    The region of the ip
    reservedIpId string
    The ID of this resource.
    name str
    Name for the ip address
    region str
    The region of the ip
    reserved_ip_id str
    The ID of this resource.
    name String
    Name for the ip address
    region String
    The region of the ip
    reservedIpId String
    The ID of this 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.
    Ip string
    The IP Address of the resource
    Id string
    The provider-assigned unique ID for this managed resource.
    Ip string
    The IP Address of the resource
    id String
    The provider-assigned unique ID for this managed resource.
    ip String
    The IP Address of the resource
    id string
    The provider-assigned unique ID for this managed resource.
    ip string
    The IP Address of the resource
    id str
    The provider-assigned unique ID for this managed resource.
    ip str
    The IP Address of the resource
    id String
    The provider-assigned unique ID for this managed resource.
    ip String
    The IP Address of the resource

    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,
        ip: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        reserved_ip_id: 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)
    resources:  _:    type: civo:ReservedIp    get:      id: ${id}
    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:
    Ip string
    The IP Address of the resource
    Name string
    Name for the ip address
    Region string
    The region of the ip
    ReservedIpId string
    The ID of this resource.
    Ip string
    The IP Address of the resource
    Name string
    Name for the ip address
    Region string
    The region of the ip
    ReservedIpId string
    The ID of this resource.
    ip String
    The IP Address of the resource
    name String
    Name for the ip address
    region String
    The region of the ip
    reservedIpId String
    The ID of this resource.
    ip string
    The IP Address of the resource
    name string
    Name for the ip address
    region string
    The region of the ip
    reservedIpId string
    The ID of this resource.
    ip str
    The IP Address of the resource
    name str
    Name for the ip address
    region str
    The region of the ip
    reserved_ip_id str
    The ID of this resource.
    ip String
    The IP Address of the resource
    name String
    Name for the ip address
    region String
    The region of the ip
    reservedIpId String
    The ID of this resource.

    Import

    terrafom import civo_reserved_ip.www 9f0e86fc-b2c6-46b4-82ed-2f28419f8ae3

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

    Package Details

    Repository
    Civo civo/terraform-provider-civo
    License
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    civo 1.1.5 published on Thursday, Feb 6, 2025 by civo
    civo/terraform-provider-civo