UptimeCheckConfig

This message configures which resources and services to monitor for availability.

To get more information about UptimeCheckConfig, see:

API documentation
How-to Guides
- Official Documentation

Warning: All arguments including http_check.auth_info.password will be stored in the raw state as plain-text. Read more about secrets in state.

Create a UptimeCheckConfig Resource

new UptimeCheckConfig(name: string, args: UptimeCheckConfigArgs, opts?: CustomResourceOptions);

def UptimeCheckConfig(resource_name, opts=None, content_matchers=None, display_name=None, http_check=None, monitored_resource=None, period=None, project=None, resource_group=None, selected_regions=None, tcp_check=None, timeout=None, __props__=None);

func NewUptimeCheckConfig(ctx *Context, name string, args UptimeCheckConfigArgs, opts ...ResourceOption) (*UptimeCheckConfig, error)

public UptimeCheckConfig(string name, UptimeCheckConfigArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args UptimeCheckConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UptimeCheckConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UptimeCheckConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

UptimeCheckConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The UptimeCheckConfig resource accepts the following input properties:

DisplayName string: A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
Timeout string: The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
ContentMatchers List<UptimeCheckConfigContentMatcherArgs>: The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.
HttpCheck UptimeCheckConfigHttpCheckArgs: Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
MonitoredResource UptimeCheckConfigMonitoredResourceArgs: The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer Structure is documented below.
Period string: How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ResourceGroup UptimeCheckConfigResourceGroupArgs: The group resource associated with the configuration. Structure is documented below.
SelectedRegions List<string>: The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
TcpCheck UptimeCheckConfigTcpCheckArgs: Contains information needed to make a TCP check. Structure is documented below.

DisplayName string: A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
Timeout string: The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
ContentMatchers []UptimeCheckConfigContentMatcher: The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.
HttpCheck UptimeCheckConfigHttpCheck: Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
MonitoredResource UptimeCheckConfigMonitoredResource: The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer Structure is documented below.
Period string: How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ResourceGroup UptimeCheckConfigResourceGroup: The group resource associated with the configuration. Structure is documented below.
SelectedRegions []string: The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
TcpCheck UptimeCheckConfigTcpCheck: Contains information needed to make a TCP check. Structure is documented below.

displayName string: A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
timeout string: The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
contentMatchers UptimeCheckConfigContentMatcher[]: The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.
httpCheck UptimeCheckConfigHttpCheck: Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
monitoredResource UptimeCheckConfigMonitoredResource: The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer Structure is documented below.
period string: How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
resourceGroup UptimeCheckConfigResourceGroup: The group resource associated with the configuration. Structure is documented below.
selectedRegions string[]: The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
tcpCheck UptimeCheckConfigTcpCheck: Contains information needed to make a TCP check. Structure is documented below.

display_name str: A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
timeout str: The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
content_matchers List[UptimeCheckConfigContentMatcher]: The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.
http_check Dict[UptimeCheckConfigHttpCheck]: Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
monitored_resource Dict[UptimeCheckConfigMonitoredResource]: The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer Structure is documented below.
period str: How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
resource_group Dict[UptimeCheckConfigResourceGroup]: The group resource associated with the configuration. Structure is documented below.
selected_regions List[str]: The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
tcp_check Dict[UptimeCheckConfigTcpCheck]: Contains information needed to make a TCP check. Structure is documented below.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Name string: A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
UptimeCheckId string: The id of the uptime check

Id string: The provider-assigned unique ID for this managed resource.
Name string: A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
UptimeCheckId string: The id of the uptime check

id string: The provider-assigned unique ID for this managed resource.
name string: A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
uptimeCheckId string: The id of the uptime check

id str: The provider-assigned unique ID for this managed resource.
name str: A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
uptime_check_id str: The id of the uptime check

Look up an Existing UptimeCheckConfig Resource

Get an existing UptimeCheckConfig 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?: UptimeCheckConfigState, opts?: CustomResourceOptions): UptimeCheckConfig

static get(resource_name, id, opts=None, content_matchers=None, display_name=None, http_check=None, monitored_resource=None, name=None, period=None, project=None, resource_group=None, selected_regions=None, tcp_check=None, timeout=None, uptime_check_id=None, __props__=None);

func GetUptimeCheckConfig(ctx *Context, name string, id IDInput, state *UptimeCheckConfigState, opts ...ResourceOption) (*UptimeCheckConfig, error)

