Package com.hashicorp.cdktf.providers.google.monitoring_uptime_check_config

Interface MonitoringUptimeCheckConfigHttpCheck

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    MonitoringUptimeCheckConfigHttpCheck.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.984Z")
@Stability(Stable)
public interface MonitoringUptimeCheckConfigHttpCheck
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getAcceptedResponseStatusCodes

        @Stability(Stable)
@Nullable
default Object getAcceptedResponseStatusCodes()
        accepted_response_status_codes block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#accepted_response_status_codes MonitoringUptimeCheckConfig#accepted_response_status_codes}

      • getAuthInfo

        @Stability(Stable)
@Nullable
default MonitoringUptimeCheckConfigHttpCheckAuthInfo getAuthInfo()
        auth_info block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#auth_info MonitoringUptimeCheckConfig#auth_info}

      • getBody

        @Stability(Stable)
@Nullable
default String getBody()
        The request body associated with the HTTP POST request.

        If 'content_type' 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 'request_method' 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='. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#body MonitoringUptimeCheckConfig#body}

      • getContentType

        @Stability(Stable)
@Nullable
default String getContentType()
        The content type to use for the check. Possible values: ["TYPE_UNSPECIFIED", "URL_ENCODED", "USER_PROVIDED"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#content_type MonitoringUptimeCheckConfig#content_type}

      • getCustomContentType

        @Stability(Stable)
@Nullable
default String getCustomContentType()
        A user provided content type header to use for the check.

        The invalid configurations outlined in the 'content_type' field apply to custom_content_type', as well as the following 1. 'content_type' is 'URL_ENCODED' and 'custom_content_type' is set. 2. 'content_type' is 'USER_PROVIDED' and 'custom_content_type' is not set. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#custom_content_type MonitoringUptimeCheckConfig#custom_content_type}

      • getHeaders

        @Stability(Stable)
@Nullable
default Map<String,​String> getHeaders()
        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 in [RFC 2616 (page 31)](https://www.w3.org/Protocols/rfc2616/rfc2616.txt). 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#headers MonitoringUptimeCheckConfig#headers}

      • getMaskHeaders

        @Stability(Stable)
@Nullable
default Object getMaskHeaders()
        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 '******'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#mask_headers MonitoringUptimeCheckConfig#mask_headers}

      • getPath

        @Stability(Stable)
@Nullable
default String getPath()
        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. If the provided path does not begin with '/', a '/' will be prepended automatically. Optional (defaults to '/'). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#path MonitoringUptimeCheckConfig#path}

      • getPingConfig

        @Stability(Stable)
@Nullable
default MonitoringUptimeCheckConfigHttpCheckPingConfig getPingConfig()
        ping_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#ping_config MonitoringUptimeCheckConfig#ping_config}

      • getPort

        @Stability(Stable)
@Nullable
default Number getPort()
        The port to the page to run the check against.

        Will be combined with 'host' (specified within the ['monitored_resource'](#nested_monitored_resource)) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#port MonitoringUptimeCheckConfig#port}

      • getRequestMethod

        @Stability(Stable)
@Nullable
default String getRequestMethod()
        The HTTP request method to use for the check.

        If set to 'METHOD_UNSPECIFIED' then 'request_method' defaults to 'GET'. Default value: "GET" Possible values: ["METHOD_UNSPECIFIED", "GET", "POST"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#request_method MonitoringUptimeCheckConfig#request_method}

      • getServiceAgentAuthentication

        @Stability(Stable)
@Nullable
default MonitoringUptimeCheckConfigHttpCheckServiceAgentAuthentication getServiceAgentAuthentication()
        service_agent_authentication block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#service_agent_authentication MonitoringUptimeCheckConfig#service_agent_authentication}

      • getUseSsl

        @Stability(Stable)
@Nullable
default Object getUseSsl()
        If true, use HTTPS instead of HTTP to run the check.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#use_ssl MonitoringUptimeCheckConfig#use_ssl}

      • getValidateSsl

        @Stability(Stable)
@Nullable
default Object getValidateSsl()
        Boolean specifying whether to include SSL certificate validation as a part of the Uptime check.

        Only applies to checks where 'monitored_resource' is set to 'uptime_url'. If 'use_ssl' is 'false', setting 'validate_ssl' to 'true' has no effect. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_uptime_check_config#validate_ssl MonitoringUptimeCheckConfig#validate_ssl}