Docs Home
ibm 1.78.0 published on Wednesday, Apr 30, 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",
],
},
],
});
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",
],
},
])
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
})
}
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",
},
},
},
});
});
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());
}
}
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
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 string
- The unique name of the resource.
- args CisHealthcheckArgs
- 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 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 string
- The unique name of the resource.
- args CisHealthcheckArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CisHealthcheckArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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"),
})
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());
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")
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",
});
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
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:
- Cis
Id string - 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 stringId - (String) The ID of the load balancer to monitor.
- Description string
- A description for your health check.
- Expected
Body 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.
- Expected
Codes string - 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
List<Cis
Healthcheck Header> 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
httpandhttps. Default:http.
- Cis
Id string - 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 stringId - (String) The ID of the load balancer to monitor.
- Description string
- A description for your health check.
- Expected
Body 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.
- Expected
Codes string - 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
[]Cis
Healthcheck Header Args 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
httpandhttps. Default:http.
- cis
Id String - The ID of the IBM Cloud Internet Services instance.
- allow
Insecure 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.
- cis
Healthcheck StringId - (String) The ID of the load balancer to monitor.
- description String
- A description for your health check.
- expected
Body 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.
- expected
Codes String - The expected HTTP response code or code range of the health check. For example, 200.
- follow
Redirects 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<Cis
Healthcheck Header> 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
httpandhttps. Default:http.
- cis
Id string - The ID of the IBM Cloud Internet Services instance.
- allow
Insecure 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.
- cis
Healthcheck stringId - (String) The ID of the load balancer to monitor.
- description string
- A description for your health check.
- expected
Body 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.
- expected
Codes string - The expected HTTP response code or code range of the health check. For example, 200.
- follow
Redirects 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
Cis
Healthcheck Header[] 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
httpandhttps. Default:http.
- cis_
id 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_ strid - (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[Cis
Healthcheck Header Args] 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
httpandhttps. Default:http.
- cis
Id String - The ID of the IBM Cloud Internet Services instance.
- allow
Insecure 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.
- cis
Healthcheck StringId - (String) The ID of the load balancer to monitor.
- description String
- A description for your health check.
- expected
Body 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.
- expected
Codes String - The expected HTTP response code or code range of the health check. For example, 200.
- follow
Redirects 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
httpandhttps. Default:http.
Outputs
All input properties are implicitly available as output properties. Additionally, the CisHealthcheck resource produces the following output properties:
- Create
On string - Id string
- The provider-assigned unique ID for this managed resource.
- Modified
On string - (String) The RFC3339 timestamp of when the health check was last modified.
- Monitor
Id string - (String) The load balancer monitor ID.
- Create
On string - Id string
- The provider-assigned unique ID for this managed resource.
- Modified
On string - (String) The RFC3339 timestamp of when the health check was last modified.
- Monitor
Id string - (String) The load balancer monitor ID.
- create
On String - id String
- The provider-assigned unique ID for this managed resource.
- modified
On String - (String) The RFC3339 timestamp of when the health check was last modified.
- monitor
Id String - (String) The load balancer monitor ID.
- create
On string - id string
- The provider-assigned unique ID for this managed resource.
- modified
On string - (String) The RFC3339 timestamp of when the health check was last modified.
- monitor
Id 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.
- create
On String - id String
- The provider-assigned unique ID for this managed resource.
- modified
On String - (String) The RFC3339 timestamp of when the health check was last modified.
- monitor
Id 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) -> CisHealthcheckfunc 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
- 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.
- 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 stringId - (String) The ID of the load balancer to monitor.
- Cis
Id string - The ID of the IBM Cloud Internet Services instance.
- Create
On string - Description string
- A description for your health check.
- Expected
Body 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.
- Expected
Codes string - 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
List<Cis
Healthcheck Header> 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. - Modified
On string - (String) The RFC3339 timestamp of when the health check was last modified.
- Monitor
Id 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
httpandhttps. 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 stringId - (String) The ID of the load balancer to monitor.
- Cis
Id string - The ID of the IBM Cloud Internet Services instance.
- Create
On string - Description string
- A description for your health check.
- Expected
Body 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.
- Expected
Codes string - 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
[]Cis
Healthcheck Header Args 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. - Modified
On string - (String) The RFC3339 timestamp of when the health check was last modified.
- Monitor
Id 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
httpandhttps. Default:http.
- allow
Insecure 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.
- cis
Healthcheck StringId - (String) The ID of the load balancer to monitor.
- cis
Id String - The ID of the IBM Cloud Internet Services instance.
- create
On String - description String
- A description for your health check.
- expected
Body 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.
- expected
Codes String - The expected HTTP response code or code range of the health check. For example, 200.
- follow
Redirects 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<Cis
Healthcheck Header> 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. - modified
On String - (String) The RFC3339 timestamp of when the health check was last modified.
- monitor
Id 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
httpandhttps. Default:http.
- allow
Insecure 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.
- cis
Healthcheck stringId - (String) The ID of the load balancer to monitor.
- cis
Id string - The ID of the IBM Cloud Internet Services instance.
- create
On string - description string
- A description for your health check.
- expected
Body 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.
- expected
Codes string - The expected HTTP response code or code range of the health check. For example, 200.
- follow
Redirects 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
Cis
Healthcheck Header[] 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. - modified
On string - (String) The RFC3339 timestamp of when the health check was last modified.
- monitor
Id 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
httpandhttps. 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_ strid - (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[Cis
Healthcheck Header Args] 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
httpandhttps. Default:http.
- allow
Insecure 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.
- cis
Healthcheck StringId - (String) The ID of the load balancer to monitor.
- cis
Id String - The ID of the IBM Cloud Internet Services instance.
- create
On String - description String
- A description for your health check.
- expected
Body 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.
- expected
Codes String - The expected HTTP response code or code range of the health check. For example, 200.
- follow
Redirects 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. - modified
On String - (String) The RFC3339 timestamp of when the health check was last modified.
- monitor
Id 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
httpandhttps. Default:http.
Supporting Types
CisHealthcheckHeader, CisHealthcheckHeaderArgs
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>
Example
$ pulumi import ibm:index/cisHealthcheck:CisHealthcheck myorg 1fc7c3247067ee00856729661c7d58c9:crn:v1:bluemix:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::
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
ibmTerraform Provider.