public static UptimeCheckConfig Get(string name, Input<string> id, UptimeCheckConfigState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

ContentMatchers List<UptimeCheckConfigContentMatcherArgs>: The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.
DisplayName string: A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
HttpCheck UptimeCheckConfigHttpCheckArgs: Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
MonitoredResource UptimeCheckConfigMonitoredResourceArgs: The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer Structure is documented below.
Name string: A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
Period string: How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ResourceGroup UptimeCheckConfigResourceGroupArgs: The group resource associated with the configuration. Structure is documented below.
SelectedRegions List<string>: The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
TcpCheck UptimeCheckConfigTcpCheckArgs: Contains information needed to make a TCP check. Structure is documented below.
Timeout string: The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
UptimeCheckId string: The id of the uptime check

ContentMatchers []UptimeCheckConfigContentMatcher: The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.
DisplayName string: A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
HttpCheck UptimeCheckConfigHttpCheck: Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
MonitoredResource UptimeCheckConfigMonitoredResource: The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer Structure is documented below.
Name string: A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
Period string: How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ResourceGroup UptimeCheckConfigResourceGroup: The group resource associated with the configuration. Structure is documented below.
SelectedRegions []string: The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
TcpCheck UptimeCheckConfigTcpCheck: Contains information needed to make a TCP check. Structure is documented below.
Timeout string: The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
UptimeCheckId string: The id of the uptime check

contentMatchers UptimeCheckConfigContentMatcher[]: The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.
displayName string: A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
httpCheck UptimeCheckConfigHttpCheck: Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
monitoredResource UptimeCheckConfigMonitoredResource: The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer Structure is documented below.
name string: A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
period string: How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
resourceGroup UptimeCheckConfigResourceGroup: The group resource associated with the configuration. Structure is documented below.
selectedRegions string[]: The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
tcpCheck UptimeCheckConfigTcpCheck: Contains information needed to make a TCP check. Structure is documented below.
timeout string: The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
uptimeCheckId string: The id of the uptime check

content_matchers List[UptimeCheckConfigContentMatcher]: The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.
display_name str: A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
http_check Dict[UptimeCheckConfigHttpCheck]: Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
monitored_resource Dict[UptimeCheckConfigMonitoredResource]: The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer Structure is documented below.
name str: A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
period str: How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
resource_group Dict[UptimeCheckConfigResourceGroup]: The group resource associated with the configuration. Structure is documented below.
selected_regions List[str]: The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
tcp_check Dict[UptimeCheckConfigTcpCheck]: Contains information needed to make a TCP check. Structure is documented below.
timeout str: The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
uptime_check_id str: The id of the uptime check

Supporting Types

UptimeCheckConfigContentMatcher

See the input and output API doc for this type.

Content string: String or regex content to match (max 1024 bytes)
Matcher string: The type of content matcher that will be applied to the server output, compared to the content string when the check is run.

Content string: String or regex content to match (max 1024 bytes)
Matcher string: The type of content matcher that will be applied to the server output, compared to the content string when the check is run.

content string: String or regex content to match (max 1024 bytes)
matcher string: The type of content matcher that will be applied to the server output, compared to the content string when the check is run.

content str: String or regex content to match (max 1024 bytes)
matcher str: The type of content matcher that will be applied to the server output, compared to the content string when the check is run.

UptimeCheckConfigHttpCheck

See the input and output API doc for this type.

AuthInfo UptimeCheckConfigHttpCheckAuthInfoArgs: The authentication information. Optional when creating an HTTP check; defaults to empty. Structure is documented below.
Body string: The request body associated with the HTTP POST request. If contentType is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the requestMethod is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g. “foo=bar” in URL-encoded form is “foo%3Dbar” and in base64 encoding is “Zm9vJTI1M0RiYXI=”.
ContentType string: The content type to use for the check.
Headers Dictionary<string, string>: The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
MaskHeaders bool: Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.
Path string: The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to “/”).
Port int: The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.
RequestMethod string: The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then requestMethod defaults to GET.
UseSsl bool: If true, use HTTPS instead of HTTP to run the check.
ValidateSsl bool: Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect.

