Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsFloatingIp
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsFloatingIp

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create a floating IP address that you can associate with a Virtual Servers for VPC instance. You can use the floating IP address to access your instance from the public network, independent of whether the subnet is attached to a public gateway. For more information, see about floating IP.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

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

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Example Usage

    The following example shows how to create a Virtual Servers for VPC instance and associate a floating IP address to the primary network interface of the virtual server instance.

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

const exampleIsInstance = new ibm.IsInstance("exampleIsInstance", {
    image: ibm_is_image.example.id,
    profile: "bx2-2x8",
    primaryNetworkInterface: {
        subnet: ibm_is_subnet.example.id,
    },
    vpc: ibm_is_vpc.example.id,
    zone: "us-south-1",
    keys: [ibm_is_ssh_key.example.id],
});
const exampleIsFloatingIp = new ibm.IsFloatingIp("exampleIsFloatingIp", {target: exampleIsInstance.primaryNetworkInterface.apply(primaryNetworkInterface => primaryNetworkInterface?.id)});

    import pulumi
import pulumi_ibm as ibm

example_is_instance = ibm.IsInstance("exampleIsInstance",
    image=ibm_is_image["example"]["id"],
    profile="bx2-2x8",
    primary_network_interface={
        "subnet": ibm_is_subnet["example"]["id"],
    },
    vpc=ibm_is_vpc["example"]["id"],
    zone="us-south-1",
    keys=[ibm_is_ssh_key["example"]["id"]])
