Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. FailoverIpAttach
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProject.FailoverIpAttach

Explore with Pulumi AI

OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

Attaches a failover IP address to a compute instance

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const myFailoverIp = new ovh.cloudproject.FailoverIpAttach("myFailoverIp", {
    ip: "XXXXXX",
    routedTo: "XXXXXX",
    serviceName: "XXXXXX",
});
Copy
import pulumi
import pulumi_ovh as ovh

my_failover_ip = ovh.cloud_project.FailoverIpAttach("myFailoverIp",
    ip="XXXXXX",
    routed_to="XXXXXX",
    service_name="XXXXXX")
Copy
package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/cloudproject"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudproject.NewFailoverIpAttach(ctx, "myFailoverIp", &cloudproject.FailoverIpAttachArgs{
			Ip:          pulumi.String("XXXXXX"),
			RoutedTo:    pulumi.String("XXXXXX"),
			ServiceName: pulumi.String("XXXXXX"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var myFailoverIp = new Ovh.CloudProject.FailoverIpAttach("myFailoverIp", new()
    {
        Ip = "XXXXXX",
        RoutedTo = "XXXXXX",
        ServiceName = "XXXXXX",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.ovhcloud.pulumi.ovh.CloudProject.FailoverIpAttach;
import com.ovhcloud.pulumi.ovh.CloudProject.FailoverIpAttachArgs;
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 myFailoverIp = new FailoverIpAttach("myFailoverIp", FailoverIpAttachArgs.builder()
            .ip("XXXXXX")
            .routedTo("XXXXXX")
            .serviceName("XXXXXX")
            .build());

    }
}
Copy
resources:
  myFailoverIp:
    type: ovh:CloudProject:FailoverIpAttach
    properties:
      ip: XXXXXX
      routedTo: XXXXXX
      serviceName: XXXXXX
Copy

Create FailoverIpAttach Resource

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

Constructor syntax

new FailoverIpAttach(name: string, args: FailoverIpAttachArgs, opts?: CustomResourceOptions);
@overload
def FailoverIpAttach(resource_name: str,
                     args: FailoverIpAttachArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def FailoverIpAttach(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     service_name: Optional[str] = None,
                     block: Optional[str] = None,
                     continent_code: Optional[str] = None,
                     geo_loc: Optional[str] = None,
                     ip: Optional[str] = None,
                     routed_to: Optional[str] = None)
func NewFailoverIpAttach(ctx *Context, name string, args FailoverIpAttachArgs, opts ...ResourceOption) (*FailoverIpAttach, error)
public FailoverIpAttach(string name, FailoverIpAttachArgs args, CustomResourceOptions? opts = null)
public FailoverIpAttach(String name, FailoverIpAttachArgs args)
public FailoverIpAttach(String name, FailoverIpAttachArgs args, CustomResourceOptions options)

type: ovh:CloudProject:FailoverIpAttach
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FailoverIpAttachArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FailoverIpAttachArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FailoverIpAttachArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FailoverIpAttachArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FailoverIpAttachArgs
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 failoverIpAttachResource = new Ovh.CloudProject.FailoverIpAttach("failoverIpAttachResource", new()
{
    ServiceName = "string",
    Block = "string",
    ContinentCode = "string",
    GeoLoc = "string",
    Ip = "string",
    RoutedTo = "string",
});
Copy
example, err := CloudProject.NewFailoverIpAttach(ctx, "failoverIpAttachResource", &CloudProject.FailoverIpAttachArgs{
	ServiceName:   pulumi.String("string"),
	Block:         pulumi.String("string"),
	ContinentCode: pulumi.String("string"),
	GeoLoc:        pulumi.String("string"),
	Ip:            pulumi.String("string"),
	RoutedTo:      pulumi.String("string"),
})
Copy
var failoverIpAttachResource = new FailoverIpAttach("failoverIpAttachResource", FailoverIpAttachArgs.builder()
    .serviceName("string")
    .block("string")
    .continentCode("string")
    .geoLoc("string")
    .ip("string")
    .routedTo("string")
    .build());
Copy
failover_ip_attach_resource = ovh.cloud_project.FailoverIpAttach("failoverIpAttachResource",
    service_name="string",
    block="string",
    continent_code="string",
    geo_loc="string",
    ip="string",
    routed_to="string")
Copy
const failoverIpAttachResource = new ovh.cloudproject.FailoverIpAttach("failoverIpAttachResource", {
    serviceName: "string",
    block: "string",
    continentCode: "string",
    geoLoc: "string",
    ip: "string",
    routedTo: "string",
});
Copy
type: ovh:CloudProject:FailoverIpAttach
properties:
    block: string
    continentCode: string
    geoLoc: string
    ip: string
    routedTo: string
    serviceName: string
Copy

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

ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
Block string
The IP block

  • continentCode - The Ip continent
ContinentCode string
Ip continent
GeoLoc string
Ip location
Ip string
The failover ip address to attach
RoutedTo Changes to this property will trigger replacement. string
The GUID of an instance to which the failover IP address is be attached
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
Block string
The IP block

  • continentCode - The Ip continent
ContinentCode string
Ip continent
GeoLoc string
Ip location
Ip string
The failover ip address to attach
RoutedTo Changes to this property will trigger replacement. string
The GUID of an instance to which the failover IP address is be attached
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
block String
The IP block

  • continentCode - The Ip continent
continentCode String
Ip continent
geoLoc String
Ip location
ip String
The failover ip address to attach
routedTo Changes to this property will trigger replacement. String
The GUID of an instance to which the failover IP address is be attached
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
block string
The IP block

  • continentCode - The Ip continent
continentCode string
Ip continent
geoLoc string
Ip location
ip string
The failover ip address to attach
routedTo Changes to this property will trigger replacement. string
The GUID of an instance to which the failover IP address is be attached
service_name
This property is required.
Changes to this property will trigger replacement.
str
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
block str
The IP block

  • continentCode - The Ip continent
continent_code str
Ip continent
geo_loc str
Ip location
ip str
The failover ip address to attach
routed_to Changes to this property will trigger replacement. str
The GUID of an instance to which the failover IP address is be attached
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
block String
The IP block

  • continentCode - The Ip continent
continentCode String
Ip continent
geoLoc String
Ip location
ip String
The failover ip address to attach
routedTo Changes to this property will trigger replacement. String
The GUID of an instance to which the failover IP address is be attached

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Progress int
Current operation progress in percent

  • routedTo - Instance where ip is routed to
Status string
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
SubType string
IP sub type
Id string
The provider-assigned unique ID for this managed resource.
Progress int
Current operation progress in percent

  • routedTo - Instance where ip is routed to
Status string
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
SubType string
IP sub type
id String
The provider-assigned unique ID for this managed resource.
progress Integer
Current operation progress in percent

  • routedTo - Instance where ip is routed to
status String
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
subType String
IP sub type
id string
The provider-assigned unique ID for this managed resource.
progress number
Current operation progress in percent

  • routedTo - Instance where ip is routed to
status string
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
subType string
IP sub type
id str
The provider-assigned unique ID for this managed resource.
progress int
Current operation progress in percent

  • routedTo - Instance where ip is routed to
status str
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
sub_type str
IP sub type
id String
The provider-assigned unique ID for this managed resource.
progress Number
Current operation progress in percent

  • routedTo - Instance where ip is routed to
status String
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
subType String
IP sub type

Look up Existing FailoverIpAttach Resource

Get an existing FailoverIpAttach 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?: FailoverIpAttachState, opts?: CustomResourceOptions): FailoverIpAttach
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        block: Optional[str] = None,
        continent_code: Optional[str] = None,
        geo_loc: Optional[str] = None,
        ip: Optional[str] = None,
        progress: Optional[int] = None,
        routed_to: Optional[str] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None,
        sub_type: Optional[str] = None) -> FailoverIpAttach
