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

ibm.getCisOriginPools

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 information of an IBM Cloud Internet Services origin pool resource. This provides a pool of origins that is used by an IBM Cloud Internet Services Global Load Balancer. For more information, about CIS origin pool, see setting up origin pools.

    Example Usage

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

const test = ibm.getCisOriginPools({
    cisId: _var.cis_crn,
});

    import pulumi
import pulumi_ibm as ibm

test = ibm.get_cis_origin_pools(cis_id=var["cis_crn"])

    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.GetCisOriginPools(ctx, &ibm.GetCisOriginPoolsArgs{
			CisId: _var.Cis_crn,
		}, 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.GetCisOriginPools.Invoke(new()
    {
        CisId = @var.Cis_crn,
    });

});

    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.GetCisOriginPoolsArgs;
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.getCisOriginPools(GetCisOriginPoolsArgs.builder()
            .cisId(var_.cis_crn())
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: ibm:getCisOriginPools
      arguments:
        cisId: ${var.cis_crn}

    Using getCisOriginPools

    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 getCisOriginPools(args: GetCisOriginPoolsArgs, opts?: InvokeOptions): Promise<GetCisOriginPoolsResult>
function getCisOriginPoolsOutput(args: GetCisOriginPoolsOutputArgs, opts?: InvokeOptions): Output<GetCisOriginPoolsResult>
    def get_cis_origin_pools(cis_id: Optional[str] = None,
                         id: Optional[str] = None,
                         timeouts: Optional[GetCisOriginPoolsTimeouts] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCisOriginPoolsResult
def get_cis_origin_pools_output(cis_id: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         timeouts: Optional[pulumi.Input[GetCisOriginPoolsTimeoutsArgs]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCisOriginPoolsResult]
    func GetCisOriginPools(ctx *Context, args *GetCisOriginPoolsArgs, opts ...InvokeOption) (*GetCisOriginPoolsResult, error)
func GetCisOriginPoolsOutput(ctx *Context, args *GetCisOriginPoolsOutputArgs, opts ...InvokeOption) GetCisOriginPoolsResultOutput

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

    public static class GetCisOriginPools 
{
    public static Task<GetCisOriginPoolsResult> InvokeAsync(GetCisOriginPoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetCisOriginPoolsResult> Invoke(GetCisOriginPoolsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCisOriginPoolsResult> getCisOriginPools(GetCisOriginPoolsArgs args, InvokeOptions options)
public static Output<GetCisOriginPoolsResult> getCisOriginPools(GetCisOriginPoolsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    CisId string
    The ID of the CIS service instance.
    Id string
    (String) ID of the data source.
    Timeouts GetCisOriginPoolsTimeouts
    CisId string
    The ID of the CIS service instance.
    Id string
    (String) ID of the data source.
    Timeouts GetCisOriginPoolsTimeouts
    cisId String
    The ID of the CIS service instance.
    id String
    (String) ID of the data source.
    timeouts GetCisOriginPoolsTimeouts
    cisId string
    The ID of the CIS service instance.
    id string
    (String) ID of the data source.
    timeouts GetCisOriginPoolsTimeouts
    cis_id str
    The ID of the CIS service instance.
    id str
    (String) ID of the data source.
    timeouts GetCisOriginPoolsTimeouts
    cisId String
    The ID of the CIS service instance.
    id String
    (String) ID of the data source.
    timeouts Property Map

    getCisOriginPools Result

    The following output properties are available:

    CisId string
    CisOriginPools List<GetCisOriginPoolsCisOriginPool>
    Collection of GLB pools detail.
    Id string
    (String) ID of the data source.
    Timeouts GetCisOriginPoolsTimeouts
    CisId string
    CisOriginPools []GetCisOriginPoolsCisOriginPool
    Collection of GLB pools detail.
    Id string
    (String) ID of the data source.
    Timeouts GetCisOriginPoolsTimeouts
    cisId String
    cisOriginPools List<GetCisOriginPoolsCisOriginPool>
    Collection of GLB pools detail.
    id String
    (String) ID of the data source.
    timeouts GetCisOriginPoolsTimeouts
    cisId string
    cisOriginPools GetCisOriginPoolsCisOriginPool[]
    Collection of GLB pools detail.
    id string
    (String) ID of the data source.
    timeouts GetCisOriginPoolsTimeouts
    cis_id str
    cis_origin_pools Sequence[GetCisOriginPoolsCisOriginPool]
    Collection of GLB pools detail.
    id str
    (String) ID of the data source.
    timeouts GetCisOriginPoolsTimeouts
    cisId String
    cisOriginPools List<Property Map>
    Collection of GLB pools detail.
    id String
    (String) ID of the data source.
    timeouts Property Map

    Supporting Types

    GetCisOriginPoolsCisOriginPool

    CheckRegions List<string>
    CreatedOn string
    (String) Created RFC3339 timestamp of the Load Balancer.
    Description string
    (String) The description of the origin pool.
    Enabled bool
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    Healthy bool
    (String) The status of origins health.
    Id string
    (String) ID of the data source.
    MinimumOrigins double
    ModifiedOn string
    (String) Last modified RFC3339 timestamp of the Load Balancer.
    Monitor string
    (String) The ID of the monitor to use for health checking origins within this pool.
    Name string
    (String) A human-identifiable name of the origin.
    NotificationEmail string
    (String) The Email address to send health status notifications. This can be an individual mailbox or a mailing list.
    Origins List<GetCisOriginPoolsCisOriginPoolOrigin>
    (String) The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. Description of it's complex value is stated.
    PoolId string
    CheckRegions []string
    CreatedOn string
    (String) Created RFC3339 timestamp of the Load Balancer.
    Description string
    (String) The description of the origin pool.
    Enabled bool
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    Healthy bool
    (String) The status of origins health.
    Id string
    (String) ID of the data source.
    MinimumOrigins float64
    ModifiedOn string
    (String) Last modified RFC3339 timestamp of the Load Balancer.
    Monitor string
    (String) The ID of the monitor to use for health checking origins within this pool.
    Name string
    (String) A human-identifiable name of the origin.
    NotificationEmail string
    (String) The Email address to send health status notifications. This can be an individual mailbox or a mailing list.
    Origins []GetCisOriginPoolsCisOriginPoolOrigin
    (String) The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. Description of it's complex value is stated.
    PoolId string
    checkRegions List<String>
    createdOn String
    (String) Created RFC3339 timestamp of the Load Balancer.
    description String
    (String) The description of the origin pool.
    enabled Boolean
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    healthy Boolean
    (String) The status of origins health.
    id String
    (String) ID of the data source.
    minimumOrigins Double
    modifiedOn String
    (String) Last modified RFC3339 timestamp of the Load Balancer.
    monitor String
    (String) The ID of the monitor to use for health checking origins within this pool.
    name String
    (String) A human-identifiable name of the origin.
    notificationEmail String
    (String) The Email address to send health status notifications. This can be an individual mailbox or a mailing list.
    origins List<GetCisOriginPoolsCisOriginPoolOrigin>
    (String) The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. Description of it's complex value is stated.
    poolId String
    checkRegions string[]
    createdOn string
    (String) Created RFC3339 timestamp of the Load Balancer.
    description string
    (String) The description of the origin pool.
    enabled boolean
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    healthy boolean
    (String) The status of origins health.
    id string
    (String) ID of the data source.
    minimumOrigins number
    modifiedOn string
    (String) Last modified RFC3339 timestamp of the Load Balancer.
    monitor string
    (String) The ID of the monitor to use for health checking origins within this pool.
    name string
    (String) A human-identifiable name of the origin.
    notificationEmail string
    (String) The Email address to send health status notifications. This can be an individual mailbox or a mailing list.
    origins GetCisOriginPoolsCisOriginPoolOrigin[]
    (String) The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. Description of it's complex value is stated.
    poolId string
    check_regions Sequence[str]
    created_on str
    (String) Created RFC3339 timestamp of the Load Balancer.
    description str
    (String) The description of the origin pool.
    enabled bool
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    healthy bool
    (String) The status of origins health.
    id str
    (String) ID of the data source.
    minimum_origins float
    modified_on str
    (String) Last modified RFC3339 timestamp of the Load Balancer.
    monitor str
    (String) The ID of the monitor to use for health checking origins within this pool.
    name str
    (String) A human-identifiable name of the origin.
    notification_email str
    (String) The Email address to send health status notifications. This can be an individual mailbox or a mailing list.
    origins Sequence[GetCisOriginPoolsCisOriginPoolOrigin]
    (String) The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. Description of it's complex value is stated.
    pool_id str
    checkRegions List<String>
    createdOn String
    (String) Created RFC3339 timestamp of the Load Balancer.
    description String
    (String) The description of the origin pool.
    enabled Boolean
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    healthy Boolean
    (String) The status of origins health.
    id String
    (String) ID of the data source.
    minimumOrigins Number
    modifiedOn String
    (String) Last modified RFC3339 timestamp of the Load Balancer.
    monitor String
    (String) The ID of the monitor to use for health checking origins within this pool.
    name String
    (String) A human-identifiable name of the origin.
    notificationEmail String
    (String) The Email address to send health status notifications. This can be an individual mailbox or a mailing list.
    origins List<Property Map>
    (String) The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. Description of it's complex value is stated.
    poolId String

    GetCisOriginPoolsCisOriginPoolOrigin

    Address string
    (String) The IP address IPv4 or IPv6 of the origin, or the publicly addressable hostname. Hostnames entered is resolved directly to the origin, and not be a hostname proxied by CIS.
    DisabledAt string
    (String) The disabled date and time.
    Enabled bool
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    FailureReason string
    (String) The failure reason.
    Healthy bool
    (String) The status of origins health.
    Name string
    (String) A human-identifiable name of the origin.
    Weight double
    (String) The weight of the origin pool.
    Address string
    (String) The IP address IPv4 or IPv6 of the origin, or the publicly addressable hostname. Hostnames entered is resolved directly to the origin, and not be a hostname proxied by CIS.
    DisabledAt string
    (String) The disabled date and time.
    Enabled bool
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    FailureReason string
    (String) The failure reason.
    Healthy bool
    (String) The status of origins health.
    Name string
    (String) A human-identifiable name of the origin.
    Weight float64
    (String) The weight of the origin pool.
    address String
    (String) The IP address IPv4 or IPv6 of the origin, or the publicly addressable hostname. Hostnames entered is resolved directly to the origin, and not be a hostname proxied by CIS.
    disabledAt String
    (String) The disabled date and time.
    enabled Boolean
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    failureReason String
    (String) The failure reason.
    healthy Boolean
    (String) The status of origins health.
    name String
    (String) A human-identifiable name of the origin.
    weight Double
    (String) The weight of the origin pool.
    address string
    (String) The IP address IPv4 or IPv6 of the origin, or the publicly addressable hostname. Hostnames entered is resolved directly to the origin, and not be a hostname proxied by CIS.
    disabledAt string
    (String) The disabled date and time.
    enabled boolean
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    failureReason string
    (String) The failure reason.
    healthy boolean
    (String) The status of origins health.
    name string
    (String) A human-identifiable name of the origin.
    weight number
    (String) The weight of the origin pool.
    address str
    (String) The IP address IPv4 or IPv6 of the origin, or the publicly addressable hostname. Hostnames entered is resolved directly to the origin, and not be a hostname proxied by CIS.
    disabled_at str
    (String) The disabled date and time.
    enabled bool
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    failure_reason str
    (String) The failure reason.
    healthy bool
    (String) The status of origins health.
    name str
    (String) A human-identifiable name of the origin.
    weight float
    (String) The weight of the origin pool.
    address String
    (String) The IP address IPv4 or IPv6 of the origin, or the publicly addressable hostname. Hostnames entered is resolved directly to the origin, and not be a hostname proxied by CIS.
    disabledAt String
    (String) The disabled date and time.
    enabled Boolean
    (String) The default value is enable. Disabled origins do not receive traffic, and are excluded from health checks. The origin is disabled only for the current pool.
    failureReason String
    (String) The failure reason.
    healthy Boolean
    (String) The status of origins health.
    name String
    (String) A human-identifiable name of the origin.
    weight Number
    (String) The weight of the origin pool.

    GetCisOriginPoolsTimeouts

    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
    ibm-cloud/terraform-provider-ibm