1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCisGlobalLoadBalancers
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getCisGlobalLoadBalancers

Explore with Pulumi AI

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

    Retrieve information 24 X 7 availability and performance of your application by using the IBM Cloud Internet Services global Load Balancers. For more information, refer to CIS global loadbalancer.

    Example Usage

    The following example retrieves information about an IBM Cloud Internet Services global Load Balancer resource.

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const test = ibm.getCisGlobalLoadBalancers({
        cisId: _var.cis_crn,
        domainId: _var.zone_id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    test = ibm.get_cis_global_load_balancers(cis_id=var["cis_crn"],
        domain_id=var["zone_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 {
    		_, err := ibm.GetCisGlobalLoadBalancers(ctx, &ibm.GetCisGlobalLoadBalancersArgs{
    			CisId:    _var.Cis_crn,
    			DomainId: _var.Zone_id,
    		}, 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 test = Ibm.GetCisGlobalLoadBalancers.Invoke(new()
        {
            CisId = @var.Cis_crn,
            DomainId = @var.Zone_id,
        });
    
    });
    
    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.GetCisGlobalLoadBalancersArgs;
    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 test = IbmFunctions.getCisGlobalLoadBalancers(GetCisGlobalLoadBalancersArgs.builder()
                .cisId(var_.cis_crn())
                .domainId(var_.zone_id())
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: ibm:getCisGlobalLoadBalancers
          arguments:
            cisId: ${var.cis_crn}
            domainId: ${var.zone_id}
    

    Using getCisGlobalLoadBalancers

    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 getCisGlobalLoadBalancers(args: GetCisGlobalLoadBalancersArgs, opts?: InvokeOptions): Promise<GetCisGlobalLoadBalancersResult>
    function getCisGlobalLoadBalancersOutput(args: GetCisGlobalLoadBalancersOutputArgs, opts?: InvokeOptions): Output<GetCisGlobalLoadBalancersResult>
    def get_cis_global_load_balancers(cis_id: Optional[str] = None,
                                      domain_id: Optional[str] = None,
                                      id: Optional[str] = None,
                                      timeouts: Optional[GetCisGlobalLoadBalancersTimeouts] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetCisGlobalLoadBalancersResult
    def get_cis_global_load_balancers_output(cis_id: Optional[pulumi.Input[str]] = None,
                                      domain_id: Optional[pulumi.Input[str]] = None,
                                      id: Optional[pulumi.Input[str]] = None,
                                      timeouts: Optional[pulumi.Input[GetCisGlobalLoadBalancersTimeoutsArgs]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetCisGlobalLoadBalancersResult]
    func GetCisGlobalLoadBalancers(ctx *Context, args *GetCisGlobalLoadBalancersArgs, opts ...InvokeOption) (*GetCisGlobalLoadBalancersResult, error)
    func GetCisGlobalLoadBalancersOutput(ctx *Context, args *GetCisGlobalLoadBalancersOutputArgs, opts ...InvokeOption) GetCisGlobalLoadBalancersResultOutput

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

    public static class GetCisGlobalLoadBalancers 
    {
        public static Task<GetCisGlobalLoadBalancersResult> InvokeAsync(GetCisGlobalLoadBalancersArgs args, InvokeOptions? opts = null)
        public static Output<GetCisGlobalLoadBalancersResult> Invoke(GetCisGlobalLoadBalancersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCisGlobalLoadBalancersResult> getCisGlobalLoadBalancers(GetCisGlobalLoadBalancersArgs args, InvokeOptions options)
    public static Output<GetCisGlobalLoadBalancersResult> getCisGlobalLoadBalancers(GetCisGlobalLoadBalancersArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getCisGlobalLoadBalancers:getCisGlobalLoadBalancers
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CisId string
    The resource CRN ID of the CIS on which zones were created.
    DomainId string
    The ID of the domain to retrieve the Load Balancers from.
    Id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    Timeouts GetCisGlobalLoadBalancersTimeouts
    CisId string
    The resource CRN ID of the CIS on which zones were created.
    DomainId string
    The ID of the domain to retrieve the Load Balancers from.
    Id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    Timeouts GetCisGlobalLoadBalancersTimeouts
    cisId String
    The resource CRN ID of the CIS on which zones were created.
    domainId String
    The ID of the domain to retrieve the Load Balancers from.
    id String
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    timeouts GetCisGlobalLoadBalancersTimeouts
    cisId string
    The resource CRN ID of the CIS on which zones were created.
    domainId string
    The ID of the domain to retrieve the Load Balancers from.
    id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    timeouts GetCisGlobalLoadBalancersTimeouts
    cis_id str
    The resource CRN ID of the CIS on which zones were created.
    domain_id str
    The ID of the domain to retrieve the Load Balancers from.
    id str
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    timeouts GetCisGlobalLoadBalancersTimeouts
    cisId String
    The resource CRN ID of the CIS on which zones were created.
    domainId String
    The ID of the domain to retrieve the Load Balancers from.
    id String
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    timeouts Property Map

    getCisGlobalLoadBalancers Result

    The following output properties are available:

    CisGlbs List<GetCisGlobalLoadBalancersCisGlb>
    CisId string
    DomainId string
    Id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    Timeouts GetCisGlobalLoadBalancersTimeouts
    CisGlbs []GetCisGlobalLoadBalancersCisGlb
    CisId string
    DomainId string
    Id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    Timeouts GetCisGlobalLoadBalancersTimeouts
    cisGlbs List<GetCisGlobalLoadBalancersCisGlb>
    cisId String
    domainId String
    id String
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    timeouts GetCisGlobalLoadBalancersTimeouts
    cisGlbs GetCisGlobalLoadBalancersCisGlb[]
    cisId string
    domainId string
    id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    timeouts GetCisGlobalLoadBalancersTimeouts
    cis_glbs Sequence[GetCisGlobalLoadBalancersCisGlb]
    cis_id str
    domain_id str
    id str
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    timeouts GetCisGlobalLoadBalancersTimeouts
    cisGlbs List<Property Map>
    cisId String
    domainId String
    id String
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    timeouts Property Map

    Supporting Types

    GetCisGlobalLoadBalancersCisGlb

    CreatedOn string
    DefaultPoolIds List<string>
    (String) A list of pool IDs ordered by their failover priority. Used whenever region or pop pools are not defined.
    Description string
    (String) Free text description.
    Enabled bool
    (String) Indicates if the Load Balancer is enabled or not. Region and pop pools are not currently implemented in this version of the provider.
    FallbackPoolId string
    (String) The pool ID to use when all other pools are detected as unhealthy.
    GlbId string
    (String) The Load Balancer ID.
    Id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    ModifiedOn string
    Name string
    (String) The DNS name to associate with the Load Balancer. This can be a hostname, for example, www or the fully qualified name www.example.com, or example.com.
    PopPools List<GetCisGlobalLoadBalancersCisGlbPopPool>
    (String) A set containing mappings of IBM Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers.
    Proxied bool
    (String) Whether the hostname gets IBM's origin protection. Defaults to false.
    RegionPools List<GetCisGlobalLoadBalancersCisGlbRegionPool>
    (String) A set containing mappings of region or country codes to a list of pool IDs (ordered by their failover priority) for the given region.
    SessionAffinity string
    (String) Associates all requests coming from an end-user with a single origin. IBM will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, as long as it is available.
    SteeringPolicy string
    (String) Steering Policy which allows off,geo,random,dynamic_latency.
    Ttl double
    (String) Time to live (TTL) of the DNS entry for the IP address returned by this Load Balancer.P.
    CreatedOn string
    DefaultPoolIds []string
    (String) A list of pool IDs ordered by their failover priority. Used whenever region or pop pools are not defined.
    Description string
    (String) Free text description.
    Enabled bool
    (String) Indicates if the Load Balancer is enabled or not. Region and pop pools are not currently implemented in this version of the provider.
    FallbackPoolId string
    (String) The pool ID to use when all other pools are detected as unhealthy.
    GlbId string
    (String) The Load Balancer ID.
    Id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    ModifiedOn string
    Name string
    (String) The DNS name to associate with the Load Balancer. This can be a hostname, for example, www or the fully qualified name www.example.com, or example.com.
    PopPools []GetCisGlobalLoadBalancersCisGlbPopPool
    (String) A set containing mappings of IBM Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers.
    Proxied bool
    (String) Whether the hostname gets IBM's origin protection. Defaults to false.
    RegionPools []GetCisGlobalLoadBalancersCisGlbRegionPool
    (String) A set containing mappings of region or country codes to a list of pool IDs (ordered by their failover priority) for the given region.
    SessionAffinity string
    (String) Associates all requests coming from an end-user with a single origin. IBM will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, as long as it is available.
    SteeringPolicy string
    (String) Steering Policy which allows off,geo,random,dynamic_latency.
    Ttl float64
    (String) Time to live (TTL) of the DNS entry for the IP address returned by this Load Balancer.P.
    createdOn String
    defaultPoolIds List<String>
    (String) A list of pool IDs ordered by their failover priority. Used whenever region or pop pools are not defined.
    description String
    (String) Free text description.
    enabled Boolean
    (String) Indicates if the Load Balancer is enabled or not. Region and pop pools are not currently implemented in this version of the provider.
    fallbackPoolId String
    (String) The pool ID to use when all other pools are detected as unhealthy.
    glbId String
    (String) The Load Balancer ID.
    id String
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    modifiedOn String
    name String
    (String) The DNS name to associate with the Load Balancer. This can be a hostname, for example, www or the fully qualified name www.example.com, or example.com.
    popPools List<GetCisGlobalLoadBalancersCisGlbPopPool>
    (String) A set containing mappings of IBM Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers.
    proxied Boolean
    (String) Whether the hostname gets IBM's origin protection. Defaults to false.
    regionPools List<GetCisGlobalLoadBalancersCisGlbRegionPool>
    (String) A set containing mappings of region or country codes to a list of pool IDs (ordered by their failover priority) for the given region.
    sessionAffinity String
    (String) Associates all requests coming from an end-user with a single origin. IBM will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, as long as it is available.
    steeringPolicy String
    (String) Steering Policy which allows off,geo,random,dynamic_latency.
    ttl Double
    (String) Time to live (TTL) of the DNS entry for the IP address returned by this Load Balancer.P.
    createdOn string
    defaultPoolIds string[]
    (String) A list of pool IDs ordered by their failover priority. Used whenever region or pop pools are not defined.
    description string
    (String) Free text description.
    enabled boolean
    (String) Indicates if the Load Balancer is enabled or not. Region and pop pools are not currently implemented in this version of the provider.
    fallbackPoolId string
    (String) The pool ID to use when all other pools are detected as unhealthy.
    glbId string
    (String) The Load Balancer ID.
    id string
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    modifiedOn string
    name string
    (String) The DNS name to associate with the Load Balancer. This can be a hostname, for example, www or the fully qualified name www.example.com, or example.com.
    popPools GetCisGlobalLoadBalancersCisGlbPopPool[]
    (String) A set containing mappings of IBM Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers.
    proxied boolean
    (String) Whether the hostname gets IBM's origin protection. Defaults to false.
    regionPools GetCisGlobalLoadBalancersCisGlbRegionPool[]
    (String) A set containing mappings of region or country codes to a list of pool IDs (ordered by their failover priority) for the given region.
    sessionAffinity string
    (String) Associates all requests coming from an end-user with a single origin. IBM will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, as long as it is available.
    steeringPolicy string
    (String) Steering Policy which allows off,geo,random,dynamic_latency.
    ttl number
    (String) Time to live (TTL) of the DNS entry for the IP address returned by this Load Balancer.P.
    created_on str
    default_pool_ids Sequence[str]
    (String) A list of pool IDs ordered by their failover priority. Used whenever region or pop pools are not defined.
    description str
    (String) Free text description.
    enabled bool
    (String) Indicates if the Load Balancer is enabled or not. Region and pop pools are not currently implemented in this version of the provider.
    fallback_pool_id str
    (String) The pool ID to use when all other pools are detected as unhealthy.
    glb_id str
    (String) The Load Balancer ID.
    id str
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    modified_on str
    name str
    (String) The DNS name to associate with the Load Balancer. This can be a hostname, for example, www or the fully qualified name www.example.com, or example.com.
    pop_pools Sequence[GetCisGlobalLoadBalancersCisGlbPopPool]
    (String) A set containing mappings of IBM Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers.
    proxied bool
    (String) Whether the hostname gets IBM's origin protection. Defaults to false.
    region_pools Sequence[GetCisGlobalLoadBalancersCisGlbRegionPool]
    (String) A set containing mappings of region or country codes to a list of pool IDs (ordered by their failover priority) for the given region.
    session_affinity str
    (String) Associates all requests coming from an end-user with a single origin. IBM will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, as long as it is available.
    steering_policy str
    (String) Steering Policy which allows off,geo,random,dynamic_latency.
    ttl float
    (String) Time to live (TTL) of the DNS entry for the IP address returned by this Load Balancer.P.
    createdOn String
    defaultPoolIds List<String>
    (String) A list of pool IDs ordered by their failover priority. Used whenever region or pop pools are not defined.
    description String
    (String) Free text description.
    enabled Boolean
    (String) Indicates if the Load Balancer is enabled or not. Region and pop pools are not currently implemented in this version of the provider.
    fallbackPoolId String
    (String) The pool ID to use when all other pools are detected as unhealthy.
    glbId String
    (String) The Load Balancer ID.
    id String
    (String) The Load Balancer ID, domain ID and CRN. For example, id:domain-id:crn.
    modifiedOn String
    name String
    (String) The DNS name to associate with the Load Balancer. This can be a hostname, for example, www or the fully qualified name www.example.com, or example.com.
    popPools List<Property Map>
    (String) A set containing mappings of IBM Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers.
    proxied Boolean
    (String) Whether the hostname gets IBM's origin protection. Defaults to false.
    regionPools List<Property Map>
    (String) A set containing mappings of region or country codes to a list of pool IDs (ordered by their failover priority) for the given region.
    sessionAffinity String
    (String) Associates all requests coming from an end-user with a single origin. IBM will set a cookie on the initial response to the client, such that consequent requests with the cookie in the request will go to the same origin, as long as it is available.
    steeringPolicy String
    (String) Steering Policy which allows off,geo,random,dynamic_latency.
    ttl Number
    (String) Time to live (TTL) of the DNS entry for the IP address returned by this Load Balancer.P.

    GetCisGlobalLoadBalancersCisGlbPopPool

    PoolIds List<string>
    (String) A list of pool IDs in failover priority to use in the given region.
    Pop string
    (String) A 3-letter code for the Point-of-Presence. Multiple entries should not be specified with the same PoP.
    PoolIds []string
    (String) A list of pool IDs in failover priority to use in the given region.
    Pop string
    (String) A 3-letter code for the Point-of-Presence. Multiple entries should not be specified with the same PoP.
    poolIds List<String>
    (String) A list of pool IDs in failover priority to use in the given region.
    pop String
    (String) A 3-letter code for the Point-of-Presence. Multiple entries should not be specified with the same PoP.
    poolIds string[]
    (String) A list of pool IDs in failover priority to use in the given region.
    pop string
    (String) A 3-letter code for the Point-of-Presence. Multiple entries should not be specified with the same PoP.
    pool_ids Sequence[str]
    (String) A list of pool IDs in failover priority to use in the given region.
    pop str
    (String) A 3-letter code for the Point-of-Presence. Multiple entries should not be specified with the same PoP.
    poolIds List<String>
    (String) A list of pool IDs in failover priority to use in the given region.
    pop String
    (String) A 3-letter code for the Point-of-Presence. Multiple entries should not be specified with the same PoP.

    GetCisGlobalLoadBalancersCisGlbRegionPool

    PoolIds List<string>
    (String) A list of pool IDs in failover priority to use in the given region.
    Region string
    (String) A region code. Multiple entries is not allowed with the same region.
    PoolIds []string
    (String) A list of pool IDs in failover priority to use in the given region.
    Region string
    (String) A region code. Multiple entries is not allowed with the same region.
    poolIds List<String>
    (String) A list of pool IDs in failover priority to use in the given region.
    region String
    (String) A region code. Multiple entries is not allowed with the same region.
    poolIds string[]
    (String) A list of pool IDs in failover priority to use in the given region.
    region string
    (String) A region code. Multiple entries is not allowed with the same region.
    pool_ids Sequence[str]
    (String) A list of pool IDs in failover priority to use in the given region.
    region str
    (String) A region code. Multiple entries is not allowed with the same region.
    poolIds List<String>
    (String) A list of pool IDs in failover priority to use in the given region.
    region String
    (String) A region code. Multiple entries is not allowed with the same region.

    GetCisGlobalLoadBalancersTimeouts

    Read string
    Read string
    read String
    read string
    read str
    read String

    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