func GetFailoverIpAttach(ctx *Context, name string, id IDInput, state *FailoverIpAttachState, opts ...ResourceOption) (*FailoverIpAttach, error)
public static FailoverIpAttach Get(string name, Input<string> id, FailoverIpAttachState? state, CustomResourceOptions? opts = null)
public static FailoverIpAttach get(String name, Output<String> id, FailoverIpAttachState state, CustomResourceOptions options)
resources:  _:    type: ovh:CloudProject:FailoverIpAttach    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Block string
The IP block

  • continentCode - The Ip continent
ContinentCode string
Ip continent
GeoLoc string
Ip location
Ip string
The failover ip address to attach
Progress int
Current operation progress in percent

  • routedTo - Instance where ip is routed to
RoutedTo Changes to this property will trigger replacement. string
The GUID of an instance to which the failover IP address is be attached
ServiceName Changes to this property will trigger replacement. string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
Status string
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
SubType string
IP sub type
Block string
The IP block

  • continentCode - The Ip continent
ContinentCode string
Ip continent
GeoLoc string
Ip location
Ip string
The failover ip address to attach
Progress int
Current operation progress in percent

  • routedTo - Instance where ip is routed to
RoutedTo Changes to this property will trigger replacement. string
The GUID of an instance to which the failover IP address is be attached
ServiceName Changes to this property will trigger replacement. string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
Status string
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
SubType string
IP sub type
block String
The IP block

  • continentCode - The Ip continent
continentCode String
Ip continent
geoLoc String
Ip location
ip String
The failover ip address to attach
progress Integer
Current operation progress in percent

  • routedTo - Instance where ip is routed to
routedTo Changes to this property will trigger replacement. String
The GUID of an instance to which the failover IP address is be attached
serviceName Changes to this property will trigger replacement. String
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
status String
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
subType String
IP sub type
block string
The IP block

  • continentCode - The Ip continent
continentCode string
Ip continent
geoLoc string
Ip location
ip string
The failover ip address to attach
progress number
Current operation progress in percent

  • routedTo - Instance where ip is routed to
routedTo Changes to this property will trigger replacement. string
The GUID of an instance to which the failover IP address is be attached
serviceName Changes to this property will trigger replacement. string
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
status string
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
subType string
IP sub type
block str
The IP block

  • continentCode - The Ip continent
continent_code str
Ip continent
geo_loc str
Ip location
ip str
The failover ip address to attach
progress int
Current operation progress in percent

  • routedTo - Instance where ip is routed to
routed_to Changes to this property will trigger replacement. str
The GUID of an instance to which the failover IP address is be attached
service_name Changes to this property will trigger replacement. str
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
status str
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
sub_type str
IP sub type
block String
The IP block

  • continentCode - The Ip continent
continentCode String
Ip continent
geoLoc String
Ip location
ip String
The failover ip address to attach
progress Number
Current operation progress in percent

  • routedTo - Instance where ip is routed to
routedTo Changes to this property will trigger replacement. String
The GUID of an instance to which the failover IP address is be attached
serviceName Changes to this property will trigger replacement. String
The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
status String
Ip status, can be ok or operationPending

  • subType - IP sub type, can be cloud or ovh
subType String
IP sub type

Package Details

Repository
ovh ovh/pulumi-ovh
License
Apache-2.0
Notes
This Pulumi package is based on the ovh Terraform Provider.
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh