ibm 1.77.1, Apr 14 25

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getCisHealthchecks

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

Using getCisHealthchecks

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getCisHealthchecks(args: GetCisHealthchecksArgs, opts?: InvokeOptions): Promise<GetCisHealthchecksResult>
function getCisHealthchecksOutput(args: GetCisHealthchecksOutputArgs, opts?: InvokeOptions): Output<GetCisHealthchecksResult>

def get_cis_healthchecks(cis_id: Optional[str] = None,
                         id: Optional[str] = None,
                         timeouts: Optional[GetCisHealthchecksTimeouts] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCisHealthchecksResult
def get_cis_healthchecks_output(cis_id: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         timeouts: Optional[pulumi.Input[GetCisHealthchecksTimeoutsArgs]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCisHealthchecksResult]

func GetCisHealthchecks(ctx *Context, args *GetCisHealthchecksArgs, opts ...InvokeOption) (*GetCisHealthchecksResult, error)
func GetCisHealthchecksOutput(ctx *Context, args *GetCisHealthchecksOutputArgs, opts ...InvokeOption) GetCisHealthchecksResultOutput

> Note: This function is named GetCisHealthchecks in the Go SDK.

public static class GetCisHealthchecks 
{
    public static Task<GetCisHealthchecksResult> InvokeAsync(GetCisHealthchecksArgs args, InvokeOptions? opts = null)
    public static Output<GetCisHealthchecksResult> Invoke(GetCisHealthchecksInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCisHealthchecksResult> getCisHealthchecks(GetCisHealthchecksArgs args, InvokeOptions options)
public static Output<GetCisHealthchecksResult> getCisHealthchecks(GetCisHealthchecksArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getCisHealthchecks:getCisHealthchecks
  arguments:
    # arguments dictionary

The following arguments are supported:

CisId string: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
Id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Timeouts GetCisHealthchecksTimeouts

CisId string: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
Id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Timeouts GetCisHealthchecksTimeouts

cisId String: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
id String: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts

cisId string: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts

cis_id str: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
id str: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts

cisId String: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
id String: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts Property Map

getCisHealthchecks Result

The following output properties are available:

CisHealthchecks List<GetCisHealthchecksCisHealthcheck>
CisId string
Id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Timeouts GetCisHealthchecksTimeouts

CisHealthchecks []GetCisHealthchecksCisHealthcheck
CisId string
Id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Timeouts GetCisHealthchecksTimeouts

cisHealthchecks List<GetCisHealthchecksCisHealthcheck>
cisId String
id String: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts

cisHealthchecks GetCisHealthchecksCisHealthcheck[]
cisId string
id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts

cis_healthchecks Sequence[GetCisHealthchecksCisHealthcheck]
cis_id str
id str: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts

cisHealthchecks List<Property Map>
cisId String
id String: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts Property Map

Supporting Types

GetCisHealthchecksCisHealthcheck

AllowInsecure bool: (String) Do not validate the certificate when health check uses HTTPS.
CisId string: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
CreateOn string
Description string: (String) Free text description.
ExpectedBody string: (String) The requested body.
ExpectedCodes string: (String) The expected HTTP response code or code range of the health check. For example, 2xx.
FollowRedirects bool: (String) Follow redirects if returned by the origin.
Headers List<GetCisHealthchecksCisHealthcheckHeader>: (String) The health check header.
Id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Interval double: (String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
Method string: (String) The HTTP method to use for the health check.
ModifiedOn string: (String) The RFC3339 timestamp of when the load balancer monitor was last modified.
MonitorId string: (String) The load balancer monitor ID.
Path string: (String) The endpoint path to health check.
Port double: (String) The TCP port to use for the health check.
Retries double: (String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
Timeout double: (String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
Type string: (String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.

AllowInsecure bool: (String) Do not validate the certificate when health check uses HTTPS.
CisId string: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
CreateOn string
Description string: (String) Free text description.
ExpectedBody string: (String) The requested body.
ExpectedCodes string: (String) The expected HTTP response code or code range of the health check. For example, 2xx.
FollowRedirects bool: (String) Follow redirects if returned by the origin.
Headers []GetCisHealthchecksCisHealthcheckHeader: (String) The health check header.
Id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Interval float64: (String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
Method string: (String) The HTTP method to use for the health check.
ModifiedOn string: (String) The RFC3339 timestamp of when the load balancer monitor was last modified.
MonitorId string: (String) The load balancer monitor ID.
Path string: (String) The endpoint path to health check.
Port float64: (String) The TCP port to use for the health check.
Retries float64: (String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
Timeout float64: (String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
Type string: (String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.

allowInsecure Boolean: (String) Do not validate the certificate when health check uses HTTPS.
cisId String: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
createOn String
description String: (String) Free text description.
expectedBody String: (String) The requested body.
expectedCodes String: (String) The expected HTTP response code or code range of the health check. For example, 2xx.
followRedirects Boolean: (String) Follow redirects if returned by the origin.
headers List<GetCisHealthchecksCisHealthcheckHeader>: (String) The health check header.
id String: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
interval Double: (String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
method String: (String) The HTTP method to use for the health check.
modifiedOn String: (String) The RFC3339 timestamp of when the load balancer monitor was last modified.
monitorId String: (String) The load balancer monitor ID.
path String: (String) The endpoint path to health check.
port Double: (String) The TCP port to use for the health check.
retries Double: (String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
timeout Double: (String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
type String: (String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.

allowInsecure boolean: (String) Do not validate the certificate when health check uses HTTPS.
cisId string: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
createOn string
description string: (String) Free text description.
expectedBody string: (String) The requested body.
expectedCodes string: (String) The expected HTTP response code or code range of the health check. For example, 2xx.
followRedirects boolean: (String) Follow redirects if returned by the origin.
headers GetCisHealthchecksCisHealthcheckHeader[]: (String) The health check header.
id string: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
interval number: (String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
method string: (String) The HTTP method to use for the health check.
modifiedOn string: (String) The RFC3339 timestamp of when the load balancer monitor was last modified.
monitorId string: (String) The load balancer monitor ID.
path string: (String) The endpoint path to health check.
port number: (String) The TCP port to use for the health check.
retries number: (String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
timeout number: (String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
type string: (String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.

allow_insecure bool: (String) Do not validate the certificate when health check uses HTTPS.
cis_id str: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
create_on str
description str: (String) Free text description.
expected_body str: (String) The requested body.
expected_codes str: (String) The expected HTTP response code or code range of the health check. For example, 2xx.
follow_redirects bool: (String) Follow redirects if returned by the origin.
headers Sequence[GetCisHealthchecksCisHealthcheckHeader]: (String) The health check header.
id str: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
interval float: (String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
method str: (String) The HTTP method to use for the health check.
modified_on str: (String) The RFC3339 timestamp of when the load balancer monitor was last modified.
monitor_id str: (String) The load balancer monitor ID.
path str: (String) The endpoint path to health check.
port float: (String) The TCP port to use for the health check.
retries float: (String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
timeout float: (String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
type str: (String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.

allowInsecure Boolean: (String) Do not validate the certificate when health check uses HTTPS.
cisId String: The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
createOn String
description String: (String) Free text description.
expectedBody String: (String) The requested body.
expectedCodes String: (String) The expected HTTP response code or code range of the health check. For example, 2xx.
followRedirects Boolean: (String) Follow redirects if returned by the origin.
headers List<Property Map>: (String) The health check header.
id String: (String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
interval Number: (String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
method String: (String) The HTTP method to use for the health check.
modifiedOn String: (String) The RFC3339 timestamp of when the load balancer monitor was last modified.
monitorId String: (String) The load balancer monitor ID.
path String: (String) The endpoint path to health check.
port Number: (String) The TCP port to use for the health check.
retries Number: (String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
timeout Number: (String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
type String: (String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.

GetCisHealthchecksCisHealthcheckHeader

Header string
Values List<string>

Header string
Values []string

header String
values List<String>

header string
values string[]

header str
values Sequence[str]

header String
values List<String>

GetCisHealthchecksTimeouts

Read string

Read string

read String

read string

read str

read String

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.getCisHealthchecks

On this page

On this page

Using getCisHealthchecks

getCisHealthchecks Result

Supporting Types

GetCisHealthchecksCisHealthcheck

GetCisHealthchecksCisHealthcheckHeader

GetCisHealthchecksTimeouts

Package Details

On this page

On this page