import * as pulumi from "@pulumi/pulumi"; /** * This resource provides the Ping Monitor resource in Oracle Cloud Infrastructure Health Checks service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/healthchecks/latest/PingMonitor * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/health_checks * * Creates a ping monitor. Vantage points will be automatically selected if not specified, * and probes will be initiated from each vantage point to each of the targets at the frequency * specified by `intervalInSeconds`. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testPingMonitor = new oci.healthchecks.PingMonitor("test_ping_monitor", { * compartmentId: compartmentId, * displayName: pingMonitorDisplayName, * intervalInSeconds: Number(pingMonitorIntervalInSeconds), * protocol: pingMonitorProtocol, * targets: pingMonitorTargets, * definedTags: { * "Operations.CostCenter": "42", * }, * freeformTags: { * Department: "Finance", * }, * isEnabled: pingMonitorIsEnabled === "true", * port: Number(pingMonitorPort), * timeoutInSeconds: Number(pingMonitorTimeoutInSeconds), * vantagePointNames: pingMonitorVantagePointNames, * }); * ``` * * ## Import * * PingMonitors can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:HealthChecks/pingMonitor:PingMonitor test_ping_monitor "id" * ``` */ export declare class PingMonitor extends pulumi.CustomResource { /** * Get an existing PingMonitor resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: PingMonitorState, opts?: pulumi.CustomResourceOptions): PingMonitor; /** * Returns true if the given object is an instance of PingMonitor. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is PingMonitor; /** * (Updatable) The OCID of the compartment. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly and mutable name suitable for display in a user interface. */ readonly displayName: pulumi.Output; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * The region where updates must be made and where results must be fetched from. */ readonly homeRegion: pulumi.Output; /** * (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60. */ readonly intervalInSeconds: pulumi.Output; /** * (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring. */ readonly isEnabled: pulumi.Output; /** * (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. */ readonly port: pulumi.Output; /** * (Updatable) The protocols for ping probes. */ readonly protocol: pulumi.Output; /** * A URL for fetching the probe results. */ readonly resultsUrl: pulumi.Output; /** * (Updatable) A list of targets (hostnames or IP addresses) of the probe. */ readonly targets: pulumi.Output; /** * The RFC 3339-formatted creation date and time of the probe. */ readonly timeCreated: pulumi.Output; /** * (Updatable) 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. */ readonly timeoutInSeconds: pulumi.Output; /** * (Updatable) 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 */ readonly vantagePointNames: pulumi.Output; /** * Create a PingMonitor resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: PingMonitorArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PingMonitor resources. */ export interface PingMonitorState { /** * (Updatable) The OCID of the compartment. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly and mutable name suitable for display in a user interface. */ displayName?: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The region where updates must be made and where results must be fetched from. */ homeRegion?: pulumi.Input; /** * (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60. */ intervalInSeconds?: pulumi.Input; /** * (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring. */ isEnabled?: pulumi.Input; /** * (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. */ port?: pulumi.Input; /** * (Updatable) The protocols for ping probes. */ protocol?: pulumi.Input; /** * A URL for fetching the probe results. */ resultsUrl?: pulumi.Input; /** * (Updatable) A list of targets (hostnames or IP addresses) of the probe. */ targets?: pulumi.Input[] | undefined>; /** * The RFC 3339-formatted creation date and time of the probe. */ timeCreated?: pulumi.Input; /** * (Updatable) 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. */ timeoutInSeconds?: pulumi.Input; /** * (Updatable) 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 */ vantagePointNames?: pulumi.Input[] | undefined>; } /** * The set of arguments for constructing a PingMonitor resource. */ export interface PingMonitorArgs { /** * (Updatable) The OCID of the compartment. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly and mutable name suitable for display in a user interface. */ displayName: pulumi.Input; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60. */ intervalInSeconds: pulumi.Input; /** * (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring. */ isEnabled?: pulumi.Input; /** * (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. */ port?: pulumi.Input; /** * (Updatable) The protocols for ping probes. */ protocol: pulumi.Input; /** * (Updatable) A list of targets (hostnames or IP addresses) of the probe. */ targets: pulumi.Input[]>; /** * (Updatable) 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. */ timeoutInSeconds?: pulumi.Input; /** * (Updatable) 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 */ vantagePointNames?: pulumi.Input[] | undefined>; } //# sourceMappingURL=pingMonitor.d.ts.map