1. Packages
  2. Ibm Provider
  3. API Docs
  4. CisHealthcheck
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.CisHealthcheck

Explore with Pulumi AI

Create, update, or delete an HTTPS health check for your IBM Cloud Internet Services instance. You can configure a health check monitor to actively check the availability of those servers over HTTP(S). For more information, about CIS health check, see setting up health checks.

Example Usage

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

const test = new ibm.CisHealthcheck("test", {
    cisId: ibm_cis.instance.id,
    expectedBody: "alive",
    expectedCodes: "2xx",
    method: "GET",
    timeout: 7,
    path: "/health",
    interval: 60,
    retries: 3,
    description: "example load balancer",
    headers: [
        {
            header: "Host",
            values: [
                "example.com",
                "example1.com",
            ],
        },
        {
            header: "Host1",
            values: [
                "example3.com",
                "example11.com",
            ],
        },
    ],
});
Copy
import pulumi
import pulumi_ibm as ibm

test = ibm.CisHealthcheck("test",
    cis_id=ibm_cis["instance"]["id"],
    expected_body="alive",
    expected_codes="2xx",
    method="GET",
    timeout=7,
    path="/health",
    interval=60,
    retries=3,
    description="example load balancer",
    headers=[
        {
            "header": "Host",
            "values": [
                "example.com",
                "example1.com",
            ],
        },
        {
            "header": "Host1",
            "values": [
                "example3.com",
                "example11.com",
            ],
        },
    ])
