oci.HealthChecks.HttpProbe
Explore with Pulumi AI
This resource provides the Http Probe resource in Oracle Cloud Infrastructure Health Checks service.
Creates an on-demand HTTP probe. The location response header contains the URL for fetching the probe results.
Note: On-demand probe configurations are not saved.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testHttpProbe = new oci.healthchecks.HttpProbe("test_http_probe", {
compartmentId: compartmentId,
protocol: httpProbeProtocol,
targets: httpProbeTargets,
headers: httpProbeHeaders,
method: httpProbeMethod,
path: httpProbePath,
port: httpProbePort,
timeoutInSeconds: httpProbeTimeoutInSeconds,
vantagePointNames: httpProbeVantagePointNames,
});
import pulumi
import pulumi_oci as oci
test_http_probe = oci.health_checks.HttpProbe("test_http_probe",
compartment_id=compartment_id,
protocol=http_probe_protocol,
targets=http_probe_targets,
headers=http_probe_headers,
method=http_probe_method,
path=http_probe_path,
port=http_probe_port,
timeout_in_seconds=http_probe_timeout_in_seconds,
vantage_point_names=http_probe_vantage_point_names)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/HealthChecks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := HealthChecks.NewHttpProbe(ctx, "test_http_probe", &HealthChecks.HttpProbeArgs{
CompartmentId: pulumi.Any(compartmentId),
Protocol: pulumi.Any(httpProbeProtocol),
Targets: pulumi.Any(httpProbeTargets),
Headers: pulumi.Any(httpProbeHeaders),
Method: pulumi.Any(httpProbeMethod),
Path: pulumi.Any(httpProbePath),
Port: pulumi.Any(httpProbePort),
TimeoutInSeconds: pulumi.Any(httpProbeTimeoutInSeconds),
VantagePointNames: pulumi.Any(httpProbeVantagePointNames),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testHttpProbe = new Oci.HealthChecks.HttpProbe("test_http_probe", new()
{
CompartmentId = compartmentId,
Protocol = httpProbeProtocol,
Targets = httpProbeTargets,
Headers = httpProbeHeaders,
Method = httpProbeMethod,
Path = httpProbePath,
Port = httpProbePort,
TimeoutInSeconds = httpProbeTimeoutInSeconds,
VantagePointNames = httpProbeVantagePointNames,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.HealthChecks.HttpProbe;
import com.pulumi.oci.HealthChecks.HttpProbeArgs;
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 testHttpProbe = new HttpProbe("testHttpProbe", HttpProbeArgs.builder()
.compartmentId(compartmentId)
.protocol(httpProbeProtocol)
.targets(httpProbeTargets)
.headers(httpProbeHeaders)
.method(httpProbeMethod)
.path(httpProbePath)
.port(httpProbePort)
.timeoutInSeconds(httpProbeTimeoutInSeconds)
.vantagePointNames(httpProbeVantagePointNames)
.build());
}
}
resources:
testHttpProbe:
type: oci:HealthChecks:HttpProbe
name: test_http_probe
properties:
compartmentId: ${compartmentId}
protocol: ${httpProbeProtocol}
targets: ${httpProbeTargets}
headers: ${httpProbeHeaders}
method: ${httpProbeMethod}
path: ${httpProbePath}
port: ${httpProbePort}
timeoutInSeconds: ${httpProbeTimeoutInSeconds}
vantagePointNames: ${httpProbeVantagePointNames}
Create HttpProbe Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HttpProbe(name: string, args: HttpProbeArgs, opts?: CustomResourceOptions);
@overload
def HttpProbe(resource_name: str,
args: HttpProbeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HttpProbe(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
protocol: Optional[str] = None,
targets: Optional[Sequence[str]] = None,
headers: Optional[Mapping[str, str]] = None,
method: Optional[str] = None,
path: Optional[str] = None,
port: Optional[int] = None,
timeout_in_seconds: Optional[int] = None,
vantage_point_names: Optional[Sequence[str]] = None)
func NewHttpProbe(ctx *Context, name string, args HttpProbeArgs, opts ...ResourceOption) (*HttpProbe, error)
public HttpProbe(string name, HttpProbeArgs args, CustomResourceOptions? opts = null)
public HttpProbe(String name, HttpProbeArgs args)
public HttpProbe(String name, HttpProbeArgs args, CustomResourceOptions options)
type: oci:HealthChecks:HttpProbe
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 HttpProbeArgs
- 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 HttpProbeArgs
- 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 HttpProbeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HttpProbeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HttpProbeArgs
- 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 httpProbeResource = new Oci.HealthChecks.HttpProbe("httpProbeResource", new()
{
CompartmentId = "string",
Protocol = "string",
Targets = new[]
{
"string",
},
Headers =
{
{ "string", "string" },
},
Method = "string",
Path = "string",
Port = 0,
TimeoutInSeconds = 0,
VantagePointNames = new[]
{
"string",
},
});
example, err := HealthChecks.NewHttpProbe(ctx, "httpProbeResource", &HealthChecks.HttpProbeArgs{
CompartmentId: pulumi.String("string"),
Protocol: pulumi.String("string"),
Targets: pulumi.StringArray{
pulumi.String("string"),
},
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
Method: pulumi.String("string"),
Path: pulumi.String("string"),
Port: pulumi.Int(0),
TimeoutInSeconds: pulumi.Int(0),
VantagePointNames: pulumi.StringArray{
pulumi.String("string"),
},
})
var httpProbeResource = new HttpProbe("httpProbeResource", HttpProbeArgs.builder()
.compartmentId("string")
.protocol("string")
.targets("string")
.headers(Map.of("string", "string"))
.method("string")
.path("string")
.port(0)
.timeoutInSeconds(0)
.vantagePointNames("string")
.build());
http_probe_resource = oci.health_checks.HttpProbe("httpProbeResource",
compartment_id="string",
protocol="string",
targets=["string"],
headers={
"string": "string",
},
method="string",
path="string",
port=0,
timeout_in_seconds=0,
vantage_point_names=["string"])
const httpProbeResource = new oci.healthchecks.HttpProbe("httpProbeResource", {
compartmentId: "string",
protocol: "string",
targets: ["string"],
headers: {
string: "string",
},
method: "string",
path: "string",
port: 0,
timeoutInSeconds: 0,
vantagePointNames: ["string"],
});
type: oci:HealthChecks:HttpProbe
properties:
compartmentId: string
headers:
string: string
method: string
path: string
port: 0
protocol: string
targets:
- string
timeoutInSeconds: 0
vantagePointNames:
- string
HttpProbe Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The HttpProbe resource accepts the following input properties:
- Compartment
Id string - The OCID of the compartment.
- Protocol string
- The supported protocols available for HTTP probes.
- Targets List<string>
- A list of targets (hostnames or IP addresses) of the probe.
- Headers Dictionary<string, string>
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- Method string
- The supported HTTP methods available for probes.
- Path string
- The optional URL path to probe, including query parameters.
- Port int
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- Timeout
In intSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - Vantage
Point List<string>Names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - The OCID of the compartment.
- Protocol string
- The supported protocols available for HTTP probes.
- Targets []string
- A list of targets (hostnames or IP addresses) of the probe.
- Headers map[string]string
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- Method string
- The supported HTTP methods available for probes.
- Path string
- The optional URL path to probe, including query parameters.
- Port int
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- Timeout
In intSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - Vantage
Point []stringNames A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - The OCID of the compartment.
- protocol String
- The supported protocols available for HTTP probes.
- targets List<String>
- A list of targets (hostnames or IP addresses) of the probe.
- headers Map<String,String>
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- method String
- The supported HTTP methods available for probes.
- path String
- The optional URL path to probe, including query parameters.
- port Integer
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- timeout
In IntegerSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - vantage
Point List<String>Names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id string - The OCID of the compartment.
- protocol string
- The supported protocols available for HTTP probes.
- targets string[]
- A list of targets (hostnames or IP addresses) of the probe.
- headers {[key: string]: string}
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- method string
- The supported HTTP methods available for probes.
- path string
- The optional URL path to probe, including query parameters.
- port number
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- timeout
In numberSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - vantage
Point string[]Names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment_
id str - The OCID of the compartment.
- protocol str
- The supported protocols available for HTTP probes.
- targets Sequence[str]
- A list of targets (hostnames or IP addresses) of the probe.
- headers Mapping[str, str]
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- method str
- The supported HTTP methods available for probes.
- path str
- The optional URL path to probe, including query parameters.
- port int
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- timeout_
in_ intseconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - vantage_
point_ Sequence[str]names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - The OCID of the compartment.
- protocol String
- The supported protocols available for HTTP probes.
- targets List<String>
- A list of targets (hostnames or IP addresses) of the probe.
- headers Map<String>
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- method String
- The supported HTTP methods available for probes.
- path String
- The optional URL path to probe, including query parameters.
- port Number
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- timeout
In NumberSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - vantage
Point List<String>Names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the HttpProbe resource produces the following output properties:
- Home
Region string - The region where updates must be made and where results must be fetched from.
- Id string
- The provider-assigned unique ID for this managed resource.
- Results
Url string - A URL for fetching the probe results.
- Time
Created string - The RFC 3339-formatted creation date and time of the probe.
- Home
Region string - The region where updates must be made and where results must be fetched from.
- Id string
- The provider-assigned unique ID for this managed resource.
- Results
Url string - A URL for fetching the probe results.
- Time
Created string - The RFC 3339-formatted creation date and time of the probe.
- home
Region String - The region where updates must be made and where results must be fetched from.
- id String
- The provider-assigned unique ID for this managed resource.
- results
Url String - A URL for fetching the probe results.
- time
Created String - The RFC 3339-formatted creation date and time of the probe.
- home
Region string - The region where updates must be made and where results must be fetched from.
- id string
- The provider-assigned unique ID for this managed resource.
- results
Url string - A URL for fetching the probe results.
- time
Created string - The RFC 3339-formatted creation date and time of the probe.
- home_
region str - The region where updates must be made and where results must be fetched from.
- id str
- The provider-assigned unique ID for this managed resource.
- results_
url str - A URL for fetching the probe results.
- time_
created str - The RFC 3339-formatted creation date and time of the probe.
- home
Region String - The region where updates must be made and where results must be fetched from.
- id String
- The provider-assigned unique ID for this managed resource.
- results
Url String - A URL for fetching the probe results.
- time
Created String - The RFC 3339-formatted creation date and time of the probe.
Look up Existing HttpProbe Resource
Get an existing HttpProbe 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?: HttpProbeState, opts?: CustomResourceOptions): HttpProbe
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
headers: Optional[Mapping[str, str]] = None,
home_region: Optional[str] = None,
method: Optional[str] = None,
path: Optional[str] = None,
port: Optional[int] = None,
protocol: Optional[str] = None,
results_url: Optional[str] = None,
targets: Optional[Sequence[str]] = None,
time_created: Optional[str] = None,
timeout_in_seconds: Optional[int] = None,
vantage_point_names: Optional[Sequence[str]] = None) -> HttpProbe
func GetHttpProbe(ctx *Context, name string, id IDInput, state *HttpProbeState, opts ...ResourceOption) (*HttpProbe, error)
public static HttpProbe Get(string name, Input<string> id, HttpProbeState? state, CustomResourceOptions? opts = null)
public static HttpProbe get(String name, Output<String> id, HttpProbeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Compartment
Id string - The OCID of the compartment.
- Headers Dictionary<string, string>
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- Home
Region string - The region where updates must be made and where results must be fetched from.
- Method string
- The supported HTTP methods available for probes.
- Path string
- The optional URL path to probe, including query parameters.
- Port int
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- Protocol string
- The supported protocols available for HTTP probes.
- Results
Url string - A URL for fetching the probe results.
- Targets List<string>
- A list of targets (hostnames or IP addresses) of the probe.
- Time
Created string - The RFC 3339-formatted creation date and time of the probe.
- Timeout
In intSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - Vantage
Point List<string>Names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - The OCID of the compartment.
- Headers map[string]string
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- Home
Region string - The region where updates must be made and where results must be fetched from.
- Method string
- The supported HTTP methods available for probes.
- Path string
- The optional URL path to probe, including query parameters.
- Port int
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- Protocol string
- The supported protocols available for HTTP probes.
- Results
Url string - A URL for fetching the probe results.
- Targets []string
- A list of targets (hostnames or IP addresses) of the probe.
- Time
Created string - The RFC 3339-formatted creation date and time of the probe.
- Timeout
In intSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - Vantage
Point []stringNames A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - The OCID of the compartment.
- headers Map<String,String>
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- home
Region String - The region where updates must be made and where results must be fetched from.
- method String
- The supported HTTP methods available for probes.
- path String
- The optional URL path to probe, including query parameters.
- port Integer
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- protocol String
- The supported protocols available for HTTP probes.
- results
Url String - A URL for fetching the probe results.
- targets List<String>
- A list of targets (hostnames or IP addresses) of the probe.
- time
Created String - The RFC 3339-formatted creation date and time of the probe.
- timeout
In IntegerSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - vantage
Point List<String>Names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id string - The OCID of the compartment.
- headers {[key: string]: string}
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- home
Region string - The region where updates must be made and where results must be fetched from.
- method string
- The supported HTTP methods available for probes.
- path string
- The optional URL path to probe, including query parameters.
- port number
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- protocol string
- The supported protocols available for HTTP probes.
- results
Url string - A URL for fetching the probe results.
- targets string[]
- A list of targets (hostnames or IP addresses) of the probe.
- time
Created string - The RFC 3339-formatted creation date and time of the probe.
- timeout
In numberSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - vantage
Point string[]Names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment_
id str - The OCID of the compartment.
- headers Mapping[str, str]
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- home_
region str - The region where updates must be made and where results must be fetched from.
- method str
- The supported HTTP methods available for probes.
- path str
- The optional URL path to probe, including query parameters.
- port int
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- protocol str
- The supported protocols available for HTTP probes.
- results_
url str - A URL for fetching the probe results.
- targets Sequence[str]
- A list of targets (hostnames or IP addresses) of the probe.
- time_
created str - The RFC 3339-formatted creation date and time of the probe.
- timeout_
in_ intseconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - vantage_
point_ Sequence[str]names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - The OCID of the compartment.
- headers Map<String>
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the
Authorization
HTTP header.- home
Region String - The region where updates must be made and where results must be fetched from.
- method String
- The supported HTTP methods available for probes.
- path String
- The optional URL path to probe, including query parameters.
- port Number
- The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
- protocol String
- The supported protocols available for HTTP probes.
- results
Url String - A URL for fetching the probe results.
- targets List<String>
- A list of targets (hostnames or IP addresses) of the probe.
- time
Created String - The RFC 3339-formatted creation date and time of the probe.
- timeout
In NumberSeconds - The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to
intervalInSeconds
for monitors. - vantage
Point List<String>Names A list of names of vantage points from which to execute the probe.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Import
HttpProbes can be imported using the id
, e.g.
$ pulumi import oci:HealthChecks/httpProbe:HttpProbe test_http_probe "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.