example_is_floating_ip = ibm.IsFloatingIp("exampleIsFloatingIp", target=example_is_instance.primary_network_interface.id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleIsInstance, err := ibm.NewIsInstance(ctx, "exampleIsInstance", &ibm.IsInstanceArgs{
			Image:   pulumi.Any(ibm_is_image.Example.Id),
			Profile: pulumi.String("bx2-2x8"),
			PrimaryNetworkInterface: &ibm.IsInstancePrimaryNetworkInterfaceArgs{
				Subnet: pulumi.Any(ibm_is_subnet.Example.Id),
			},
			Vpc:  pulumi.Any(ibm_is_vpc.Example.Id),
			Zone: pulumi.String("us-south-1"),
			Keys: pulumi.StringArray{
				ibm_is_ssh_key.Example.Id,
			},
		})
		if err != nil {
			return err
		}
		_, err = ibm.NewIsFloatingIp(ctx, "exampleIsFloatingIp", &ibm.IsFloatingIpArgs{
			Target: pulumi.String(exampleIsInstance.PrimaryNetworkInterface.ApplyT(func(primaryNetworkInterface ibm.IsInstancePrimaryNetworkInterface) (*string, error) {
				return &primaryNetworkInterface.Id, nil
			}).(pulumi.StringPtrOutput)),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleIsInstance = new Ibm.IsInstance("exampleIsInstance", new()
    {
        Image = ibm_is_image.Example.Id,
        Profile = "bx2-2x8",
        PrimaryNetworkInterface = new Ibm.Inputs.IsInstancePrimaryNetworkInterfaceArgs
        {
            Subnet = ibm_is_subnet.Example.Id,
        },
        Vpc = ibm_is_vpc.Example.Id,
        Zone = "us-south-1",
        Keys = new[]
        {
            ibm_is_ssh_key.Example.Id,
        },
    });

    var exampleIsFloatingIp = new Ibm.IsFloatingIp("exampleIsFloatingIp", new()
    {
        Target = exampleIsInstance.PrimaryNetworkInterface.Apply(primaryNetworkInterface => primaryNetworkInterface?.Id),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsInstance;
import com.pulumi.ibm.IsInstanceArgs;
import com.pulumi.ibm.inputs.IsInstancePrimaryNetworkInterfaceArgs;
import com.pulumi.ibm.IsFloatingIp;
import com.pulumi.ibm.IsFloatingIpArgs;
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 exampleIsInstance = new IsInstance("exampleIsInstance", IsInstanceArgs.builder()
            .image(ibm_is_image.example().id())
            .profile("bx2-2x8")
            .primaryNetworkInterface(IsInstancePrimaryNetworkInterfaceArgs.builder()
                .subnet(ibm_is_subnet.example().id())
                .build())
            .vpc(ibm_is_vpc.example().id())
            .zone("us-south-1")
            .keys(ibm_is_ssh_key.example().id())
            .build());

        var exampleIsFloatingIp = new IsFloatingIp("exampleIsFloatingIp", IsFloatingIpArgs.builder()
            .target(exampleIsInstance.primaryNetworkInterface().applyValue(primaryNetworkInterface -> primaryNetworkInterface.id()))
            .build());

    }
}

    resources:
  exampleIsInstance:
    type: ibm:IsInstance
    properties:
      image: ${ibm_is_image.example.id}
      profile: bx2-2x8
      primaryNetworkInterface:
        subnet: ${ibm_is_subnet.example.id}
      vpc: ${ibm_is_vpc.example.id}
      zone: us-south-1
      keys:
        - ${ibm_is_ssh_key.example.id}
  exampleIsFloatingIp:
    type: ibm:IsFloatingIp
    properties:
      target: ${exampleIsInstance.primaryNetworkInterface.id}

    Note: To access the instance using floating ip, make sure the target security group has the respective inbound rule

    Create IsFloatingIp Resource

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

    Constructor syntax

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

@overload
def IsFloatingIp(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 access_tags: Optional[Sequence[str]] = None,
                 is_floating_ip_id: Optional[str] = None,
                 name: Optional[str] = None,
                 resource_group: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None,
                 target: Optional[str] = None,
                 timeouts: Optional[IsFloatingIpTimeoutsArgs] = None,
                 zone: Optional[str] = None)
    func NewIsFloatingIp(ctx *Context, name string, args *IsFloatingIpArgs, opts ...ResourceOption) (*IsFloatingIp, error)
    public IsFloatingIp(string name, IsFloatingIpArgs? args = null, CustomResourceOptions? opts = null)
    public IsFloatingIp(String name, IsFloatingIpArgs args)
public IsFloatingIp(String name, IsFloatingIpArgs args, CustomResourceOptions options)

    type: ibm:IsFloatingIp
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 IsFloatingIpArgs
    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 IsFloatingIpArgs
    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 IsFloatingIpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsFloatingIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsFloatingIpArgs
    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 isFloatingIpResource = new Ibm.IsFloatingIp("isFloatingIpResource", new()
{
    AccessTags = new[]
    {
        "string",
    },
    IsFloatingIpId = "string",
    Name = "string",
    ResourceGroup = "string",
    Tags = new[]
    {
        "string",
    },
    Target = "string",
    Timeouts = new Ibm.Inputs.IsFloatingIpTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    Zone = "string",
});

    example, err := ibm.NewIsFloatingIp(ctx, "isFloatingIpResource", &ibm.IsFloatingIpArgs{
	AccessTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsFloatingIpId: pulumi.String("string"),
	Name:           pulumi.String("string"),
	ResourceGroup:  pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Target: pulumi.String("string"),
	Timeouts: &ibm.IsFloatingIpTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
})

    var isFloatingIpResource = new IsFloatingIp("isFloatingIpResource", IsFloatingIpArgs.builder()
    .accessTags("string")
    .isFloatingIpId("string")
    .name("string")
    .resourceGroup("string")
    .tags("string")
    .target("string")
    .timeouts(IsFloatingIpTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .zone("string")
    .build());

    is_floating_ip_resource = ibm.IsFloatingIp("isFloatingIpResource",
    access_tags=["string"],
    is_floating_ip_id="string",
    name="string",
    resource_group="string",
    tags=["string"],
    target="string",
    timeouts={
        "create": "string",
        "delete": "string",
    },
    zone="string")

    const isFloatingIpResource = new ibm.IsFloatingIp("isFloatingIpResource", {
    accessTags: ["string"],
    isFloatingIpId: "string",
    name: "string",
    resourceGroup: "string",
    tags: ["string"],
    target: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
    zone: "string",
});

    type: ibm:IsFloatingIp
properties:
    accessTags:
        - string
    isFloatingIpId: string
    name: string
    resourceGroup: string
    tags:
        - string
    target: string
    timeouts:
        create: string
        delete: string
    zone: string

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

    AccessTags List<string>

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    IsFloatingIpId string
    (String) The unique identifier for this target.
    Name string
    Enter a name for the floating IP address.
    ResourceGroup string
    The resource group ID where you want to create the floating IP.
    Tags List<string>
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    Target string

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    Timeouts IsFloatingIpTimeouts
    Zone string

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    AccessTags []string

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    IsFloatingIpId string
    (String) The unique identifier for this target.
    Name string
    Enter a name for the floating IP address.
    ResourceGroup string
    The resource group ID where you want to create the floating IP.
    Tags []string
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    Target string

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    Timeouts IsFloatingIpTimeoutsArgs
    Zone string

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    accessTags List<String>

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    isFloatingIpId String
    (String) The unique identifier for this target.
    name String
    Enter a name for the floating IP address.
    resourceGroup String
    The resource group ID where you want to create the floating IP.
    tags List<String>
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    target String

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    timeouts IsFloatingIpTimeouts
    zone String

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    accessTags string[]

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    isFloatingIpId string
    (String) The unique identifier for this target.
    name string
    Enter a name for the floating IP address.
    resourceGroup string
    The resource group ID where you want to create the floating IP.
    tags string[]
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    target string

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    timeouts IsFloatingIpTimeouts
    zone string

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    access_tags Sequence[str]

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    is_floating_ip_id str
    (String) The unique identifier for this target.
    name str
    Enter a name for the floating IP address.
    resource_group str
    The resource group ID where you want to create the floating IP.
    tags Sequence[str]
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    target str

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    timeouts IsFloatingIpTimeoutsArgs
    zone str

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    accessTags List<String>

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    isFloatingIpId String
    (String) The unique identifier for this target.
    name String
    Enter a name for the floating IP address.
    resourceGroup String
    The resource group ID where you want to create the floating IP.
    tags List<String>
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    target String

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    timeouts Property Map
    zone String

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    Outputs

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

    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Crn string
    (String) The CRN if target is a public gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The provisioning status of the floating IP address.
    TargetLists List<IsFloatingIpTargetList>
    (List) The target of this floating IP. Nested scheme for target_list:
    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Crn string
    (String) The CRN if target is a public gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The provisioning status of the floating IP address.
    TargetLists []IsFloatingIpTargetList
    (List) The target of this floating IP. Nested scheme for target_list:
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    crn String
    (String) The CRN if target is a public gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The provisioning status of the floating IP address.
    targetLists List<IsFloatingIpTargetList>
    (List) The target of this floating IP. Nested scheme for target_list:
    address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    crn string
    (String) The CRN if target is a public gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn string
    The crn of the resource
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    status string
    (String) The provisioning status of the floating IP address.
    targetLists IsFloatingIpTargetList[]
    (List) The target of this floating IP. Nested scheme for target_list:
    address str
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    crn str
    (String) The CRN if target is a public gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resource_crn str
    The crn of the resource
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    status str
    (String) The provisioning status of the floating IP address.
    target_lists Sequence[IsFloatingIpTargetList]
    (List) The target of this floating IP. Nested scheme for target_list:
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    crn String
    (String) The CRN if target is a public gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The provisioning status of the floating IP address.
    targetLists List<Property Map>
    (List) The target of this floating IP. Nested scheme for target_list:

    Look up Existing IsFloatingIp Resource

    Get an existing IsFloatingIp 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?: IsFloatingIpState, opts?: CustomResourceOptions): IsFloatingIp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        address: Optional[str] = None,
        crn: Optional[str] = None,
        is_floating_ip_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target: Optional[str] = None,
        target_lists: Optional[Sequence[IsFloatingIpTargetListArgs]] = None,
        timeouts: Optional[IsFloatingIpTimeoutsArgs] = None,
        zone: Optional[str] = None) -> IsFloatingIp
    func GetIsFloatingIp(ctx *Context, name string, id IDInput, state *IsFloatingIpState, opts ...ResourceOption) (*IsFloatingIp, error)
    public static IsFloatingIp Get(string name, Input<string> id, IsFloatingIpState? state, CustomResourceOptions? opts = null)
    public static IsFloatingIp get(String name, Output<String> id, IsFloatingIpState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsFloatingIp    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:
    AccessTags List<string>

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Crn string
    (String) The CRN if target is a public gateway.
    IsFloatingIpId string
    (String) The unique identifier for this target.
    Name string
    Enter a name for the floating IP address.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroup string
    The resource group ID where you want to create the floating IP.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The provisioning status of the floating IP address.
    Tags List<string>
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    Target string

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    TargetLists List<IsFloatingIpTargetList>
    (List) The target of this floating IP. Nested scheme for target_list:
    Timeouts IsFloatingIpTimeouts
    Zone string

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    AccessTags []string

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Crn string
    (String) The CRN if target is a public gateway.
    IsFloatingIpId string
    (String) The unique identifier for this target.
    Name string
    Enter a name for the floating IP address.
    ResourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    ResourceCrn string
    The crn of the resource
    ResourceGroup string
    The resource group ID where you want to create the floating IP.
    ResourceGroupName string
    The resource group name in which resource is provisioned
    ResourceName string
    The name of the resource
    ResourceStatus string
    The status of the resource
    Status string
    (String) The provisioning status of the floating IP address.
    Tags []string
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    Target string

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    TargetLists []IsFloatingIpTargetListArgs
    (List) The target of this floating IP. Nested scheme for target_list:
    Timeouts IsFloatingIpTimeoutsArgs
    Zone string

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    accessTags List<String>

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    crn String
    (String) The CRN if target is a public gateway.
    isFloatingIpId String
    (String) The unique identifier for this target.
    name String
    Enter a name for the floating IP address.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroup String
    The resource group ID where you want to create the floating IP.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The provisioning status of the floating IP address.
    tags List<String>
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    target String

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    targetLists List<IsFloatingIpTargetList>
    (List) The target of this floating IP. Nested scheme for target_list:
    timeouts IsFloatingIpTimeouts
    zone String

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    accessTags string[]

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    crn string
    (String) The CRN if target is a public gateway.
    isFloatingIpId string
    (String) The unique identifier for this target.
    name string
    Enter a name for the floating IP address.
    resourceControllerUrl string
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn string
    The crn of the resource
    resourceGroup string
    The resource group ID where you want to create the floating IP.
    resourceGroupName string
    The resource group name in which resource is provisioned
    resourceName string
    The name of the resource
    resourceStatus string
    The status of the resource
    status string
    (String) The provisioning status of the floating IP address.
    tags string[]
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    target string

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    targetLists IsFloatingIpTargetList[]
    (List) The target of this floating IP. Nested scheme for target_list:
    timeouts IsFloatingIpTimeouts
    zone string

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    access_tags Sequence[str]

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    address str
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    crn str
    (String) The CRN if target is a public gateway.
    is_floating_ip_id str
    (String) The unique identifier for this target.
    name str
    Enter a name for the floating IP address.
    resource_controller_url str
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resource_crn str
    The crn of the resource
    resource_group str
    The resource group ID where you want to create the floating IP.
    resource_group_name str
    The resource group name in which resource is provisioned
    resource_name str
    The name of the resource
    resource_status str
    The status of the resource
    status str
    (String) The provisioning status of the floating IP address.
    tags Sequence[str]
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    target str

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    target_lists Sequence[IsFloatingIpTargetListArgs]
    (List) The target of this floating IP. Nested scheme for target_list:
    timeouts IsFloatingIpTimeoutsArgs
    zone str

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    accessTags List<String>

    A list of access management tags to attach to the floating ip.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    crn String
    (String) The CRN if target is a public gateway.
    isFloatingIpId String
    (String) The unique identifier for this target.
    name String
    Enter a name for the floating IP address.
    resourceControllerUrl String
    The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
    resourceCrn String
    The crn of the resource
    resourceGroup String
    The resource group ID where you want to create the floating IP.
    resourceGroupName String
    The resource group name in which resource is provisioned
    resourceName String
    The name of the resource
    resourceStatus String
    The status of the resource
    status String
    (String) The provisioning status of the floating IP address.
    tags List<String>
    Enter any tags that you want to associate with your VPC. Tags might help you find your VPC more easily after it is created. Separate multiple tags with a comma (,).
    target String

    Enter the ID of the network interface that you want to use to allocate the IP address. If you specify this option, do not specify zone at the same time.

    Note: target conflicts with zone. A change in target which is in a different zone will show a change to replace current floating ip with a new one.

    targetLists List<Property Map>
    (List) The target of this floating IP. Nested scheme for target_list:
    timeouts Property Map
    zone String

    Enter the name of the zone where you want to create the floating IP address. To list available zones, run ibmcloud is zones. If you specify this option, do not specify target at the same time.

    Note: Conflicts with target and one of target, or zone is mandatory.

    Note target cannot be used in conjunction with the floating_ip argument of ibm.IsInstanceNetworkInterface resource and might cause cyclic dependency/unexpected issues if used used both ways.

    Supporting Types

    IsFloatingIpTargetList, IsFloatingIpTargetListArgs

    Crn string
    (String) The CRN if target is a public gateway.
    Deleteds List<IsFloatingIpTargetListDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this reserved IP
    Id string
    (String) The unique identifier for this target.
    Name string
    Enter a name for the floating IP address.
    PrimaryIps List<IsFloatingIpTargetListPrimaryIp>
    (List) The reserved ip reference.
    ResourceType string
    (String) The resource type.
    Crn string
    (String) The CRN if target is a public gateway.
    Deleteds []IsFloatingIpTargetListDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this reserved IP
    Id string
    (String) The unique identifier for this target.
    Name string
    Enter a name for the floating IP address.
    PrimaryIps []IsFloatingIpTargetListPrimaryIp
    (List) The reserved ip reference.
    ResourceType string
    (String) The resource type.
    crn String
    (String) The CRN if target is a public gateway.
    deleteds List<IsFloatingIpTargetListDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this reserved IP
    id String
    (String) The unique identifier for this target.
    name String
    Enter a name for the floating IP address.
    primaryIps List<IsFloatingIpTargetListPrimaryIp>
    (List) The reserved ip reference.
    resourceType String
    (String) The resource type.
    crn string
    (String) The CRN if target is a public gateway.
    deleteds IsFloatingIpTargetListDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href string
    (String) The URL for this reserved IP
    id string
    (String) The unique identifier for this target.
    name string
    Enter a name for the floating IP address.
    primaryIps IsFloatingIpTargetListPrimaryIp[]
    (List) The reserved ip reference.
    resourceType string
    (String) The resource type.
    crn str
    (String) The CRN if target is a public gateway.
    deleteds Sequence[IsFloatingIpTargetListDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href str
    (String) The URL for this reserved IP
    id str
    (String) The unique identifier for this target.
    name str
    Enter a name for the floating IP address.
    primary_ips Sequence[IsFloatingIpTargetListPrimaryIp]
    (List) The reserved ip reference.
    resource_type str
    (String) The resource type.
    crn String
    (String) The CRN if target is a public gateway.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this reserved IP
    id String
    (String) The unique identifier for this target.
    name String
    Enter a name for the floating IP address.
    primaryIps List<Property Map>
    (List) The reserved ip reference.
    resourceType String
    (String) The resource type.

    IsFloatingIpTargetListDeleted, IsFloatingIpTargetListDeletedArgs

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    IsFloatingIpTargetListPrimaryIp, IsFloatingIpTargetListPrimaryIpArgs

    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Href string
    (String) The URL for this reserved IP
    Name string
    Enter a name for the floating IP address.
    ReservedIp string
    (String) The unique identifier for this reserved IP
    ResourceType string
    (String) The resource type.
    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Href string
    (String) The URL for this reserved IP
    Name string
    Enter a name for the floating IP address.
    ReservedIp string
    (String) The unique identifier for this reserved IP
    ResourceType string
    (String) The resource type.
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    href String
    (String) The URL for this reserved IP
    name String
    Enter a name for the floating IP address.
    reservedIp String
    (String) The unique identifier for this reserved IP
    resourceType String
    (String) The resource type.
    address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    href string
    (String) The URL for this reserved IP
    name string
    Enter a name for the floating IP address.
    reservedIp string
    (String) The unique identifier for this reserved IP
    resourceType string
    (String) The resource type.
    address str
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    href str
    (String) The URL for this reserved IP
    name str
    Enter a name for the floating IP address.
    reserved_ip str
    (String) The unique identifier for this reserved IP
    resource_type str
    (String) The resource type.
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    href String
    (String) The URL for this reserved IP
    name String
    Enter a name for the floating IP address.
    reservedIp String
    (String) The unique identifier for this reserved IP
    resourceType String
    (String) The resource type.

    IsFloatingIpTimeouts, IsFloatingIpTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    Import

    The ibm_is_floating_ip resource can be imported by using floating IP ID.

    Example

    $ pulumi import ibm:index/isFloatingIp:IsFloatingIp example d7bec597-4726-451f-8a63-e62e6f19c32c

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm