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

ibm.CisOriginPool

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, update, or delete an origin pool for your IBM Cloud Internet Services instance. This provides a pool of origins that can be used by a IBM CIS 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 example = new ibm.CisOriginPool("example", {
    cisId: ibm_cis.instance.id,
    origins: [
        {
            name: "example-1",
            address: "192.0.2.1",
            enabled: false,
        },
        {
            name: "example-2",
            address: "192.0.2.2",
            enabled: false,
        },
    ],
    description: "example load balancer pool",
    enabled: false,
    minimumOrigins: 1,
    notificationEmail: "someone@example.com",
    checkRegions: ["WEU"],
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.CisOriginPool("example",
    cis_id=ibm_cis["instance"]["id"],
    origins=[
        {
            "name": "example-1",
            "address": "192.0.2.1",
            "enabled": False,
        },
        {
            "name": "example-2",
            "address": "192.0.2.2",
            "enabled": False,
        },
    ],
    description="example load balancer pool",
    enabled=False,
    minimum_origins=1,
    notification_email="someone@example.com",
    check_regions=["WEU"])

    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.NewCisOriginPool(ctx, "example", &ibm.CisOriginPoolArgs{
			CisId: pulumi.Any(ibm_cis.Instance.Id),
			Origins: ibm.CisOriginPoolOriginArray{
				&ibm.CisOriginPoolOriginArgs{
					Name:    pulumi.String("example-1"),
					Address: pulumi.String("192.0.2.1"),
					Enabled: pulumi.Bool(false),
				},
				&ibm.CisOriginPoolOriginArgs{
					Name:    pulumi.String("example-2"),
					Address: pulumi.String("192.0.2.2"),
					Enabled: pulumi.Bool(false),
				},
			},
			Description:       pulumi.String("example load balancer pool"),
			Enabled:           pulumi.Bool(false),
			MinimumOrigins:    pulumi.Float64(1),
			NotificationEmail: pulumi.String("someone@example.com"),
			CheckRegions: pulumi.StringArray{
				pulumi.String("WEU"),
			},
		})
		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 = new Ibm.CisOriginPool("example", new()
    {
        CisId = ibm_cis.Instance.Id,
        Origins = new[]
        {
            new Ibm.Inputs.CisOriginPoolOriginArgs
            {
                Name = "example-1",
                Address = "192.0.2.1",
                Enabled = false,
            },
            new Ibm.Inputs.CisOriginPoolOriginArgs
            {
                Name = "example-2",
                Address = "192.0.2.2",
                Enabled = false,
            },
        },
        Description = "example load balancer pool",
        Enabled = false,
        MinimumOrigins = 1,
        NotificationEmail = "someone@example.com",
        CheckRegions = new[]
        {
            "WEU",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CisOriginPool;
import com.pulumi.ibm.CisOriginPoolArgs;
import com.pulumi.ibm.inputs.CisOriginPoolOriginArgs;
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 example = new CisOriginPool("example", CisOriginPoolArgs.builder()
            .cisId(ibm_cis.instance().id())
            .origins(            
                CisOriginPoolOriginArgs.builder()
                    .name("example-1")
                    .address("192.0.2.1")
                    .enabled(false)
                    .build(),
                CisOriginPoolOriginArgs.builder()
                    .name("example-2")
                    .address("192.0.2.2")
                    .enabled(false)
                    .build())
            .description("example load balancer pool")
            .enabled(false)
            .minimumOrigins(1)
            .notificationEmail("someone@example.com")
            .checkRegions("WEU")
            .build());

    }
}

    resources:
  example:
    type: ibm:CisOriginPool
    properties:
      cisId: ${ibm_cis.instance.id}
      origins:
        - name: example-1
          address: 192.0.2.1
          enabled: false
        - name: example-2
          address: 192.0.2.2
          enabled: false
      description: example load balancer pool
      enabled: false
      minimumOrigins: 1
      notificationEmail: someone@example.com
      checkRegions:
        - WEU

    Create CisOriginPool Resource

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

    Constructor syntax

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

@overload
def CisOriginPool(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  check_regions: Optional[Sequence[str]] = None,
                  cis_id: Optional[str] = None,
                  enabled: Optional[bool] = None,
                  origins: Optional[Sequence[CisOriginPoolOriginArgs]] = None,
                  cis_origin_pool_id: Optional[str] = None,
                  description: Optional[str] = None,
                  minimum_origins: Optional[float] = None,
                  monitor: Optional[str] = None,
                  name: Optional[str] = None,
                  notification_email: Optional[str] = None)
    func NewCisOriginPool(ctx *Context, name string, args CisOriginPoolArgs, opts ...ResourceOption) (*CisOriginPool, error)
    public CisOriginPool(string name, CisOriginPoolArgs args, CustomResourceOptions? opts = null)
    public CisOriginPool(String name, CisOriginPoolArgs args)
public CisOriginPool(String name, CisOriginPoolArgs args, CustomResourceOptions options)

    type: ibm:CisOriginPool
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 CisOriginPoolArgs
    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 CisOriginPoolArgs
    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 CisOriginPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CisOriginPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CisOriginPoolArgs
    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 cisOriginPoolResource = new Ibm.CisOriginPool("cisOriginPoolResource", new()
{
    CheckRegions = new[]
    {
        "string",
    },
    CisId = "string",
    Enabled = false,
    Origins = new[]
    {
        new Ibm.Inputs.CisOriginPoolOriginArgs
        {
            Address = "string",
            Enabled = false,
            Name = "string",
            DisabledAt = "string",
            FailureReason = "string",
            Healthy = false,
            Weight = 0,
        },
    },
    CisOriginPoolId = "string",
    Description = "string",
    MinimumOrigins = 0,
    Monitor = "string",
    Name = "string",
    NotificationEmail = "string",
});

    example, err := ibm.NewCisOriginPool(ctx, "cisOriginPoolResource", &ibm.CisOriginPoolArgs{
	CheckRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	CisId:   pulumi.String("string"),
	Enabled: pulumi.Bool(false),
	Origins: ibm.CisOriginPoolOriginArray{
		&ibm.CisOriginPoolOriginArgs{
			Address:       pulumi.String("string"),
			Enabled:       pulumi.Bool(false),
			Name:          pulumi.String("string"),
			DisabledAt:    pulumi.String("string"),
			FailureReason: pulumi.String("string"),
			Healthy:       pulumi.Bool(false),
			Weight:        pulumi.Float64(0),
		},
	},
	CisOriginPoolId:   pulumi.String("string"),
	Description:       pulumi.String("string"),
	MinimumOrigins:    pulumi.Float64(0),
	Monitor:           pulumi.String("string"),
	Name:              pulumi.String("string"),
	NotificationEmail: pulumi.String("string"),
})

    var cisOriginPoolResource = new CisOriginPool("cisOriginPoolResource", CisOriginPoolArgs.builder()
    .checkRegions("string")
    .cisId("string")
    .enabled(false)
    .origins(CisOriginPoolOriginArgs.builder()
        .address("string")
        .enabled(false)
        .name("string")
        .disabledAt("string")
        .failureReason("string")
        .healthy(false)
        .weight(0)
        .build())
    .cisOriginPoolId("string")
    .description("string")
    .minimumOrigins(0)
    .monitor("string")
    .name("string")
    .notificationEmail("string")
    .build());

    cis_origin_pool_resource = ibm.CisOriginPool("cisOriginPoolResource",
    check_regions=["string"],
    cis_id="string",
    enabled=False,
    origins=[{
        "address": "string",
        "enabled": False,
        "name": "string",
        "disabled_at": "string",
        "failure_reason": "string",
        "healthy": False,
        "weight": 0,
    }],
    cis_origin_pool_id="string",
    description="string",
    minimum_origins=0,
    monitor="string",
    name="string",
    notification_email="string")

    const cisOriginPoolResource = new ibm.CisOriginPool("cisOriginPoolResource", {
    checkRegions: ["string"],
    cisId: "string",
    enabled: false,
    origins: [{
        address: "string",
        enabled: false,
        name: "string",
        disabledAt: "string",
        failureReason: "string",
        healthy: false,
        weight: 0,
    }],
    cisOriginPoolId: "string",
    description: "string",
    minimumOrigins: 0,
    monitor: "string",
    name: "string",
    notificationEmail: "string",
});

    type: ibm:CisOriginPool
properties:
    checkRegions:
        - string
    cisId: string
    cisOriginPoolId: string
    description: string
    enabled: false
    minimumOrigins: 0
    monitor: string
    name: string
    notificationEmail: string
    origins:
        - address: string
          disabledAt: string
          enabled: false
          failureReason: string
          healthy: false
          name: string
          weight: 0

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

    CheckRegions List<string>
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    Enabled bool
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    Origins List<CisOriginPoolOrigin>

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    CisOriginPoolId string
    (String) The ID of the origin pool.
    Description string
    A description for your origin pool.
    MinimumOrigins double
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    Monitor string
    The ID of the monitor to use for health checking origins within this pool.
    Name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    NotificationEmail string
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    CheckRegions []string
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    Enabled bool
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    Origins []CisOriginPoolOriginArgs

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    CisOriginPoolId string
    (String) The ID of the origin pool.
    Description string
    A description for your origin pool.
    MinimumOrigins float64
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    Monitor string
    The ID of the monitor to use for health checking origins within this pool.
    Name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    NotificationEmail string
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    checkRegions List<String>
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    enabled Boolean
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    origins List<CisOriginPoolOrigin>

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    cisOriginPoolId String
    (String) The ID of the origin pool.
    description String
    A description for your origin pool.
    minimumOrigins Double
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    monitor String
    The ID of the monitor to use for health checking origins within this pool.
    name String
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    notificationEmail String
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    checkRegions string[]
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    cisId string
    The ID of the IBM Cloud Internet Services instance.
    enabled boolean
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    origins CisOriginPoolOrigin[]

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    cisOriginPoolId string
    (String) The ID of the origin pool.
    description string
    A description for your origin pool.
    minimumOrigins number
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    monitor string
    The ID of the monitor to use for health checking origins within this pool.
    name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    notificationEmail string
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    check_regions Sequence[str]
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    cis_id str
    The ID of the IBM Cloud Internet Services instance.
    enabled bool
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    origins Sequence[CisOriginPoolOriginArgs]

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    cis_origin_pool_id str
    (String) The ID of the origin pool.
    description str
    A description for your origin pool.
    minimum_origins float
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    monitor str
    The ID of the monitor to use for health checking origins within this pool.
    name str
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    notification_email str
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    checkRegions List<String>
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    enabled Boolean
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    origins List<Property Map>

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    cisOriginPoolId String
    (String) The ID of the origin pool.
    description String
    A description for your origin pool.
    minimumOrigins Number
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    monitor String
    The ID of the monitor to use for health checking origins within this pool.
    name String
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    notificationEmail String
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.

    Outputs

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

    CreatedOn string
    (String) The RFC3339 timestamp of when the origin pool was created.
    Health string
    (String) The status of the origin pool.
    Healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    PoolId string
    CreatedOn string
    (String) The RFC3339 timestamp of when the origin pool was created.
    Health string
    (String) The status of the origin pool.
    Healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    PoolId string
    createdOn String
    (String) The RFC3339 timestamp of when the origin pool was created.
    health String
    (String) The status of the origin pool.
    healthy Boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    poolId String
    createdOn string
    (String) The RFC3339 timestamp of when the origin pool was created.
    health string
    (String) The status of the origin pool.
    healthy boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn string
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    poolId string
    created_on str
    (String) The RFC3339 timestamp of when the origin pool was created.
    health str
    (String) The status of the origin pool.
    healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_on str
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    pool_id str
    createdOn String
    (String) The RFC3339 timestamp of when the origin pool was created.
    health String
    (String) The status of the origin pool.
    healthy Boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    poolId String

    Look up Existing CisOriginPool Resource

    Get an existing CisOriginPool 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?: CisOriginPoolState, opts?: CustomResourceOptions): CisOriginPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        check_regions: Optional[Sequence[str]] = None,
        cis_id: Optional[str] = None,
        cis_origin_pool_id: Optional[str] = None,
        created_on: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        health: Optional[str] = None,
        healthy: Optional[bool] = None,
        minimum_origins: Optional[float] = None,
        modified_on: Optional[str] = None,
        monitor: Optional[str] = None,
        name: Optional[str] = None,
        notification_email: Optional[str] = None,
        origins: Optional[Sequence[CisOriginPoolOriginArgs]] = None,
        pool_id: Optional[str] = None) -> CisOriginPool
    func GetCisOriginPool(ctx *Context, name string, id IDInput, state *CisOriginPoolState, opts ...ResourceOption) (*CisOriginPool, error)
    public static CisOriginPool Get(string name, Input<string> id, CisOriginPoolState? state, CustomResourceOptions? opts = null)
    public static CisOriginPool get(String name, Output<String> id, CisOriginPoolState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CisOriginPool    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:
    CheckRegions List<string>
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    CisOriginPoolId string
    (String) The ID of the origin pool.
    CreatedOn string
    (String) The RFC3339 timestamp of when the origin pool was created.
    Description string
    A description for your origin pool.
    Enabled bool
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    Health string
    (String) The status of the origin pool.
    Healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    MinimumOrigins double
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    ModifiedOn string
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    Monitor string
    The ID of the monitor to use for health checking origins within this pool.
    Name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    NotificationEmail string
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    Origins List<CisOriginPoolOrigin>

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    PoolId string
    CheckRegions []string
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    CisOriginPoolId string
    (String) The ID of the origin pool.
    CreatedOn string
    (String) The RFC3339 timestamp of when the origin pool was created.
    Description string
    A description for your origin pool.
    Enabled bool
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    Health string
    (String) The status of the origin pool.
    Healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    MinimumOrigins float64
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    ModifiedOn string
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    Monitor string
    The ID of the monitor to use for health checking origins within this pool.
    Name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    NotificationEmail string
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    Origins []CisOriginPoolOriginArgs

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    PoolId string
    checkRegions List<String>
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    cisOriginPoolId String
    (String) The ID of the origin pool.
    createdOn String
    (String) The RFC3339 timestamp of when the origin pool was created.
    description String
    A description for your origin pool.
    enabled Boolean
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    health String
    (String) The status of the origin pool.
    healthy Boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    minimumOrigins Double
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    modifiedOn String
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    monitor String
    The ID of the monitor to use for health checking origins within this pool.
    name String
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    notificationEmail String
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    origins List<CisOriginPoolOrigin>

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    poolId String
    checkRegions string[]
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    cisId string
    The ID of the IBM Cloud Internet Services instance.
    cisOriginPoolId string
    (String) The ID of the origin pool.
    createdOn string
    (String) The RFC3339 timestamp of when the origin pool was created.
    description string
    A description for your origin pool.
    enabled boolean
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    health string
    (String) The status of the origin pool.
    healthy boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    minimumOrigins number
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    modifiedOn string
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    monitor string
    The ID of the monitor to use for health checking origins within this pool.
    name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    notificationEmail string
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    origins CisOriginPoolOrigin[]

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    poolId string
    check_regions Sequence[str]
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    cis_id str
    The ID of the IBM Cloud Internet Services instance.
    cis_origin_pool_id str
    (String) The ID of the origin pool.
    created_on str
    (String) The RFC3339 timestamp of when the origin pool was created.
    description str
    A description for your origin pool.
    enabled bool
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    health str
    (String) The status of the origin pool.
    healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    minimum_origins float
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    modified_on str
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    monitor str
    The ID of the monitor to use for health checking origins within this pool.
    name str
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    notification_email str
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    origins Sequence[CisOriginPoolOriginArgs]

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    pool_id str
    checkRegions List<String>
    A list of regions (specified by region code) from which to run health checks. If the list is empty, all regions are included, but you must use the enterprise plans. This is the default setting. Region codes can be found on our partner Cloudflare's website.
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    cisOriginPoolId String
    (String) The ID of the origin pool.
    createdOn String
    (String) The RFC3339 timestamp of when the origin pool was created.
    description String
    A description for your origin pool.
    enabled Boolean
    Required-If set to true, this pool is enabled and can receive incoming network traffic. Disabled pools do not receive network traffic and are excluded from health checks. Disabling a pool causes any load balancers that use the pool to failover to the next pool (if applicable).
    health String
    (String) The status of the origin pool.
    healthy Boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    minimumOrigins Number
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls within this number, the pool will be marked unhealthy and we will failover to the next available pool. Default: 1.
    modifiedOn String
    (String) The RFC3339 timestamp of when the origin pool was last modified.
    monitor String
    The ID of the monitor to use for health checking origins within this pool.
    name String
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    notificationEmail String
    The Email address to send health status notifications to. This can be an individual mailbox or a mailing list.
    origins List<Property Map>

    List of origins-Required-A list of origin servers within this pool. Traffic directed to this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    Nested scheme for origins:

    poolId String

    Supporting Types

    CisOriginPoolOrigin, CisOriginPoolOriginArgs

    Address string
    The IPv4 or IPv6 address of the origin server. You can also provide a hostname for the origin that is publicly accessible. Make sure that the hostname resolves to the origin server, and is not proxied by IBM Cloud Internet Services.
    Enabled bool
    If set to true, the origin sever is enabled within the origin pool. If set to false, the origin server is not enabled. Disabled origin servers cannot receive incoming network traffic and are excluded from IBM Cloud Internet Services health checks.
    Name string
    The name of the origin server.
    DisabledAt string
    (Timestamp) The disabled date and time.
    FailureReason string
    (String) The reason of failure.
    Healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    Weight double
    The origin pool weight.
    Address string
    The IPv4 or IPv6 address of the origin server. You can also provide a hostname for the origin that is publicly accessible. Make sure that the hostname resolves to the origin server, and is not proxied by IBM Cloud Internet Services.
    Enabled bool
    If set to true, the origin sever is enabled within the origin pool. If set to false, the origin server is not enabled. Disabled origin servers cannot receive incoming network traffic and are excluded from IBM Cloud Internet Services health checks.
    Name string
    The name of the origin server.
    DisabledAt string
    (Timestamp) The disabled date and time.
    FailureReason string
    (String) The reason of failure.
    Healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    Weight float64
    The origin pool weight.
    address String
    The IPv4 or IPv6 address of the origin server. You can also provide a hostname for the origin that is publicly accessible. Make sure that the hostname resolves to the origin server, and is not proxied by IBM Cloud Internet Services.
    enabled Boolean
    If set to true, the origin sever is enabled within the origin pool. If set to false, the origin server is not enabled. Disabled origin servers cannot receive incoming network traffic and are excluded from IBM Cloud Internet Services health checks.
    name String
    The name of the origin server.
    disabledAt String
    (Timestamp) The disabled date and time.
    failureReason String
    (String) The reason of failure.
    healthy Boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    weight Double
    The origin pool weight.
    address string
    The IPv4 or IPv6 address of the origin server. You can also provide a hostname for the origin that is publicly accessible. Make sure that the hostname resolves to the origin server, and is not proxied by IBM Cloud Internet Services.
    enabled boolean
    If set to true, the origin sever is enabled within the origin pool. If set to false, the origin server is not enabled. Disabled origin servers cannot receive incoming network traffic and are excluded from IBM Cloud Internet Services health checks.
    name string
    The name of the origin server.
    disabledAt string
    (Timestamp) The disabled date and time.
    failureReason string
    (String) The reason of failure.
    healthy boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    weight number
    The origin pool weight.
    address str
    The IPv4 or IPv6 address of the origin server. You can also provide a hostname for the origin that is publicly accessible. Make sure that the hostname resolves to the origin server, and is not proxied by IBM Cloud Internet Services.
    enabled bool
    If set to true, the origin sever is enabled within the origin pool. If set to false, the origin server is not enabled. Disabled origin servers cannot receive incoming network traffic and are excluded from IBM Cloud Internet Services health checks.
    name str
    The name of the origin server.
    disabled_at str
    (Timestamp) The disabled date and time.
    failure_reason str
    (String) The reason of failure.
    healthy bool
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    weight float
    The origin pool weight.
    address String
    The IPv4 or IPv6 address of the origin server. You can also provide a hostname for the origin that is publicly accessible. Make sure that the hostname resolves to the origin server, and is not proxied by IBM Cloud Internet Services.
    enabled Boolean
    If set to true, the origin sever is enabled within the origin pool. If set to false, the origin server is not enabled. Disabled origin servers cannot receive incoming network traffic and are excluded from IBM Cloud Internet Services health checks.
    name String
    The name of the origin server.
    disabledAt String
    (Timestamp) The disabled date and time.
    failureReason String
    (String) The reason of failure.
    healthy Boolean
    (Bool) If set to true, the origin server is healthy. If set to false, the origin server is not healthy.
    weight Number
    The origin pool weight.

    Import

    The origin pool can be imported by using the id. The ID is formed from the origin pool ID and the CRN (Cloud Resource Name). All values are concatenated with a : character.

    The CRN can be located on the Overview page of the Internet Services instance under the Domain heading of the console, or via the ibmcloud cis CLI.

    • CRN: The CRN is a 120 digit character string of the format crn:v1:bluemix:public:internet-svcs:global:a/1aa1111a1a1111aa1a111111111111aa:11aa111a-11a1-1a11-111a-111aaa11a1a1::

    • Origin pool ID: The origin pool ID is a 32 digit character string in the format 1aaaa111111aa11111111111a1a11a1. The ID of a origin pool is not available via the console. It can be retrieved programmatically via the CIS API or via the command line by running ibmcloud cis glb-pools.

    Syntax

    $ pulumi import ibm:index/cisOriginPool:CisOriginPool myorg <origin_pool_ID>:<crn>

    Example

    $ pulumi import ibm:index/cisOriginPool:CisOriginPool myorg 1aaaa111111aa11111111111a1a11a1:crn:v1:bluemix:public:internet-svcs:global:a/1aa1111a1a1111aa1a111111111111aa:11aa111a-11a1-1a11-111a-111aaa11a1a1::

    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