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

ibm.getIsFloatingIp

Explore with Pulumi AI

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

    Retrieve an information of VPC floating IP on IBM Cloud as a read-only data source. For more information, about floating IP, 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

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

const example = ibm.getIsFloatingIp({
    name: "example-floating-ip",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_floating_ip(name="example-floating-ip")

    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 {
		_, err := ibm.LookupIsFloatingIp(ctx, &ibm.LookupIsFloatingIpArgs{
			Name: "example-floating-ip",
		}, nil)
		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 example = Ibm.GetIsFloatingIp.Invoke(new()
    {
        Name = "example-floating-ip",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsFloatingIpArgs;
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) {
        final var example = IbmFunctions.getIsFloatingIp(GetIsFloatingIpArgs.builder()
            .name("example-floating-ip")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsFloatingIp
      arguments:
        name: example-floating-ip

    Using getIsFloatingIp

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIsFloatingIp(args: GetIsFloatingIpArgs, opts?: InvokeOptions): Promise<GetIsFloatingIpResult>
function getIsFloatingIpOutput(args: GetIsFloatingIpOutputArgs, opts?: InvokeOptions): Output<GetIsFloatingIpResult>
    def get_is_floating_ip(id: Optional[str] = None,
                       name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetIsFloatingIpResult
def get_is_floating_ip_output(id: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetIsFloatingIpResult]
    func LookupIsFloatingIp(ctx *Context, args *LookupIsFloatingIpArgs, opts ...InvokeOption) (*LookupIsFloatingIpResult, error)
func LookupIsFloatingIpOutput(ctx *Context, args *LookupIsFloatingIpOutputArgs, opts ...InvokeOption) LookupIsFloatingIpResultOutput

    > Note: This function is named LookupIsFloatingIp in the Go SDK.

    public static class GetIsFloatingIp 
{
    public static Task<GetIsFloatingIpResult> InvokeAsync(GetIsFloatingIpArgs args, InvokeOptions? opts = null)
    public static Output<GetIsFloatingIpResult> Invoke(GetIsFloatingIpInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsFloatingIpResult> getIsFloatingIp(GetIsFloatingIpArgs args, InvokeOptions options)
public static Output<GetIsFloatingIpResult> getIsFloatingIp(GetIsFloatingIpArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsFloatingIp:getIsFloatingIp
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the floating IP.
    Id string
    (String) The unique identifier for this target.
    Name string
    The name of the floating IP.
    Id string
    (String) The unique identifier for this target.
    name String
    The name of the floating IP.
    id String
    (String) The unique identifier for this target.
    name string
    The name of the floating IP.
    id string
    (String) The unique identifier for this target.
    name str
    The name of the floating IP.
    id str
    (String) The unique identifier for this target.
    name String
    The name of the floating IP.
    id String
    (String) The unique identifier for this target.

    getIsFloatingIp Result

    The following output properties are available:

    AccessTags List<string>
    (String) Access management tags associated for the floating ip.
    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
    (String) The unique identifier for this target.
    Name string
    (String) The user-defined or system-provided name for this reserved IP
    Status string
    (String) Provisioning status of the floating IP address.
    Tags List<string>
    (String) The tags associated with the floating IP.
    Target string
    (String) The unique identifier for the target to allocate the floating IP address.
    TargetLists List<GetIsFloatingIpTargetList>
    (List) The target of this floating IP. Nested scheme for target_list:
    Zone string
    (String) The zone name where to create the floating IP address.
    AccessTags []string
    (String) Access management tags associated for the floating ip.
    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
    (String) The unique identifier for this target.
    Name string
    (String) The user-defined or system-provided name for this reserved IP
    Status string
    (String) Provisioning status of the floating IP address.
    Tags []string
    (String) The tags associated with the floating IP.
    Target string
    (String) The unique identifier for the target to allocate the floating IP address.
    TargetLists []GetIsFloatingIpTargetList
    (List) The target of this floating IP. Nested scheme for target_list:
    Zone string
    (String) The zone name where to create the floating IP address.
    accessTags List<String>
    (String) Access management tags associated for the floating ip.
    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
    (String) The unique identifier for this target.
    name String
    (String) The user-defined or system-provided name for this reserved IP
    status String
    (String) Provisioning status of the floating IP address.
    tags List<String>
    (String) The tags associated with the floating IP.
    target String
    (String) The unique identifier for the target to allocate the floating IP address.
    targetLists List<GetIsFloatingIpTargetList>
    (List) The target of this floating IP. Nested scheme for target_list:
    zone String
    (String) The zone name where to create the floating IP address.
    accessTags string[]
    (String) Access management tags associated for the floating ip.
    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
    (String) The unique identifier for this target.
    name string
    (String) The user-defined or system-provided name for this reserved IP
    status string
    (String) Provisioning status of the floating IP address.
    tags string[]
    (String) The tags associated with the floating IP.
    target string
    (String) The unique identifier for the target to allocate the floating IP address.
    targetLists GetIsFloatingIpTargetList[]
    (List) The target of this floating IP. Nested scheme for target_list:
    zone string
    (String) The zone name where to create the floating IP address.
    access_tags Sequence[str]
    (String) Access management tags associated for the floating ip.
    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
    (String) The unique identifier for this target.
    name str
    (String) The user-defined or system-provided name for this reserved IP
    status str
    (String) Provisioning status of the floating IP address.
    tags Sequence[str]
    (String) The tags associated with the floating IP.
    target str
    (String) The unique identifier for the target to allocate the floating IP address.
    target_lists Sequence[GetIsFloatingIpTargetList]
    (List) The target of this floating IP. Nested scheme for target_list:
    zone str
    (String) The zone name where to create the floating IP address.
    accessTags List<String>
    (String) Access management tags associated for the floating ip.
    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
    (String) The unique identifier for this target.
    name String
    (String) The user-defined or system-provided name for this reserved IP
    status String
    (String) Provisioning status of the floating IP address.
    tags List<String>
    (String) The tags associated with the floating IP.
    target String
    (String) The unique identifier for the target to allocate the floating IP address.
    targetLists List<Property Map>
    (List) The target of this floating IP. Nested scheme for target_list:
    zone String
    (String) The zone name where to create the floating IP address.

    Supporting Types

    GetIsFloatingIpTargetList

    Crn string
    (String) The CRN if target is a public gateway.
    Deleteds List<GetIsFloatingIpTargetListDeleted>
    (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
    The name of the floating IP.
    PrimaryIps List<GetIsFloatingIpTargetListPrimaryIp>
    (List) The reserved ip reference.
    ResourceType string
    (String) The resource type.
    Crn string
    (String) The CRN if target is a public gateway.
    Deleteds []GetIsFloatingIpTargetListDeleted
    (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
    The name of the floating IP.
    PrimaryIps []GetIsFloatingIpTargetListPrimaryIp
    (List) The reserved ip reference.
    ResourceType string
    (String) The resource type.
    crn String
    (String) The CRN if target is a public gateway.
    deleteds List<GetIsFloatingIpTargetListDeleted>
    (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
    The name of the floating IP.
    primaryIps List<GetIsFloatingIpTargetListPrimaryIp>
    (List) The reserved ip reference.
    resourceType String
    (String) The resource type.
    crn string
    (String) The CRN if target is a public gateway.
    deleteds GetIsFloatingIpTargetListDeleted[]
    (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
    The name of the floating IP.
    primaryIps GetIsFloatingIpTargetListPrimaryIp[]
    (List) The reserved ip reference.
    resourceType string
    (String) The resource type.
    crn str
    (String) The CRN if target is a public gateway.
    deleteds Sequence[GetIsFloatingIpTargetListDeleted]
    (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
    The name of the floating IP.
    primary_ips Sequence[GetIsFloatingIpTargetListPrimaryIp]
    (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
    The name of the floating IP.
    primaryIps List<Property Map>
    (List) The reserved ip reference.
    resourceType String
    (String) The resource type.

    GetIsFloatingIpTargetListDeleted

    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.

    GetIsFloatingIpTargetListPrimaryIp

    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
    The name of the floating IP.
    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
    The name of the floating IP.
    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
    The name of the floating IP.
    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
    The name of the floating IP.
    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
    The name of the floating IP.
    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
    The name of the floating IP.
    reservedIp String
    (String) The unique identifier for this reserved IP
    resourceType String
    (String) The resource type.

    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