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

ibm.DnsGlbPool

Explore with Pulumi AI

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

    Provides a private DNS Global Load Balancer (GLB) pool resource. This allows DNS GLB pool to create, update, and delete. For more information, see Viewing GLB events

    Example Usage

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

const test_pdns_pool_nw = new ibm.DnsGlbPool("test-pdns-pool-nw", {
    instanceId: ibm_resource_instance["test-pdns-glb-pool-instance"].guid,
    description: "New test pool",
    enabled: true,
    healthyOriginsThreshold: 1,
    origins: [{
        name: "example-1",
        address: "www.google.com",
        enabled: true,
        description: "origin pool",
    }],
    monitor: ibm_dns_glb_monitor["test-pdns-glb-monitor"].monitor_id,
    notificationChannel: "https://mywebsite.com/dns/webhook",
    healthcheckRegion: "us-south",
    healthcheckSubnets: [ibm_is_subnet["test-pdns-glb-subnet"].resource_crn],
}, {
    dependsOn: [ibm_dns_zone["test-pdns-glb-pool-zone"]],
});

    import pulumi
import pulumi_ibm as ibm

test_pdns_pool_nw = ibm.DnsGlbPool("test-pdns-pool-nw",
    instance_id=ibm_resource_instance["test-pdns-glb-pool-instance"]["guid"],
    description="New test pool",
    enabled=True,
    healthy_origins_threshold=1,
    origins=[{
        "name": "example-1",
        "address": "www.google.com",
        "enabled": True,
        "description": "origin pool",
    }],
    monitor=ibm_dns_glb_monitor["test-pdns-glb-monitor"]["monitor_id"],
    notification_channel="https://mywebsite.com/dns/webhook",
    healthcheck_region="us-south",
    healthcheck_subnets=[ibm_is_subnet["test-pdns-glb-subnet"]["resource_crn"]],
    opts = pulumi.ResourceOptions(depends_on=[ibm_dns_zone["test-pdns-glb-pool-zone"]]))

    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.NewDnsGlbPool(ctx, "test-pdns-pool-nw", &ibm.DnsGlbPoolArgs{
			InstanceId:              pulumi.Any(ibm_resource_instance.TestPdnsGlbPoolInstance.Guid),
			Description:             pulumi.String("New test pool"),
			Enabled:                 pulumi.Bool(true),
			HealthyOriginsThreshold: pulumi.Float64(1),
			Origins: ibm.DnsGlbPoolOriginArray{
				&ibm.DnsGlbPoolOriginArgs{
					Name:        pulumi.String("example-1"),
					Address:     pulumi.String("www.google.com"),
					Enabled:     pulumi.Bool(true),
					Description: pulumi.String("origin pool"),
				},
			},
			Monitor:             pulumi.Any(ibm_dns_glb_monitor.TestPdnsGlbMonitor.Monitor_id),
			NotificationChannel: pulumi.String("https://mywebsite.com/dns/webhook"),
			HealthcheckRegion:   pulumi.String("us-south"),
			HealthcheckSubnets: pulumi.StringArray{
				ibm_is_subnet.TestPdnsGlbSubnet.Resource_crn,
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			ibm_dns_zone.TestPdnsGlbPoolZone,
		}))
		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_pdns_pool_nw = new Ibm.DnsGlbPool("test-pdns-pool-nw", new()
    {
        InstanceId = ibm_resource_instance.Test_pdns_glb_pool_instance.Guid,
        Description = "New test pool",
        Enabled = true,
        HealthyOriginsThreshold = 1,
        Origins = new[]
        {
            new Ibm.Inputs.DnsGlbPoolOriginArgs
            {
                Name = "example-1",
                Address = "www.google.com",
                Enabled = true,
                Description = "origin pool",
            },
        },
        Monitor = ibm_dns_glb_monitor.Test_pdns_glb_monitor.Monitor_id,
        NotificationChannel = "https://mywebsite.com/dns/webhook",
        HealthcheckRegion = "us-south",
        HealthcheckSubnets = new[]
        {
            ibm_is_subnet.Test_pdns_glb_subnet.Resource_crn,
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            ibm_dns_zone.Test_pdns_glb_pool_zone,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.DnsGlbPool;
import com.pulumi.ibm.DnsGlbPoolArgs;
import com.pulumi.ibm.inputs.DnsGlbPoolOriginArgs;
import com.pulumi.resources.CustomResourceOptions;
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 test_pdns_pool_nw = new DnsGlbPool("test-pdns-pool-nw", DnsGlbPoolArgs.builder()
            .instanceId(ibm_resource_instance.test-pdns-glb-pool-instance().guid())
            .description("New test pool")
            .enabled(true)
            .healthyOriginsThreshold(1)
            .origins(DnsGlbPoolOriginArgs.builder()
                .name("example-1")
                .address("www.google.com")
                .enabled(true)
                .description("origin pool")
                .build())
            .monitor(ibm_dns_glb_monitor.test-pdns-glb-monitor().monitor_id())
            .notificationChannel("https://mywebsite.com/dns/webhook")
            .healthcheckRegion("us-south")
            .healthcheckSubnets(ibm_is_subnet.test-pdns-glb-subnet().resource_crn())
            .build(), CustomResourceOptions.builder()
                .dependsOn(ibm_dns_zone.test-pdns-glb-pool-zone())
                .build());

    }
}

    resources:
  test-pdns-pool-nw:
    type: ibm:DnsGlbPool
    properties:
      instanceId: ${ibm_resource_instance"test-pdns-glb-pool-instance"[%!s(MISSING)].guid}
      description: New test pool
      enabled: true
      healthyOriginsThreshold: 1
      origins:
        - name: example-1
          address: www.google.com
          enabled: true
          description: origin pool
      monitor: ${ibm_dns_glb_monitor"test-pdns-glb-monitor"[%!s(MISSING)].monitor_id}
      notificationChannel: https://mywebsite.com/dns/webhook
      healthcheckRegion: us-south
      healthcheckSubnets:
        - ${ibm_is_subnet"test-pdns-glb-subnet"[%!s(MISSING)].resource_crn}
    options:
      dependsOn:
        - ${ibm_dns_zone"test-pdns-glb-pool-zone"[%!s(MISSING)]}

    Create DnsGlbPool Resource

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

    Constructor syntax

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

@overload
def DnsGlbPool(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               instance_id: Optional[str] = None,
               origins: Optional[Sequence[DnsGlbPoolOriginArgs]] = None,
               description: Optional[str] = None,
               dns_glb_pool_id: Optional[str] = None,
               enabled: Optional[bool] = None,
               healthcheck_region: Optional[str] = None,
               healthcheck_subnets: Optional[Sequence[str]] = None,
               healthy_origins_threshold: Optional[float] = None,
               monitor: Optional[str] = None,
               name: Optional[str] = None,
               notification_channel: Optional[str] = None,
               timeouts: Optional[DnsGlbPoolTimeoutsArgs] = None)
    func NewDnsGlbPool(ctx *Context, name string, args DnsGlbPoolArgs, opts ...ResourceOption) (*DnsGlbPool, error)
    public DnsGlbPool(string name, DnsGlbPoolArgs args, CustomResourceOptions? opts = null)
    public DnsGlbPool(String name, DnsGlbPoolArgs args)
public DnsGlbPool(String name, DnsGlbPoolArgs args, CustomResourceOptions options)

    type: ibm:DnsGlbPool
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 DnsGlbPoolArgs
    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 DnsGlbPoolArgs
    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 DnsGlbPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DnsGlbPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DnsGlbPoolArgs
    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 dnsGlbPoolResource = new Ibm.DnsGlbPool("dnsGlbPoolResource", new()
{
    InstanceId = "string",
    Origins = new[]
    {
        new Ibm.Inputs.DnsGlbPoolOriginArgs
        {
            Address = "string",
            Enabled = false,
            Name = "string",
            Description = "string",
            Health = false,
            HealthFailureReason = "string",
        },
    },
    Description = "string",
    DnsGlbPoolId = "string",
    Enabled = false,
    HealthcheckRegion = "string",
    HealthcheckSubnets = new[]
    {
        "string",
    },
    HealthyOriginsThreshold = 0,
    Monitor = "string",
    Name = "string",
    NotificationChannel = "string",
    Timeouts = new Ibm.Inputs.DnsGlbPoolTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewDnsGlbPool(ctx, "dnsGlbPoolResource", &ibm.DnsGlbPoolArgs{
	InstanceId: pulumi.String("string"),
	Origins: ibm.DnsGlbPoolOriginArray{
		&ibm.DnsGlbPoolOriginArgs{
			Address:             pulumi.String("string"),
			Enabled:             pulumi.Bool(false),
			Name:                pulumi.String("string"),
			Description:         pulumi.String("string"),
			Health:              pulumi.Bool(false),
			HealthFailureReason: pulumi.String("string"),
		},
	},
	Description:       pulumi.String("string"),
	DnsGlbPoolId:      pulumi.String("string"),
	Enabled:           pulumi.Bool(false),
	HealthcheckRegion: pulumi.String("string"),
	HealthcheckSubnets: pulumi.StringArray{
		pulumi.String("string"),
	},
	HealthyOriginsThreshold: pulumi.Float64(0),
	Monitor:                 pulumi.String("string"),
	Name:                    pulumi.String("string"),
	NotificationChannel:     pulumi.String("string"),
	Timeouts: &ibm.DnsGlbPoolTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var dnsGlbPoolResource = new DnsGlbPool("dnsGlbPoolResource", DnsGlbPoolArgs.builder()
    .instanceId("string")
    .origins(DnsGlbPoolOriginArgs.builder()
        .address("string")
        .enabled(false)
        .name("string")
        .description("string")
        .health(false)
        .healthFailureReason("string")
        .build())
    .description("string")
    .dnsGlbPoolId("string")
    .enabled(false)
    .healthcheckRegion("string")
    .healthcheckSubnets("string")
    .healthyOriginsThreshold(0)
    .monitor("string")
    .name("string")
    .notificationChannel("string")
    .timeouts(DnsGlbPoolTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    dns_glb_pool_resource = ibm.DnsGlbPool("dnsGlbPoolResource",
    instance_id="string",
    origins=[{
        "address": "string",
        "enabled": False,
        "name": "string",
        "description": "string",
        "health": False,
        "health_failure_reason": "string",
    }],
    description="string",
    dns_glb_pool_id="string",
    enabled=False,
    healthcheck_region="string",
    healthcheck_subnets=["string"],
    healthy_origins_threshold=0,
    monitor="string",
    name="string",
    notification_channel="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const dnsGlbPoolResource = new ibm.DnsGlbPool("dnsGlbPoolResource", {
    instanceId: "string",
    origins: [{
        address: "string",
        enabled: false,
        name: "string",
        description: "string",
        health: false,
        healthFailureReason: "string",
    }],
    description: "string",
    dnsGlbPoolId: "string",
    enabled: false,
    healthcheckRegion: "string",
    healthcheckSubnets: ["string"],
    healthyOriginsThreshold: 0,
    monitor: "string",
    name: "string",
    notificationChannel: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:DnsGlbPool
properties:
    description: string
    dnsGlbPoolId: string
    enabled: false
    healthcheckRegion: string
    healthcheckSubnets:
        - string
    healthyOriginsThreshold: 0
    instanceId: string
    monitor: string
    name: string
    notificationChannel: string
    origins:
        - address: string
          description: string
          enabled: false
          health: false
          healthFailureReason: string
          name: string
    timeouts:
        create: string
        delete: string
        update: string

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

    InstanceId string
    The GUID of the private DNS on which zone has to be created.
    Origins List<DnsGlbPoolOrigin>

    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.

    Nested scheme for origins:

    Description string
    Descriptive text of the origin server.
    DnsGlbPoolId string
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    Enabled bool
    Whether the origin server is enabled.
    HealthcheckRegion string
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    HealthcheckSubnets List<string>
    The health check subnet CRN of VSIs.
    HealthyOriginsThreshold double
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    Monitor string
    The ID of the Load Balancer monitor to be associated to this pool.
    Name string
    The name of the origin server.
    NotificationChannel string
    The webhook URL as a notification channel.
    Timeouts DnsGlbPoolTimeouts
    InstanceId string
    The GUID of the private DNS on which zone has to be created.
    Origins []DnsGlbPoolOriginArgs

    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.

    Nested scheme for origins:

    Description string
    Descriptive text of the origin server.
    DnsGlbPoolId string
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    Enabled bool
    Whether the origin server is enabled.
    HealthcheckRegion string
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    HealthcheckSubnets []string
    The health check subnet CRN of VSIs.
    HealthyOriginsThreshold float64
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    Monitor string
    The ID of the Load Balancer monitor to be associated to this pool.
    Name string
    The name of the origin server.
    NotificationChannel string
    The webhook URL as a notification channel.
    Timeouts DnsGlbPoolTimeoutsArgs
    instanceId String
    The GUID of the private DNS on which zone has to be created.
    origins List<DnsGlbPoolOrigin>

    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.

    Nested scheme for origins:

    description String
    Descriptive text of the origin server.
    dnsGlbPoolId String
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    enabled Boolean
    Whether the origin server is enabled.
    healthcheckRegion String
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    healthcheckSubnets List<String>
    The health check subnet CRN of VSIs.
    healthyOriginsThreshold Double
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    monitor String
    The ID of the Load Balancer monitor to be associated to this pool.
    name String
    The name of the origin server.
    notificationChannel String
    The webhook URL as a notification channel.
    timeouts DnsGlbPoolTimeouts
    instanceId string
    The GUID of the private DNS on which zone has to be created.
    origins DnsGlbPoolOrigin[]

    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.

    Nested scheme for origins:

    description string
    Descriptive text of the origin server.
    dnsGlbPoolId string
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    enabled boolean
    Whether the origin server is enabled.
    healthcheckRegion string
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    healthcheckSubnets string[]
    The health check subnet CRN of VSIs.
    healthyOriginsThreshold number
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    monitor string
    The ID of the Load Balancer monitor to be associated to this pool.
    name string
    The name of the origin server.
    notificationChannel string
    The webhook URL as a notification channel.
    timeouts DnsGlbPoolTimeouts
    instance_id str
    The GUID of the private DNS on which zone has to be created.
    origins Sequence[DnsGlbPoolOriginArgs]

    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.

    Nested scheme for origins:

    description str
    Descriptive text of the origin server.
    dns_glb_pool_id str
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    enabled bool
    Whether the origin server is enabled.
    healthcheck_region str
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    healthcheck_subnets Sequence[str]
    The health check subnet CRN of VSIs.
    healthy_origins_threshold float
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    monitor str
    The ID of the Load Balancer monitor to be associated to this pool.
    name str
    The name of the origin server.
    notification_channel str
    The webhook URL as a notification channel.
    timeouts DnsGlbPoolTimeoutsArgs
    instanceId String
    The GUID of the private DNS on which zone has to be created.
    origins List<Property Map>

    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.

    Nested scheme for origins:

    description String
    Descriptive text of the origin server.
    dnsGlbPoolId String
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    enabled Boolean
    Whether the origin server is enabled.
    healthcheckRegion String
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    healthcheckSubnets List<String>
    The health check subnet CRN of VSIs.
    healthyOriginsThreshold Number
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    monitor String
    The ID of the Load Balancer monitor to be associated to this pool.
    name String
    The name of the origin server.
    notificationChannel String
    The webhook URL as a notification channel.
    timeouts Property Map

    Outputs

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

    CreatedOn string
    (Timestamp) The time (created On) of the DNS GLB pool.
    Health string
    (String) Whether the health is true or false.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    (Timestamp) The time (modified On) of the DNS GLB pool.
    PoolId string
    (String) The pool ID.
    CreatedOn string
    (Timestamp) The time (created On) of the DNS GLB pool.
    Health string
    (String) Whether the health is true or false.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    (Timestamp) The time (modified On) of the DNS GLB pool.
    PoolId string
    (String) The pool ID.
    createdOn String
    (Timestamp) The time (created On) of the DNS GLB pool.
    health String
    (String) Whether the health is true or false.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    (Timestamp) The time (modified On) of the DNS GLB pool.
    poolId String
    (String) The pool ID.
    createdOn string
    (Timestamp) The time (created On) of the DNS GLB pool.
    health string
    (String) Whether the health is true or false.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn string
    (Timestamp) The time (modified On) of the DNS GLB pool.
    poolId string
    (String) The pool ID.
    created_on str
    (Timestamp) The time (created On) of the DNS GLB pool.
    health str
    (String) Whether the health is true or false.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_on str
    (Timestamp) The time (modified On) of the DNS GLB pool.
    pool_id str
    (String) The pool ID.
    createdOn String
    (Timestamp) The time (created On) of the DNS GLB pool.
    health String
    (String) Whether the health is true or false.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    (Timestamp) The time (modified On) of the DNS GLB pool.
    poolId String
    (String) The pool ID.

    Look up Existing DnsGlbPool Resource

    Get an existing DnsGlbPool 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?: DnsGlbPoolState, opts?: CustomResourceOptions): DnsGlbPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_on: Optional[str] = None,
        description: Optional[str] = None,
        dns_glb_pool_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        health: Optional[str] = None,
        healthcheck_region: Optional[str] = None,
        healthcheck_subnets: Optional[Sequence[str]] = None,
        healthy_origins_threshold: Optional[float] = None,
        instance_id: Optional[str] = None,
        modified_on: Optional[str] = None,
        monitor: Optional[str] = None,
        name: Optional[str] = None,
        notification_channel: Optional[str] = None,
        origins: Optional[Sequence[DnsGlbPoolOriginArgs]] = None,
        pool_id: Optional[str] = None,
        timeouts: Optional[DnsGlbPoolTimeoutsArgs] = None) -> DnsGlbPool
    func GetDnsGlbPool(ctx *Context, name string, id IDInput, state *DnsGlbPoolState, opts ...ResourceOption) (*DnsGlbPool, error)
    public static DnsGlbPool Get(string name, Input<string> id, DnsGlbPoolState? state, CustomResourceOptions? opts = null)
    public static DnsGlbPool get(String name, Output<String> id, DnsGlbPoolState state, CustomResourceOptions options)
    resources:  _:    type: ibm:DnsGlbPool    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:
    CreatedOn string
    (Timestamp) The time (created On) of the DNS GLB pool.
    Description string
    Descriptive text of the origin server.
    DnsGlbPoolId string
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    Enabled bool
    Whether the origin server is enabled.
    Health string
    (String) Whether the health is true or false.
    HealthcheckRegion string
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    HealthcheckSubnets List<string>
    The health check subnet CRN of VSIs.
    HealthyOriginsThreshold double
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    InstanceId string
    The GUID of the private DNS on which zone has to be created.
    ModifiedOn string
    (Timestamp) The time (modified On) of the DNS GLB pool.
    Monitor string
    The ID of the Load Balancer monitor to be associated to this pool.
    Name string
    The name of the origin server.
    NotificationChannel string
    The webhook URL as a notification channel.
    Origins List<DnsGlbPoolOrigin>

    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.

    Nested scheme for origins:

    PoolId string
    (String) The pool ID.
    Timeouts DnsGlbPoolTimeouts
    CreatedOn string
    (Timestamp) The time (created On) of the DNS GLB pool.
    Description string
    Descriptive text of the origin server.
    DnsGlbPoolId string
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    Enabled bool
    Whether the origin server is enabled.
    Health string
    (String) Whether the health is true or false.
    HealthcheckRegion string
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    HealthcheckSubnets []string
    The health check subnet CRN of VSIs.
    HealthyOriginsThreshold float64
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    InstanceId string
    The GUID of the private DNS on which zone has to be created.
    ModifiedOn string
    (Timestamp) The time (modified On) of the DNS GLB pool.
    Monitor string
    The ID of the Load Balancer monitor to be associated to this pool.
    Name string
    The name of the origin server.
    NotificationChannel string
    The webhook URL as a notification channel.
    Origins []DnsGlbPoolOriginArgs

    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.

    Nested scheme for origins:

    PoolId string
    (String) The pool ID.
    Timeouts DnsGlbPoolTimeoutsArgs
    createdOn String
    (Timestamp) The time (created On) of the DNS GLB pool.
    description String
    Descriptive text of the origin server.
    dnsGlbPoolId String
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    enabled Boolean
    Whether the origin server is enabled.
    health String
    (String) Whether the health is true or false.
    healthcheckRegion String
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    healthcheckSubnets List<String>
    The health check subnet CRN of VSIs.
    healthyOriginsThreshold Double
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    instanceId String
    The GUID of the private DNS on which zone has to be created.
    modifiedOn String
    (Timestamp) The time (modified On) of the DNS GLB pool.
    monitor String
    The ID of the Load Balancer monitor to be associated to this pool.
    name String
    The name of the origin server.
    notificationChannel String
    The webhook URL as a notification channel.
    origins List<DnsGlbPoolOrigin>

    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.

    Nested scheme for origins:

    poolId String
    (String) The pool ID.
    timeouts DnsGlbPoolTimeouts
    createdOn string
    (Timestamp) The time (created On) of the DNS GLB pool.
    description string
    Descriptive text of the origin server.
    dnsGlbPoolId string
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    enabled boolean
    Whether the origin server is enabled.
    health string
    (String) Whether the health is true or false.
    healthcheckRegion string
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    healthcheckSubnets string[]
    The health check subnet CRN of VSIs.
    healthyOriginsThreshold number
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    instanceId string
    The GUID of the private DNS on which zone has to be created.
    modifiedOn string
    (Timestamp) The time (modified On) of the DNS GLB pool.
    monitor string
    The ID of the Load Balancer monitor to be associated to this pool.
    name string
    The name of the origin server.
    notificationChannel string
    The webhook URL as a notification channel.
    origins DnsGlbPoolOrigin[]

    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.

    Nested scheme for origins:

    poolId string
    (String) The pool ID.
    timeouts DnsGlbPoolTimeouts
    created_on str
    (Timestamp) The time (created On) of the DNS GLB pool.
    description str
    Descriptive text of the origin server.
    dns_glb_pool_id str
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    enabled bool
    Whether the origin server is enabled.
    health str
    (String) Whether the health is true or false.
    healthcheck_region str
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    healthcheck_subnets Sequence[str]
    The health check subnet CRN of VSIs.
    healthy_origins_threshold float
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    instance_id str
    The GUID of the private DNS on which zone has to be created.
    modified_on str
    (Timestamp) The time (modified On) of the DNS GLB pool.
    monitor str
    The ID of the Load Balancer monitor to be associated to this pool.
    name str
    The name of the origin server.
    notification_channel str
    The webhook URL as a notification channel.
    origins Sequence[DnsGlbPoolOriginArgs]

    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.

    Nested scheme for origins:

    pool_id str
    (String) The pool ID.
    timeouts DnsGlbPoolTimeoutsArgs
    createdOn String
    (Timestamp) The time (created On) of the DNS GLB pool.
    description String
    Descriptive text of the origin server.
    dnsGlbPoolId String
    (String) The unique ID of the private DNS zone. The ID is composed of <instance_id>/<glb_pool_id>.
    enabled Boolean
    Whether the origin server is enabled.
    health String
    (String) Whether the health is true or false.
    healthcheckRegion String
    Health check region of VSIs. Examples: us-south,us-east, eu-gb, eu-de, au-syd, jp-tok, jp-osa, ca-tor, br-sao.
    healthcheckSubnets List<String>
    The health check subnet CRN of VSIs.
    healthyOriginsThreshold Number
    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.
    instanceId String
    The GUID of the private DNS on which zone has to be created.
    modifiedOn String
    (Timestamp) The time (modified On) of the DNS GLB pool.
    monitor String
    The ID of the Load Balancer monitor to be associated to this pool.
    name String
    The name of the origin server.
    notificationChannel String
    The webhook URL as a notification channel.
    origins List<Property Map>

    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.

    Nested scheme for origins:

    poolId String
    (String) The pool ID.
    timeouts Property Map

    Supporting Types

    DnsGlbPoolOrigin, DnsGlbPoolOriginArgs

    Address string
    The address of the origin server. It can be a hostname or an IP address.
    Enabled bool
    Whether the origin server is enabled.
    Name string
    The name of the origin server.
    Description string
    Descriptive text of the origin server.
    Health bool
    (String) Whether the health is true or false.
    HealthFailureReason string
    (String) The reason for health check failure.
    Address string
    The address of the origin server. It can be a hostname or an IP address.
    Enabled bool
    Whether the origin server is enabled.
    Name string
    The name of the origin server.
    Description string
    Descriptive text of the origin server.
    Health bool
    (String) Whether the health is true or false.
    HealthFailureReason string
    (String) The reason for health check failure.
    address String
    The address of the origin server. It can be a hostname or an IP address.
    enabled Boolean
    Whether the origin server is enabled.
    name String
    The name of the origin server.
    description String
    Descriptive text of the origin server.
    health Boolean
    (String) Whether the health is true or false.
    healthFailureReason String
    (String) The reason for health check failure.
    address string
    The address of the origin server. It can be a hostname or an IP address.
    enabled boolean
    Whether the origin server is enabled.
    name string
    The name of the origin server.
    description string
    Descriptive text of the origin server.
    health boolean
    (String) Whether the health is true or false.
    healthFailureReason string
    (String) The reason for health check failure.
    address str
    The address of the origin server. It can be a hostname or an IP address.
    enabled bool
    Whether the origin server is enabled.
    name str
    The name of the origin server.
    description str
    Descriptive text of the origin server.
    health bool
    (String) Whether the health is true or false.
    health_failure_reason str
    (String) The reason for health check failure.
    address String
    The address of the origin server. It can be a hostname or an IP address.
    enabled Boolean
    Whether the origin server is enabled.
    name String
    The name of the origin server.
    description String
    Descriptive text of the origin server.
    health Boolean
    (String) Whether the health is true or false.
    healthFailureReason String
    (String) The reason for health check failure.

    DnsGlbPoolTimeouts, DnsGlbPoolTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    The ibm_dns_glb_pool can be imported by using private DNS instance ID, GLB pool ID.

    Example

    $ pulumi import ibm:index/dnsGlbPool:DnsGlbPool example 6ffda12064634723b079acdb018ef308/435da12064634723b079acdb018ef308

    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