Copy
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.NewCisHealthcheck(ctx, "test", &ibm.CisHealthcheckArgs{
			CisId:         pulumi.Any(ibm_cis.Instance.Id),
			ExpectedBody:  pulumi.String("alive"),
			ExpectedCodes: pulumi.String("2xx"),
			Method:        pulumi.String("GET"),
			Timeout:       pulumi.Float64(7),
			Path:          pulumi.String("/health"),
			Interval:      pulumi.Float64(60),
			Retries:       pulumi.Float64(3),
			Description:   pulumi.String("example load balancer"),
			Headers: ibm.CisHealthcheckHeaderArray{
				&ibm.CisHealthcheckHeaderArgs{
					Header: pulumi.String("Host"),
					Values: pulumi.StringArray{
						pulumi.String("example.com"),
						pulumi.String("example1.com"),
					},
				},
				&ibm.CisHealthcheckHeaderArgs{
					Header: pulumi.String("Host1"),
					Values: pulumi.StringArray{
						pulumi.String("example3.com"),
						pulumi.String("example11.com"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var test = new Ibm.CisHealthcheck("test", new()
    {
        CisId = ibm_cis.Instance.Id,
        ExpectedBody = "alive",
        ExpectedCodes = "2xx",
        Method = "GET",
        Timeout = 7,
        Path = "/health",
        Interval = 60,
        Retries = 3,
        Description = "example load balancer",
        Headers = new[]
        {
            new Ibm.Inputs.CisHealthcheckHeaderArgs
            {
                Header = "Host",
                Values = new[]
                {
                    "example.com",
                    "example1.com",
                },
            },
            new Ibm.Inputs.CisHealthcheckHeaderArgs
            {
                Header = "Host1",
                Values = new[]
                {
                    "example3.com",
                    "example11.com",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CisHealthcheck;
import com.pulumi.ibm.CisHealthcheckArgs;
import com.pulumi.ibm.inputs.CisHealthcheckHeaderArgs;
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 = new CisHealthcheck("test", CisHealthcheckArgs.builder()
            .cisId(ibm_cis.instance().id())
            .expectedBody("alive")
            .expectedCodes("2xx")
            .method("GET")
            .timeout(7)
            .path("/health")
            .interval(60)
            .retries(3)
            .description("example load balancer")
            .headers(            
                CisHealthcheckHeaderArgs.builder()
                    .header("Host")
                    .values(                    
                        "example.com",
                        "example1.com")
                    .build(),
                CisHealthcheckHeaderArgs.builder()
                    .header("Host1")
                    .values(                    
                        "example3.com",
                        "example11.com")
                    .build())
            .build());

    }
}
Copy
resources:
  test:
    type: ibm:CisHealthcheck
    properties:
      cisId: ${ibm_cis.instance.id}
      expectedBody: alive
      expectedCodes: 2xx
      method: GET
      timeout: 7
      path: /health
      interval: 60
      retries: 3
      description: example load balancer
      headers:
        - header: Host
          values:
            - example.com
            - example1.com
        - header: Host1
          values:
            - example3.com
            - example11.com
Copy

Create CisHealthcheck Resource

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

Constructor syntax

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

@overload
def CisHealthcheck(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cis_id: Optional[str] = None,
                   follow_redirects: Optional[bool] = None,
                   interval: Optional[float] = None,
                   description: Optional[str] = None,
                   expected_body: Optional[str] = None,
                   expected_codes: Optional[str] = None,
                   allow_insecure: Optional[bool] = None,
                   headers: Optional[Sequence[CisHealthcheckHeaderArgs]] = None,
                   cis_healthcheck_id: Optional[str] = None,
                   method: Optional[str] = None,
                   path: Optional[str] = None,
                   port: Optional[float] = None,
                   retries: Optional[float] = None,
                   timeout: Optional[float] = None,
                   type: Optional[str] = None)
func NewCisHealthcheck(ctx *Context, name string, args CisHealthcheckArgs, opts ...ResourceOption) (*CisHealthcheck, error)
public CisHealthcheck(string name, CisHealthcheckArgs args, CustomResourceOptions? opts = null)
public CisHealthcheck(String name, CisHealthcheckArgs args)
public CisHealthcheck(String name, CisHealthcheckArgs args, CustomResourceOptions options)
type: ibm:CisHealthcheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CisHealthcheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CisHealthcheckArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CisHealthcheckArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CisHealthcheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CisHealthcheckArgs
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 cisHealthcheckResource = new Ibm.CisHealthcheck("cisHealthcheckResource", new()
{
    CisId = "string",
    FollowRedirects = false,
    Interval = 0,
    Description = "string",
    ExpectedBody = "string",
    ExpectedCodes = "string",
    AllowInsecure = false,
    Headers = new[]
    {
        new Ibm.Inputs.CisHealthcheckHeaderArgs
        {
            Header = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    CisHealthcheckId = "string",
    Method = "string",
    Path = "string",
    Port = 0,
    Retries = 0,
    Timeout = 0,
    Type = "string",
});
Copy
example, err := ibm.NewCisHealthcheck(ctx, "cisHealthcheckResource", &ibm.CisHealthcheckArgs{
	CisId:           pulumi.String("string"),
	FollowRedirects: pulumi.Bool(false),
	Interval:        pulumi.Float64(0),
	Description:     pulumi.String("string"),
	ExpectedBody:    pulumi.String("string"),
	ExpectedCodes:   pulumi.String("string"),
	AllowInsecure:   pulumi.Bool(false),
	Headers: ibm.CisHealthcheckHeaderArray{
		&ibm.CisHealthcheckHeaderArgs{
			Header: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	CisHealthcheckId: pulumi.String("string"),
	Method:           pulumi.String("string"),
	Path:             pulumi.String("string"),
	Port:             pulumi.Float64(0),
	Retries:          pulumi.Float64(0),
	Timeout:          pulumi.Float64(0),
	Type:             pulumi.String("string"),
})
Copy
var cisHealthcheckResource = new CisHealthcheck("cisHealthcheckResource", CisHealthcheckArgs.builder()
    .cisId("string")
    .followRedirects(false)
    .interval(0)
    .description("string")
    .expectedBody("string")
    .expectedCodes("string")
    .allowInsecure(false)
    .headers(CisHealthcheckHeaderArgs.builder()
        .header("string")
        .values("string")
        .build())
    .cisHealthcheckId("string")
    .method("string")
    .path("string")
    .port(0)
    .retries(0)
    .timeout(0)
    .type("string")
    .build());
Copy
cis_healthcheck_resource = ibm.CisHealthcheck("cisHealthcheckResource",
    cis_id="string",
    follow_redirects=False,
    interval=0,
    description="string",
    expected_body="string",
    expected_codes="string",
    allow_insecure=False,
    headers=[{
        "header": "string",
        "values": ["string"],
    }],
    cis_healthcheck_id="string",
    method="string",
    path="string",
    port=0,
    retries=0,
    timeout=0,
    type="string")
Copy
const cisHealthcheckResource = new ibm.CisHealthcheck("cisHealthcheckResource", {
    cisId: "string",
    followRedirects: false,
    interval: 0,
    description: "string",
    expectedBody: "string",
    expectedCodes: "string",
    allowInsecure: false,
    headers: [{
        header: "string",
        values: ["string"],
    }],
    cisHealthcheckId: "string",
    method: "string",
    path: "string",
    port: 0,
    retries: 0,
    timeout: 0,
    type: "string",
});
Copy
type: ibm:CisHealthcheck
properties:
    allowInsecure: false
    cisHealthcheckId: string
    cisId: string
    description: string
    expectedBody: string
    expectedCodes: string
    followRedirects: false
    headers:
        - header: string
          values:
            - string
    interval: 0
    method: string
    path: string
    port: 0
    retries: 0
    timeout: 0
    type: string
Copy

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

CisId This property is required. string
The ID of the IBM Cloud Internet Services instance.
AllowInsecure bool
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
CisHealthcheckId string
(String) The ID of the load balancer to monitor.
Description string
A description for your health check.
ExpectedBody string
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
ExpectedCodes string
The expected HTTP response code or code range of the health check. For example, 200.
FollowRedirects bool
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
Headers List<CisHealthcheckHeader>

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

Interval double
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
Method string
The HTTP method to use for the health check. Default: GET.
Path string
The endpoint path to health check against. Default: /.
Port double
The TCP port number that you want to use for the health check.
Retries double
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
Timeout double
The timeout in seconds before marking the health check as failed. Default: 5.
Type string
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
CisId This property is required. string
The ID of the IBM Cloud Internet Services instance.
AllowInsecure bool
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
CisHealthcheckId string
(String) The ID of the load balancer to monitor.
Description string
A description for your health check.
ExpectedBody string
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
ExpectedCodes string
The expected HTTP response code or code range of the health check. For example, 200.
FollowRedirects bool
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
Headers []CisHealthcheckHeaderArgs

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

Interval float64
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
Method string
The HTTP method to use for the health check. Default: GET.
Path string
The endpoint path to health check against. Default: /.
Port float64
The TCP port number that you want to use for the health check.
Retries float64
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
Timeout float64
The timeout in seconds before marking the health check as failed. Default: 5.
Type string
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
cisId This property is required. String
The ID of the IBM Cloud Internet Services instance.
allowInsecure Boolean
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
cisHealthcheckId String
(String) The ID of the load balancer to monitor.
description String
A description for your health check.
expectedBody String
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
expectedCodes String
The expected HTTP response code or code range of the health check. For example, 200.
followRedirects Boolean
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
headers List<CisHealthcheckHeader>

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

interval Double
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
method String
The HTTP method to use for the health check. Default: GET.
path String
The endpoint path to health check against. Default: /.
port Double
The TCP port number that you want to use for the health check.
retries Double
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
timeout Double
The timeout in seconds before marking the health check as failed. Default: 5.
type String
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
cisId This property is required. string
The ID of the IBM Cloud Internet Services instance.
allowInsecure boolean
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
cisHealthcheckId string
(String) The ID of the load balancer to monitor.
description string
A description for your health check.
expectedBody string
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
expectedCodes string
The expected HTTP response code or code range of the health check. For example, 200.
followRedirects boolean
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
headers CisHealthcheckHeader[]

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

interval number
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
method string
The HTTP method to use for the health check. Default: GET.
path string
The endpoint path to health check against. Default: /.
port number
The TCP port number that you want to use for the health check.
retries number
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
timeout number
The timeout in seconds before marking the health check as failed. Default: 5.
type string
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
cis_id This property is required. str
The ID of the IBM Cloud Internet Services instance.
allow_insecure bool
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
cis_healthcheck_id str
(String) The ID of the load balancer to monitor.
description str
A description for your health check.
expected_body str
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
expected_codes str
The expected HTTP response code or code range of the health check. For example, 200.
follow_redirects bool
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
headers Sequence[CisHealthcheckHeaderArgs]

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

interval float
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
method str
The HTTP method to use for the health check. Default: GET.
path str
The endpoint path to health check against. Default: /.
port float
The TCP port number that you want to use for the health check.
retries float
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
timeout float
The timeout in seconds before marking the health check as failed. Default: 5.
type str
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
cisId This property is required. String
The ID of the IBM Cloud Internet Services instance.
allowInsecure Boolean
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
cisHealthcheckId String
(String) The ID of the load balancer to monitor.
description String
A description for your health check.
expectedBody String
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
expectedCodes String
The expected HTTP response code or code range of the health check. For example, 200.
followRedirects Boolean
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
headers List<Property Map>

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

interval Number
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
method String
The HTTP method to use for the health check. Default: GET.
path String
The endpoint path to health check against. Default: /.
port Number
The TCP port number that you want to use for the health check.
retries Number
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
timeout Number
The timeout in seconds before marking the health check as failed. Default: 5.
type String
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.

Outputs

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

CreateOn string
Id string
The provider-assigned unique ID for this managed resource.
ModifiedOn string
(String) The RFC3339 timestamp of when the health check was last modified.
MonitorId string
(String) The load balancer monitor ID.
CreateOn string
Id string
The provider-assigned unique ID for this managed resource.
ModifiedOn string
(String) The RFC3339 timestamp of when the health check was last modified.
MonitorId string
(String) The load balancer monitor ID.
createOn String
id String
The provider-assigned unique ID for this managed resource.
modifiedOn String
(String) The RFC3339 timestamp of when the health check was last modified.
monitorId String
(String) The load balancer monitor ID.
createOn string
id string
The provider-assigned unique ID for this managed resource.
modifiedOn string
(String) The RFC3339 timestamp of when the health check was last modified.
monitorId string
(String) The load balancer monitor ID.
create_on str
id str
The provider-assigned unique ID for this managed resource.
modified_on str
(String) The RFC3339 timestamp of when the health check was last modified.
monitor_id str
(String) The load balancer monitor ID.
createOn String
id String
The provider-assigned unique ID for this managed resource.
modifiedOn String
(String) The RFC3339 timestamp of when the health check was last modified.
monitorId String
(String) The load balancer monitor ID.

Look up Existing CisHealthcheck Resource

Get an existing CisHealthcheck 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?: CisHealthcheckState, opts?: CustomResourceOptions): CisHealthcheck
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_insecure: Optional[bool] = None,
        cis_healthcheck_id: Optional[str] = None,
        cis_id: Optional[str] = None,
        create_on: Optional[str] = None,
        description: Optional[str] = None,
        expected_body: Optional[str] = None,
        expected_codes: Optional[str] = None,
        follow_redirects: Optional[bool] = None,
        headers: Optional[Sequence[CisHealthcheckHeaderArgs]] = None,
        interval: Optional[float] = None,
        method: Optional[str] = None,
        modified_on: Optional[str] = None,
        monitor_id: Optional[str] = None,
        path: Optional[str] = None,
        port: Optional[float] = None,
        retries: Optional[float] = None,
        timeout: Optional[float] = None,
        type: Optional[str] = None) -> CisHealthcheck
func GetCisHealthcheck(ctx *Context, name string, id IDInput, state *CisHealthcheckState, opts ...ResourceOption) (*CisHealthcheck, error)
public static CisHealthcheck Get(string name, Input<string> id, CisHealthcheckState? state, CustomResourceOptions? opts = null)
public static CisHealthcheck get(String name, Output<String> id, CisHealthcheckState state, CustomResourceOptions options)
resources:  _:    type: ibm:CisHealthcheck    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
CisHealthcheckId string
(String) The ID of the load balancer to monitor.
CisId string
The ID of the IBM Cloud Internet Services instance.
CreateOn string
Description string
A description for your health check.
ExpectedBody string
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
ExpectedCodes string
The expected HTTP response code or code range of the health check. For example, 200.
FollowRedirects bool
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
Headers List<CisHealthcheckHeader>

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

Interval double
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
Method string
The HTTP method to use for the health check. Default: GET.
ModifiedOn string
(String) The RFC3339 timestamp of when the health check was last modified.
MonitorId string
(String) The load balancer monitor ID.
Path string
The endpoint path to health check against. Default: /.
Port double
The TCP port number that you want to use for the health check.
Retries double
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
Timeout double
The timeout in seconds before marking the health check as failed. Default: 5.
Type string
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
AllowInsecure bool
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
CisHealthcheckId string
(String) The ID of the load balancer to monitor.
CisId string
The ID of the IBM Cloud Internet Services instance.
CreateOn string
Description string
A description for your health check.
ExpectedBody string
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
ExpectedCodes string
The expected HTTP response code or code range of the health check. For example, 200.
FollowRedirects bool
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
Headers []CisHealthcheckHeaderArgs

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

Interval float64
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
Method string
The HTTP method to use for the health check. Default: GET.
ModifiedOn string
(String) The RFC3339 timestamp of when the health check was last modified.
MonitorId string
(String) The load balancer monitor ID.
Path string
The endpoint path to health check against. Default: /.
Port float64
The TCP port number that you want to use for the health check.
Retries float64
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
Timeout float64
The timeout in seconds before marking the health check as failed. Default: 5.
Type string
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
allowInsecure Boolean
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
cisHealthcheckId String
(String) The ID of the load balancer to monitor.
cisId String
The ID of the IBM Cloud Internet Services instance.
createOn String
description String
A description for your health check.
expectedBody String
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
expectedCodes String
The expected HTTP response code or code range of the health check. For example, 200.
followRedirects Boolean
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
headers List<CisHealthcheckHeader>

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

interval Double
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
method String
The HTTP method to use for the health check. Default: GET.
modifiedOn String
(String) The RFC3339 timestamp of when the health check was last modified.
monitorId String
(String) The load balancer monitor ID.
path String
The endpoint path to health check against. Default: /.
port Double
The TCP port number that you want to use for the health check.
retries Double
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
timeout Double
The timeout in seconds before marking the health check as failed. Default: 5.
type String
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
allowInsecure boolean
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
cisHealthcheckId string
(String) The ID of the load balancer to monitor.
cisId string
The ID of the IBM Cloud Internet Services instance.
createOn string
description string
A description for your health check.
expectedBody string
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
expectedCodes string
The expected HTTP response code or code range of the health check. For example, 200.
followRedirects boolean
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
headers CisHealthcheckHeader[]

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

interval number
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
method string
The HTTP method to use for the health check. Default: GET.
modifiedOn string
(String) The RFC3339 timestamp of when the health check was last modified.
monitorId string
(String) The load balancer monitor ID.
path string
The endpoint path to health check against. Default: /.
port number
The TCP port number that you want to use for the health check.
retries number
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
timeout number
The timeout in seconds before marking the health check as failed. Default: 5.
type string
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
allow_insecure bool
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
cis_healthcheck_id str
(String) The ID of the load balancer to monitor.
cis_id str
The ID of the IBM Cloud Internet Services instance.
create_on str
description str
A description for your health check.
expected_body str
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
expected_codes str
The expected HTTP response code or code range of the health check. For example, 200.
follow_redirects bool
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
headers Sequence[CisHealthcheckHeaderArgs]

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

interval float
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
method str
The HTTP method to use for the health check. Default: GET.
modified_on str
(String) The RFC3339 timestamp of when the health check was last modified.
monitor_id str
(String) The load balancer monitor ID.
path str
The endpoint path to health check against. Default: /.
port float
The TCP port number that you want to use for the health check.
retries float
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
timeout float
The timeout in seconds before marking the health check as failed. Default: 5.
type str
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.
allowInsecure Boolean
If set to true, the certificate is not validated when the health check uses HTTPS. If set to false, the certificate is validated, even if the health check uses HTTPS. The default value is false.
cisHealthcheckId String
(String) The ID of the load balancer to monitor.
cisId String
The ID of the IBM Cloud Internet Services instance.
createOn String
description String
A description for your health check.
expectedBody String
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. A null value of “” is allowed to match on any content.
expectedCodes String
The expected HTTP response code or code range of the health check. For example, 200.
followRedirects Boolean
If set to true, a redirect is followed when a redirect is returned by the origin pool. Is set to false, redirects from the origin pool are not followed.
headers List<Property Map>

The health check headers. Header is not currently supported in this version of the provider.

Nested scheme for headers:

interval Number
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. The default value is 60.
method String
The HTTP method to use for the health check. Default: GET.
modifiedOn String
(String) The RFC3339 timestamp of when the health check was last modified.
monitorId String
(String) The load balancer monitor ID.
path String
The endpoint path to health check against. Default: /.
port Number
The TCP port number that you want to use for the health check.
retries Number
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default: 2.
timeout Number
The timeout in seconds before marking the health check as failed. Default: 5.
type String
The protocol to use for the health check. Currently supported protocols are http and https. Default: http.

Supporting Types

CisHealthcheckHeader
, CisHealthcheckHeaderArgs

Header This property is required. string
The value of a header.
Values This property is required. List<string>
The list of values for a header field. [expected_body], and [expected_codes] are required arguments when the type is HTTP or HTTPS. Note Header is not currently supported in this version of the provider.
Header This property is required. string
The value of a header.
Values This property is required. []string
The list of values for a header field. [expected_body], and [expected_codes] are required arguments when the type is HTTP or HTTPS. Note Header is not currently supported in this version of the provider.
header This property is required. String
The value of a header.
values This property is required. List<String>
The list of values for a header field. [expected_body], and [expected_codes] are required arguments when the type is HTTP or HTTPS. Note Header is not currently supported in this version of the provider.
header This property is required. string
The value of a header.
values This property is required. string[]
The list of values for a header field. [expected_body], and [expected_codes] are required arguments when the type is HTTP or HTTPS. Note Header is not currently supported in this version of the provider.
header This property is required. str
The value of a header.
values This property is required. Sequence[str]
The list of values for a header field. [expected_body], and [expected_codes] are required arguments when the type is HTTP or HTTPS. Note Header is not currently supported in this version of the provider.
header This property is required. String
The value of a header.
values This property is required. List<String>
The list of values for a header field. [expected_body], and [expected_codes] are required arguments when the type is HTTP or HTTPS. Note Header is not currently supported in this version of the provider.

Import

The ibm_cis_health_check resource can be imported by using the id. The ID is formed from the Healthcheck Id and the CRN (Cloud Resource Name) concatentated usinga : character.

The CRN will be located on the Overview page of the Internet Services instance under the Domain heading.

  • 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::

  • Healthcheck ID The health check ID is a 32 digit character string in the format 1aaaa111111aa11111111111a1a11a1. The ID of a health check 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-monitors.

Syntax

$ pulumi import ibm:index/cisHealthcheck:CisHealthcheck myorg <id>:<crn>
Copy

Example

$ pulumi import ibm:index/cisHealthcheck:CisHealthcheck myorg 1fc7c3247067ee00856729661c7d58c9:crn:v1:bluemix:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::
Copy

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.