AuthInfo UptimeCheckConfigHttpCheckAuthInfo: The authentication information. Optional when creating an HTTP check; defaults to empty. Structure is documented below.
Body string: The request body associated with the HTTP POST request. If contentType is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the requestMethod is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g. “foo=bar” in URL-encoded form is “foo%3Dbar” and in base64 encoding is “Zm9vJTI1M0RiYXI=”.
ContentType string: The content type to use for the check.
Headers map[string]string: The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
MaskHeaders bool: Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.
Path string: The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to “/”).
Port int: The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.
RequestMethod string: The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then requestMethod defaults to GET.
UseSsl bool: If true, use HTTPS instead of HTTP to run the check.
ValidateSsl bool: Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect.

authInfo UptimeCheckConfigHttpCheckAuthInfo: The authentication information. Optional when creating an HTTP check; defaults to empty. Structure is documented below.
body string: The request body associated with the HTTP POST request. If contentType is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the requestMethod is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g. “foo=bar” in URL-encoded form is “foo%3Dbar” and in base64 encoding is “Zm9vJTI1M0RiYXI=”.
contentType string: The content type to use for the check.
headers {[key: string]: string}: The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
maskHeaders boolean: Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.
path string: The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to “/”).
port number: The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.
requestMethod string: The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then requestMethod defaults to GET.
useSsl boolean: If true, use HTTPS instead of HTTP to run the check.
validateSsl boolean: Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect.

authInfo Dict[UptimeCheckConfigHttpCheckAuthInfo]: The authentication information. Optional when creating an HTTP check; defaults to empty. Structure is documented below.
body str: The request body associated with the HTTP POST request. If contentType is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the requestMethod is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g. “foo=bar” in URL-encoded form is “foo%3Dbar” and in base64 encoding is “Zm9vJTI1M0RiYXI=”.
content_type str: The content type to use for the check.
headers Dict[str, str]: The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
maskHeaders bool: Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.
path str: The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to “/”).
port float: The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.
requestMethod str: The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then requestMethod defaults to GET.
useSsl bool: If true, use HTTPS instead of HTTP to run the check.
validateSsl bool: Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect.

UptimeCheckConfigHttpCheckAuthInfo

See the input and output API doc for this type.

Password string: The password to authenticate. Note: This property is sensitive and will not be displayed in the plan.
Username string: The username to authenticate.

Password string: The password to authenticate. Note: This property is sensitive and will not be displayed in the plan.
Username string: The username to authenticate.

password string: The password to authenticate. Note: This property is sensitive and will not be displayed in the plan.
username string: The username to authenticate.

password str: The password to authenticate. Note: This property is sensitive and will not be displayed in the plan.
username str: The username to authenticate.

UptimeCheckConfigMonitoredResource

See the input and output API doc for this type.

Labels Dictionary<string, string>: Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels “project_id”, “instance_id”, and “zone”.
Type string: The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.monitoredResourceDescriptors#MonitoredResourceDescriptor) object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).

Labels map[string]string: Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels “project_id”, “instance_id”, and “zone”.
Type string: The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.monitoredResourceDescriptors#MonitoredResourceDescriptor) object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).

labels {[key: string]: string}: Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels “project_id”, “instance_id”, and “zone”.
type string: The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.monitoredResourceDescriptors#MonitoredResourceDescriptor) object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).

labels Dict[str, str]: Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels “project_id”, “instance_id”, and “zone”.
type str: The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.monitoredResourceDescriptors#MonitoredResourceDescriptor) object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).

UptimeCheckConfigResourceGroup

See the input and output API doc for this type.

GroupId string: The group of resources being monitored. Should be the name of a group
ResourceType string: The resource type of the group members.

GroupId string: The group of resources being monitored. Should be the name of a group
ResourceType string: The resource type of the group members.

groupId string: The group of resources being monitored. Should be the name of a group
resourceType string: The resource type of the group members.

groupId str: The group of resources being monitored. Should be the name of a group
resourceType str: The resource type of the group members.

UptimeCheckConfigTcpCheck

See the input and output API doc for this type.

Port int: The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.

Port int: The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.

port number: The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.

port float: The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

UptimeCheckConfig

Create a UptimeCheckConfig Resource

UptimeCheckConfig Resource Properties

Inputs

Outputs

Look up an Existing UptimeCheckConfig Resource

Supporting Types

UptimeCheckConfigContentMatcher

UptimeCheckConfigHttpCheck

UptimeCheckConfigHttpCheckAuthInfo

UptimeCheckConfigMonitoredResource

UptimeCheckConfigResourceGroup

UptimeCheckConfigTcpCheck

Package Details

On This Page