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

ibm.DnsGlbMonitor

Explore with Pulumi AI

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

    Provides a private DNS GLB (GLB) monitor resource. This allows DNS (GLB)) monitor 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_monitor = new ibm.DnsGlbMonitor("test-pdns-monitor", {
        instanceId: ibm_resource_instance["test-pdns-instance"].guid,
        description: "test monitor description",
        interval: 63,
        retries: 3,
        timeout: 8,
        port: 8080,
        type: "HTTP",
        expectedCodes: "200",
        path: "/health",
        method: "GET",
        expectedBody: "alive",
        headers: [{
            name: "headerName",
            values: [
                "example",
                "abc",
            ],
        }],
    }, {
        dependsOn: [ibm_dns_zone["test-pdns-zone"]],
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    test_pdns_monitor = ibm.DnsGlbMonitor("test-pdns-monitor",
        instance_id=ibm_resource_instance["test-pdns-instance"]["guid"],
        description="test monitor description",
        interval=63,
        retries=3,
        timeout=8,
        port=8080,
        type="HTTP",
        expected_codes="200",
        path="/health",
        method="GET",
        expected_body="alive",
        headers=[{
            "name": "headerName",
            "values": [
                "example",
                "abc",
            ],
        }],
        opts = pulumi.ResourceOptions(depends_on=[ibm_dns_zone["test-pdns-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.NewDnsGlbMonitor(ctx, "test-pdns-monitor", &ibm.DnsGlbMonitorArgs{
    			InstanceId:    pulumi.Any(ibm_resource_instance.TestPdnsInstance.Guid),
    			Description:   pulumi.String("test monitor description"),
    			Interval:      pulumi.Float64(63),
    			Retries:       pulumi.Float64(3),
    			Timeout:       pulumi.Float64(8),
    			Port:          pulumi.Float64(8080),
    			Type:          pulumi.String("HTTP"),
    			ExpectedCodes: pulumi.String("200"),
    			Path:          pulumi.String("/health"),
    			Method:        pulumi.String("GET"),
    			ExpectedBody:  pulumi.String("alive"),
    			Headers: ibm.DnsGlbMonitorHeaderArray{
    				&ibm.DnsGlbMonitorHeaderArgs{
    					Name: pulumi.String("headerName"),
    					Values: pulumi.StringArray{
    						pulumi.String("example"),
    						pulumi.String("abc"),
    					},
    				},
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			ibm_dns_zone.TestPdnsZone,
    		}))
    		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_monitor = new Ibm.DnsGlbMonitor("test-pdns-monitor", new()
        {
            InstanceId = ibm_resource_instance.Test_pdns_instance.Guid,
            Description = "test monitor description",
            Interval = 63,
            Retries = 3,
            Timeout = 8,
            Port = 8080,
            Type = "HTTP",
            ExpectedCodes = "200",
            Path = "/health",
            Method = "GET",
            ExpectedBody = "alive",
            Headers = new[]
            {
                new Ibm.Inputs.DnsGlbMonitorHeaderArgs
                {
                    Name = "headerName",
                    Values = new[]
                    {
                        "example",
                        "abc",
                    },
                },
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                ibm_dns_zone.Test_pdns_zone,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.DnsGlbMonitor;
    import com.pulumi.ibm.DnsGlbMonitorArgs;
    import com.pulumi.ibm.inputs.DnsGlbMonitorHeaderArgs;
    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_monitor = new DnsGlbMonitor("test-pdns-monitor", DnsGlbMonitorArgs.builder()
                .instanceId(ibm_resource_instance.test-pdns-instance().guid())
                .description("test monitor description")
                .interval(63)
                .retries(3)
                .timeout(8)
                .port(8080)
                .type("HTTP")
                .expectedCodes("200")
                .path("/health")
                .method("GET")
                .expectedBody("alive")
                .headers(DnsGlbMonitorHeaderArgs.builder()
                    .name("headerName")
                    .values(                
                        "example",
                        "abc")
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(ibm_dns_zone.test-pdns-zone())
                    .build());
    
        }
    }
    
    resources:
      test-pdns-monitor:
        type: ibm:DnsGlbMonitor
        properties:
          instanceId: ${ibm_resource_instance"test-pdns-instance"[%!s(MISSING)].guid}
          description: test monitor description
          interval: 63
          retries: 3
          timeout: 8
          port: 8080
          type: HTTP
          expectedCodes: '200'
          path: /health
          method: GET
          expectedBody: alive
          headers:
            - name: headerName
              values:
                - example
                - abc
        options:
          dependsOn:
            - ${ibm_dns_zone"test-pdns-zone"[%!s(MISSING)]}
    

    Create DnsGlbMonitor Resource

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

    Constructor syntax

    new DnsGlbMonitor(name: string, args: DnsGlbMonitorArgs, opts?: CustomResourceOptions);
    @overload
    def DnsGlbMonitor(resource_name: str,
                      args: DnsGlbMonitorArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def DnsGlbMonitor(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      instance_id: Optional[str] = None,
                      method: Optional[str] = None,
                      port: Optional[float] = None,
                      expected_body: Optional[str] = None,
                      expected_codes: Optional[str] = None,
                      headers: Optional[Sequence[DnsGlbMonitorHeaderArgs]] = None,
                      description: Optional[str] = None,
                      dns_glb_monitor_id: Optional[str] = None,
                      name: Optional[str] = None,
                      interval: Optional[float] = None,
                      path: Optional[str] = None,
                      allow_insecure: Optional[bool] = None,
                      retries: Optional[float] = None,
                      timeout: Optional[float] = None,
                      timeouts: Optional[DnsGlbMonitorTimeoutsArgs] = None,
                      type: Optional[str] = None)
    func NewDnsGlbMonitor(ctx *Context, name string, args DnsGlbMonitorArgs, opts ...ResourceOption) (*DnsGlbMonitor, error)
    public DnsGlbMonitor(string name, DnsGlbMonitorArgs args, CustomResourceOptions? opts = null)
    public DnsGlbMonitor(String name, DnsGlbMonitorArgs args)
    public DnsGlbMonitor(String name, DnsGlbMonitorArgs args, CustomResourceOptions options)
    
    type: ibm:DnsGlbMonitor
    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 DnsGlbMonitorArgs
    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 DnsGlbMonitorArgs
    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 DnsGlbMonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DnsGlbMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DnsGlbMonitorArgs
    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 dnsGlbMonitorResource = new Ibm.DnsGlbMonitor("dnsGlbMonitorResource", new()
    {
        InstanceId = "string",
        Method = "string",
        Port = 0,
        ExpectedBody = "string",
        ExpectedCodes = "string",
        Headers = new[]
        {
            new Ibm.Inputs.DnsGlbMonitorHeaderArgs
            {
                Name = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        Description = "string",
        DnsGlbMonitorId = "string",
        Name = "string",
        Interval = 0,
        Path = "string",
        AllowInsecure = false,
        Retries = 0,
        Timeout = 0,
        Timeouts = new Ibm.Inputs.DnsGlbMonitorTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
        Type = "string",
    });
    
    example, err := ibm.NewDnsGlbMonitor(ctx, "dnsGlbMonitorResource", &ibm.DnsGlbMonitorArgs{
    	InstanceId:    pulumi.String("string"),
    	Method:        pulumi.String("string"),
    	Port:          pulumi.Float64(0),
    	ExpectedBody:  pulumi.String("string"),
    	ExpectedCodes: pulumi.String("string"),
    	Headers: ibm.DnsGlbMonitorHeaderArray{
    		&ibm.DnsGlbMonitorHeaderArgs{
    			Name: pulumi.String("string"),
    			Values: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Description:     pulumi.String("string"),
    	DnsGlbMonitorId: pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	Interval:        pulumi.Float64(0),
    	Path:            pulumi.String("string"),
    	AllowInsecure:   pulumi.Bool(false),
    	Retries:         pulumi.Float64(0),
    	Timeout:         pulumi.Float64(0),
    	Timeouts: &ibm.DnsGlbMonitorTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	Type: pulumi.String("string"),
    })
    
    var dnsGlbMonitorResource = new DnsGlbMonitor("dnsGlbMonitorResource", DnsGlbMonitorArgs.builder()
        .instanceId("string")
        .method("string")
        .port(0)
        .expectedBody("string")
        .expectedCodes("string")
        .headers(DnsGlbMonitorHeaderArgs.builder()
            .name("string")
            .values("string")
            .build())
        .description("string")
        .dnsGlbMonitorId("string")
        .name("string")
        .interval(0)
        .path("string")
        .allowInsecure(false)
        .retries(0)
        .timeout(0)
        .timeouts(DnsGlbMonitorTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .type("string")
        .build());
    
    dns_glb_monitor_resource = ibm.DnsGlbMonitor("dnsGlbMonitorResource",
        instance_id="string",
        method="string",
        port=0,
        expected_body="string",
        expected_codes="string",
        headers=[{
            "name": "string",
            "values": ["string"],
        }],
        description="string",
        dns_glb_monitor_id="string",
        name="string",
        interval=0,
        path="string",
        allow_insecure=False,
        retries=0,
        timeout=0,
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        },
        type="string")
    
    const dnsGlbMonitorResource = new ibm.DnsGlbMonitor("dnsGlbMonitorResource", {
        instanceId: "string",
        method: "string",
        port: 0,
        expectedBody: "string",
        expectedCodes: "string",
        headers: [{
            name: "string",
            values: ["string"],
        }],
        description: "string",
        dnsGlbMonitorId: "string",
        name: "string",
        interval: 0,
        path: "string",
        allowInsecure: false,
        retries: 0,
        timeout: 0,
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
        type: "string",
    });
    
    type: ibm:DnsGlbMonitor
    properties:
        allowInsecure: false
        description: string
        dnsGlbMonitorId: string
        expectedBody: string
        expectedCodes: string
        headers:
            - name: string
              values:
                - string
        instanceId: string
        interval: 0
        method: string
        name: string
        path: string
        port: 0
        retries: 0
        timeout: 0
        timeouts:
            create: string
            delete: string
            update: string
        type: string
    

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

    InstanceId string
    The GUID of the private DNS.
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    Description string
    Descriptive text of the Load Balancer monitor.
    DnsGlbMonitorId string
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    ExpectedBody string
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    ExpectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    Headers List<DnsGlbMonitorHeader>

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    Interval double
    The interval between each health check.
    Method string
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    Name string
    The name of the Load Balancer monitor.
    Path string
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    Port double
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    Retries double
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    Timeout double
    The timeout (in seconds) before marking the health check as failed.
    Timeouts DnsGlbMonitorTimeouts
    Type string
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    InstanceId string
    The GUID of the private DNS.
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    Description string
    Descriptive text of the Load Balancer monitor.
    DnsGlbMonitorId string
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    ExpectedBody string
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    ExpectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    Headers []DnsGlbMonitorHeaderArgs

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    Interval float64
    The interval between each health check.
    Method string
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    Name string
    The name of the Load Balancer monitor.
    Path string
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    Port float64
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    Retries float64
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    Timeout float64
    The timeout (in seconds) before marking the health check as failed.
    Timeouts DnsGlbMonitorTimeoutsArgs
    Type string
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    instanceId String
    The GUID of the private DNS.
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    description String
    Descriptive text of the Load Balancer monitor.
    dnsGlbMonitorId String
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    expectedBody String
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes String
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    headers List<DnsGlbMonitorHeader>

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    interval Double
    The interval between each health check.
    method String
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    name String
    The name of the Load Balancer monitor.
    path String
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port Double
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    retries Double
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    timeout Double
    The timeout (in seconds) before marking the health check as failed.
    timeouts DnsGlbMonitorTimeouts
    type String
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    instanceId string
    The GUID of the private DNS.
    allowInsecure boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    description string
    Descriptive text of the Load Balancer monitor.
    dnsGlbMonitorId string
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    expectedBody string
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    headers DnsGlbMonitorHeader[]

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    interval number
    The interval between each health check.
    method string
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    name string
    The name of the Load Balancer monitor.
    path string
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port number
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    retries number
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    timeout number
    The timeout (in seconds) before marking the health check as failed.
    timeouts DnsGlbMonitorTimeouts
    type string
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    instance_id str
    The GUID of the private DNS.
    allow_insecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    description str
    Descriptive text of the Load Balancer monitor.
    dns_glb_monitor_id str
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    expected_body str
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    expected_codes str
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    headers Sequence[DnsGlbMonitorHeaderArgs]

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    interval float
    The interval between each health check.
    method str
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    name str
    The name of the Load Balancer monitor.
    path str
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port float
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    retries float
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    timeout float
    The timeout (in seconds) before marking the health check as failed.
    timeouts DnsGlbMonitorTimeoutsArgs
    type str
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    instanceId String
    The GUID of the private DNS.
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    description String
    Descriptive text of the Load Balancer monitor.
    dnsGlbMonitorId String
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    expectedBody String
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes String
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    headers List<Property Map>

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    interval Number
    The interval between each health check.
    method String
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    name String
    The name of the Load Balancer monitor.
    path String
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port Number
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    retries Number
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    timeout Number
    The timeout (in seconds) before marking the health check as failed.
    timeouts Property Map
    type String
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.

    Outputs

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

    CreatedOn string
    (Timestamp) The time (created on) of the DNS GLB monitor.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    MonitorId string
    (String) The monitor ID.
    CreatedOn string
    (Timestamp) The time (created on) of the DNS GLB monitor.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    MonitorId string
    (String) The monitor ID.
    createdOn String
    (Timestamp) The time (created on) of the DNS GLB monitor.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    monitorId String
    (String) The monitor ID.
    createdOn string
    (Timestamp) The time (created on) of the DNS GLB monitor.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn string
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    monitorId string
    (String) The monitor ID.
    created_on str
    (Timestamp) The time (created on) of the DNS GLB monitor.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_on str
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    monitor_id str
    (String) The monitor ID.
    createdOn String
    (Timestamp) The time (created on) of the DNS GLB monitor.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    monitorId String
    (String) The monitor ID.

    Look up Existing DnsGlbMonitor Resource

    Get an existing DnsGlbMonitor 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?: DnsGlbMonitorState, opts?: CustomResourceOptions): DnsGlbMonitor
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_insecure: Optional[bool] = None,
            created_on: Optional[str] = None,
            description: Optional[str] = None,
            dns_glb_monitor_id: Optional[str] = None,
            expected_body: Optional[str] = None,
            expected_codes: Optional[str] = None,
            headers: Optional[Sequence[DnsGlbMonitorHeaderArgs]] = None,
            instance_id: Optional[str] = None,
            interval: Optional[float] = None,
            method: Optional[str] = None,
            modified_on: Optional[str] = None,
            monitor_id: Optional[str] = None,
            name: Optional[str] = None,
            path: Optional[str] = None,
            port: Optional[float] = None,
            retries: Optional[float] = None,
            timeout: Optional[float] = None,
            timeouts: Optional[DnsGlbMonitorTimeoutsArgs] = None,
            type: Optional[str] = None) -> DnsGlbMonitor
    func GetDnsGlbMonitor(ctx *Context, name string, id IDInput, state *DnsGlbMonitorState, opts ...ResourceOption) (*DnsGlbMonitor, error)
    public static DnsGlbMonitor Get(string name, Input<string> id, DnsGlbMonitorState? state, CustomResourceOptions? opts = null)
    public static DnsGlbMonitor get(String name, Output<String> id, DnsGlbMonitorState state, CustomResourceOptions options)
    resources:  _:    type: ibm:DnsGlbMonitor    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:
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    CreatedOn string
    (Timestamp) The time (created on) of the DNS GLB monitor.
    Description string
    Descriptive text of the Load Balancer monitor.
    DnsGlbMonitorId string
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    ExpectedBody string
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    ExpectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    Headers List<DnsGlbMonitorHeader>

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    InstanceId string
    The GUID of the private DNS.
    Interval double
    The interval between each health check.
    Method string
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    ModifiedOn string
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    MonitorId string
    (String) The monitor ID.
    Name string
    The name of the Load Balancer monitor.
    Path string
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    Port double
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    Retries double
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    Timeout double
    The timeout (in seconds) before marking the health check as failed.
    Timeouts DnsGlbMonitorTimeouts
    Type string
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    CreatedOn string
    (Timestamp) The time (created on) of the DNS GLB monitor.
    Description string
    Descriptive text of the Load Balancer monitor.
    DnsGlbMonitorId string
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    ExpectedBody string
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    ExpectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    Headers []DnsGlbMonitorHeaderArgs

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    InstanceId string
    The GUID of the private DNS.
    Interval float64
    The interval between each health check.
    Method string
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    ModifiedOn string
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    MonitorId string
    (String) The monitor ID.
    Name string
    The name of the Load Balancer monitor.
    Path string
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    Port float64
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    Retries float64
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    Timeout float64
    The timeout (in seconds) before marking the health check as failed.
    Timeouts DnsGlbMonitorTimeoutsArgs
    Type string
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    createdOn String
    (Timestamp) The time (created on) of the DNS GLB monitor.
    description String
    Descriptive text of the Load Balancer monitor.
    dnsGlbMonitorId String
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    expectedBody String
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes String
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    headers List<DnsGlbMonitorHeader>

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    instanceId String
    The GUID of the private DNS.
    interval Double
    The interval between each health check.
    method String
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    modifiedOn String
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    monitorId String
    (String) The monitor ID.
    name String
    The name of the Load Balancer monitor.
    path String
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port Double
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    retries Double
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    timeout Double
    The timeout (in seconds) before marking the health check as failed.
    timeouts DnsGlbMonitorTimeouts
    type String
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    allowInsecure boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    createdOn string
    (Timestamp) The time (created on) of the DNS GLB monitor.
    description string
    Descriptive text of the Load Balancer monitor.
    dnsGlbMonitorId string
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    expectedBody string
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    headers DnsGlbMonitorHeader[]

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    instanceId string
    The GUID of the private DNS.
    interval number
    The interval between each health check.
    method string
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    modifiedOn string
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    monitorId string
    (String) The monitor ID.
    name string
    The name of the Load Balancer monitor.
    path string
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port number
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    retries number
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    timeout number
    The timeout (in seconds) before marking the health check as failed.
    timeouts DnsGlbMonitorTimeouts
    type string
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    allow_insecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    created_on str
    (Timestamp) The time (created on) of the DNS GLB monitor.
    description str
    Descriptive text of the Load Balancer monitor.
    dns_glb_monitor_id str
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    expected_body str
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    expected_codes str
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    headers Sequence[DnsGlbMonitorHeaderArgs]

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    instance_id str
    The GUID of the private DNS.
    interval float
    The interval between each health check.
    method str
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    modified_on str
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    monitor_id str
    (String) The monitor ID.
    name str
    The name of the Load Balancer monitor.
    path str
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port float
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    retries float
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    timeout float
    The timeout (in seconds) before marking the health check as failed.
    timeouts DnsGlbMonitorTimeoutsArgs
    type str
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTPS monitors.
    createdOn String
    (Timestamp) The time (created on) of the DNS GLB monitor.
    description String
    Descriptive text of the Load Balancer monitor.
    dnsGlbMonitorId String
    (String) The unique ID of the private DNS Monitor. The ID is composed of <instance_id>/<glb_monitor_id>.
    expectedBody String
    A case-insensitive sub-string to look in the response body. If the string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes String
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Allowable values are 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 2xx, 3xx, 4xx, 5xx.
    headers List<Property Map>

    The HTTP request headers to send in the health check. It is recommended you set a host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

    Nested scheme for headers:

    instanceId String
    The GUID of the private DNS.
    interval Number
    The interval between each health check.
    method String
    The method to use for the health check applicable to HTTP or HTTPS based checks, the default value is GET.
    modifiedOn String
    (Timestamp) The time (modified on) of the DNS GLB monitor.
    monitorId String
    (String) The monitor ID.
    name String
    The name of the Load Balancer monitor.
    path String
    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port Number
    The port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port. For example, HTTP default is 80, and HTTPS default is 443).
    retries Number
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
    timeout Number
    The timeout (in seconds) before marking the health check as failed.
    timeouts Property Map
    type String
    The protocol to use for the health check. Currently supported protocols are HTTP,HTTPS and TCP. Default Value is HTTP.

    Supporting Types

    DnsGlbMonitorHeader, DnsGlbMonitorHeaderArgs

    Name string
    The name of the HTTP request header.
    Values List<string>
    The value of HTTP request header
    Name string
    The name of the HTTP request header.
    Values []string
    The value of HTTP request header
    name String
    The name of the HTTP request header.
    values List<String>
    The value of HTTP request header
    name string
    The name of the HTTP request header.
    values string[]
    The value of HTTP request header
    name str
    The name of the HTTP request header.
    values Sequence[str]
    The value of HTTP request header
    name String
    The name of the HTTP request header.
    values List<String>
    The value of HTTP request header

    DnsGlbMonitorTimeouts, DnsGlbMonitorTimeoutsArgs

    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_monitor can be imported by using private DNS instance ID, and GLB Monitor ID.

    Example

    $ pulumi import ibm:index/dnsGlbMonitor:DnsGlbMonitor 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