1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApmSynthetics
  5. getMonitor
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

oci.ApmSynthetics.getMonitor

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

    This data source provides details about a specific Monitor resource in Oracle Cloud Infrastructure Apm Synthetics service.

    Gets the configuration of the monitor identified by the OCID.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testMonitor = oci.ApmSynthetics.getMonitor({
        apmDomainId: oci_apm_synthetics_apm_domain.test_apm_domain.id,
        monitorId: oci_apm_synthetics_monitor.test_monitor.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_monitor = oci.ApmSynthetics.get_monitor(apm_domain_id=oci_apm_synthetics_apm_domain["test_apm_domain"]["id"],
        monitor_id=oci_apm_synthetics_monitor["test_monitor"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/ApmSynthetics"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ApmSynthetics.GetMonitor(ctx, &apmsynthetics.GetMonitorArgs{
    			ApmDomainId: oci_apm_synthetics_apm_domain.Test_apm_domain.Id,
    			MonitorId:   oci_apm_synthetics_monitor.Test_monitor.Id,
    		}, nil)
    		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 testMonitor = Oci.ApmSynthetics.GetMonitor.Invoke(new()
        {
            ApmDomainId = oci_apm_synthetics_apm_domain.Test_apm_domain.Id,
            MonitorId = oci_apm_synthetics_monitor.Test_monitor.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.ApmSynthetics.ApmSyntheticsFunctions;
    import com.pulumi.oci.ApmSynthetics.inputs.GetMonitorArgs;
    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) {
            final var testMonitor = ApmSyntheticsFunctions.getMonitor(GetMonitorArgs.builder()
                .apmDomainId(oci_apm_synthetics_apm_domain.test_apm_domain().id())
                .monitorId(oci_apm_synthetics_monitor.test_monitor().id())
                .build());
    
        }
    }
    
    variables:
      testMonitor:
        fn::invoke:
          Function: oci:ApmSynthetics:getMonitor
          Arguments:
            apmDomainId: ${oci_apm_synthetics_apm_domain.test_apm_domain.id}
            monitorId: ${oci_apm_synthetics_monitor.test_monitor.id}
    

    Using getMonitor

    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.

    function getMonitor(args: GetMonitorArgs, opts?: InvokeOptions): Promise<GetMonitorResult>
    function getMonitorOutput(args: GetMonitorOutputArgs, opts?: InvokeOptions): Output<GetMonitorResult>
    def get_monitor(apm_domain_id: Optional[str] = None,
                    monitor_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetMonitorResult
    def get_monitor_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                    monitor_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetMonitorResult]
    func GetMonitor(ctx *Context, args *GetMonitorArgs, opts ...InvokeOption) (*GetMonitorResult, error)
    func GetMonitorOutput(ctx *Context, args *GetMonitorOutputArgs, opts ...InvokeOption) GetMonitorResultOutput

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

    public static class GetMonitor 
    {
        public static Task<GetMonitorResult> InvokeAsync(GetMonitorArgs args, InvokeOptions? opts = null)
        public static Output<GetMonitorResult> Invoke(GetMonitorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:ApmSynthetics/getMonitor:getMonitor
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApmDomainId string
    The APM domain ID the request is intended for.
    MonitorId string
    The OCID of the monitor.
    ApmDomainId string
    The APM domain ID the request is intended for.
    MonitorId string
    The OCID of the monitor.
    apmDomainId String
    The APM domain ID the request is intended for.
    monitorId String
    The OCID of the monitor.
    apmDomainId string
    The APM domain ID the request is intended for.
    monitorId string
    The OCID of the monitor.
    apm_domain_id str
    The APM domain ID the request is intended for.
    monitor_id str
    The OCID of the monitor.
    apmDomainId String
    The APM domain ID the request is intended for.
    monitorId String
    The OCID of the monitor.

    getMonitor Result

    The following output properties are available:

    ApmDomainId string
    AvailabilityConfigurations List<GetMonitorAvailabilityConfiguration>
    Monitor availability configuration details.
    BatchIntervalInSeconds int
    Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
    Configurations List<GetMonitorConfiguration>
    Details of monitor configuration.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Unique name that can be edited. The name should not contain any confidential information.
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the monitor.
    IsRunNow bool
    If isRunNow is enabled, then the monitor will run immediately.
    IsRunOnce bool
    If runOnce is enabled, then the monitor will run once.
    MaintenanceWindowSchedules List<GetMonitorMaintenanceWindowSchedule>
    Details required to schedule maintenance window.
    MonitorId string
    MonitorType string
    Type of monitor.
    RepeatIntervalInSeconds int
    Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
    SchedulingPolicy string
    Scheduling policy to decide the distribution of monitor executions on vantage points.
    ScriptId string
    The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
    ScriptName string
    Name of the script.
    ScriptParameters List<GetMonitorScriptParameter>
    List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
    Status string
    Enables or disables the monitor.
    Target string
    Specify the endpoint on which to run the monitor. For BROWSER, REST and NETWORK monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
    TimeCreated string
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    TimeUpdated string
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    TimeoutInSeconds int
    Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
    VantagePointCount int
    Number of vantage points where monitor is running.
    VantagePoints List<GetMonitorVantagePoint>
    List of public and dedicated vantage points where the monitor is running.
    ApmDomainId string
    AvailabilityConfigurations []GetMonitorAvailabilityConfiguration
    Monitor availability configuration details.
    BatchIntervalInSeconds int
    Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
    Configurations []GetMonitorConfiguration
    Details of monitor configuration.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    Unique name that can be edited. The name should not contain any confidential information.
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the monitor.
    IsRunNow bool
    If isRunNow is enabled, then the monitor will run immediately.
    IsRunOnce bool
    If runOnce is enabled, then the monitor will run once.
    MaintenanceWindowSchedules []GetMonitorMaintenanceWindowSchedule
    Details required to schedule maintenance window.
    MonitorId string
    MonitorType string
    Type of monitor.
    RepeatIntervalInSeconds int
    Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
    SchedulingPolicy string
    Scheduling policy to decide the distribution of monitor executions on vantage points.
    ScriptId string
    The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
    ScriptName string
    Name of the script.
    ScriptParameters []GetMonitorScriptParameter
    List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
    Status string
    Enables or disables the monitor.
    Target string
    Specify the endpoint on which to run the monitor. For BROWSER, REST and NETWORK monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
    TimeCreated string
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    TimeUpdated string
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    TimeoutInSeconds int
    Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
    VantagePointCount int
    Number of vantage points where monitor is running.
    VantagePoints []GetMonitorVantagePoint
    List of public and dedicated vantage points where the monitor is running.
    apmDomainId String
    availabilityConfigurations List<GetMonitorAvailabilityConfiguration>
    Monitor availability configuration details.
    batchIntervalInSeconds Integer
    Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
    configurations List<GetMonitorConfiguration>
    Details of monitor configuration.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Unique name that can be edited. The name should not contain any confidential information.
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the monitor.
    isRunNow Boolean
    If isRunNow is enabled, then the monitor will run immediately.
    isRunOnce Boolean
    If runOnce is enabled, then the monitor will run once.
    maintenanceWindowSchedules List<GetMonitorMaintenanceWindowSchedule>
    Details required to schedule maintenance window.
    monitorId String
    monitorType String
    Type of monitor.
    repeatIntervalInSeconds Integer
    Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
    schedulingPolicy String
    Scheduling policy to decide the distribution of monitor executions on vantage points.
    scriptId String
    The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
    scriptName String
    Name of the script.
    scriptParameters List<GetMonitorScriptParameter>
    List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
    status String
    Enables or disables the monitor.
    target String
    Specify the endpoint on which to run the monitor. For BROWSER, REST and NETWORK monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
    timeCreated String
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeUpdated String
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    timeoutInSeconds Integer
    Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
    vantagePointCount Integer
    Number of vantage points where monitor is running.
    vantagePoints List<GetMonitorVantagePoint>
    List of public and dedicated vantage points where the monitor is running.
    apmDomainId string
    availabilityConfigurations GetMonitorAvailabilityConfiguration[]
    Monitor availability configuration details.
    batchIntervalInSeconds number
    Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
    configurations GetMonitorConfiguration[]
    Details of monitor configuration.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    Unique name that can be edited. The name should not contain any confidential information.
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The OCID of the monitor.
    isRunNow boolean
    If isRunNow is enabled, then the monitor will run immediately.
    isRunOnce boolean
    If runOnce is enabled, then the monitor will run once.
    maintenanceWindowSchedules GetMonitorMaintenanceWindowSchedule[]
    Details required to schedule maintenance window.
    monitorId string
    monitorType string
    Type of monitor.
    repeatIntervalInSeconds number
    Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
    schedulingPolicy string
    Scheduling policy to decide the distribution of monitor executions on vantage points.
    scriptId string
    The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
    scriptName string
    Name of the script.
    scriptParameters GetMonitorScriptParameter[]
    List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
    status string
    Enables or disables the monitor.
    target string
    Specify the endpoint on which to run the monitor. For BROWSER, REST and NETWORK monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
    timeCreated string
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeUpdated string
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    timeoutInSeconds number
    Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
    vantagePointCount number
    Number of vantage points where monitor is running.
    vantagePoints GetMonitorVantagePoint[]
    List of public and dedicated vantage points where the monitor is running.
    apm_domain_id str
    availability_configurations Sequence[apmsynthetics.GetMonitorAvailabilityConfiguration]
    Monitor availability configuration details.
    batch_interval_in_seconds int
    Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
    configurations Sequence[apmsynthetics.GetMonitorConfiguration]
    Details of monitor configuration.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    Unique name that can be edited. The name should not contain any confidential information.
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    The OCID of the monitor.
    is_run_now bool
    If isRunNow is enabled, then the monitor will run immediately.
    is_run_once bool
    If runOnce is enabled, then the monitor will run once.
    maintenance_window_schedules Sequence[apmsynthetics.GetMonitorMaintenanceWindowSchedule]
    Details required to schedule maintenance window.
    monitor_id str
    monitor_type str
    Type of monitor.
    repeat_interval_in_seconds int
    Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
    scheduling_policy str
    Scheduling policy to decide the distribution of monitor executions on vantage points.
    script_id str
    The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
    script_name str
    Name of the script.
    script_parameters Sequence[apmsynthetics.GetMonitorScriptParameter]
    List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
    status str
    Enables or disables the monitor.
    target str
    Specify the endpoint on which to run the monitor. For BROWSER, REST and NETWORK monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
    time_created str
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    time_updated str
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    timeout_in_seconds int
    Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
    vantage_point_count int
    Number of vantage points where monitor is running.
    vantage_points Sequence[apmsynthetics.GetMonitorVantagePoint]
    List of public and dedicated vantage points where the monitor is running.
    apmDomainId String
    availabilityConfigurations List<Property Map>
    Monitor availability configuration details.
    batchIntervalInSeconds Number
    Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
    configurations List<Property Map>
    Details of monitor configuration.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    Unique name that can be edited. The name should not contain any confidential information.
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the monitor.
    isRunNow Boolean
    If isRunNow is enabled, then the monitor will run immediately.
    isRunOnce Boolean
    If runOnce is enabled, then the monitor will run once.
    maintenanceWindowSchedules List<Property Map>
    Details required to schedule maintenance window.
    monitorId String
    monitorType String
    Type of monitor.
    repeatIntervalInSeconds Number
    Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
    schedulingPolicy String
    Scheduling policy to decide the distribution of monitor executions on vantage points.
    scriptId String
    The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
    scriptName String
    Name of the script.
    scriptParameters List<Property Map>
    List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
    status String
    Enables or disables the monitor.
    target String
    Specify the endpoint on which to run the monitor. For BROWSER, REST and NETWORK monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
    timeCreated String
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeUpdated String
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    timeoutInSeconds Number
    Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
    vantagePointCount Number
    Number of vantage points where monitor is running.
    vantagePoints List<Property Map>
    List of public and dedicated vantage points where the monitor is running.

    Supporting Types

    GetMonitorAvailabilityConfiguration

    MaxAllowedFailuresPerInterval int
    Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
    MinAllowedRunsPerInterval int
    Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
    MaxAllowedFailuresPerInterval int
    Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
    MinAllowedRunsPerInterval int
    Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
    maxAllowedFailuresPerInterval Integer
    Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
    minAllowedRunsPerInterval Integer
    Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
    maxAllowedFailuresPerInterval number
    Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
    minAllowedRunsPerInterval number
    Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
    max_allowed_failures_per_interval int
    Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
    min_allowed_runs_per_interval int
    Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
    maxAllowedFailuresPerInterval Number
    Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
    minAllowedRunsPerInterval Number
    Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.

    GetMonitorConfiguration

    ClientCertificateDetails List<GetMonitorConfigurationClientCertificateDetail>
    Details for client certificate.
    ConfigType string
    Type of configuration.
    DnsConfigurations List<GetMonitorConfigurationDnsConfiguration>
    Information about the DNS settings.
    IsCertificateValidationEnabled bool
    If certificate validation is enabled, then the call will fail in case of certification errors.
    IsDefaultSnapshotEnabled bool
    If disabled, auto snapshots are not collected.
    IsFailureRetried bool
    If isFailureRetried is enabled, then a failed call will be retried.
    IsQueryRecursive bool
    If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
    IsRedirectionEnabled bool
    If redirection is enabled, then redirects will be allowed while accessing target URL.
    NameServer string
    Name of the server that will be used to perform DNS lookup.
    NetworkConfigurations List<GetMonitorConfigurationNetworkConfiguration>
    Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
    Protocol string
    Type of protocol.
    RecordType string
    DNS record type.
    ReqAuthenticationDetails List<GetMonitorConfigurationReqAuthenticationDetail>
    Details for request HTTP authentication.
    ReqAuthenticationScheme string
    Request HTTP authentication scheme.
    RequestHeaders List<GetMonitorConfigurationRequestHeader>
    List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    RequestMethod string
    Request HTTP method.
    RequestPostBody string
    Request post body content.
    RequestQueryParams List<GetMonitorConfigurationRequestQueryParam>
    List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
    VerifyResponseCodes List<string>
    Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
    VerifyResponseContent string
    Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
    VerifyTexts List<GetMonitorConfigurationVerifyText>
    Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
    ClientCertificateDetails []GetMonitorConfigurationClientCertificateDetail
    Details for client certificate.
    ConfigType string
    Type of configuration.
    DnsConfigurations []GetMonitorConfigurationDnsConfiguration
    Information about the DNS settings.
    IsCertificateValidationEnabled bool
    If certificate validation is enabled, then the call will fail in case of certification errors.
    IsDefaultSnapshotEnabled bool
    If disabled, auto snapshots are not collected.
    IsFailureRetried bool
    If isFailureRetried is enabled, then a failed call will be retried.
    IsQueryRecursive bool
    If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
    IsRedirectionEnabled bool
    If redirection is enabled, then redirects will be allowed while accessing target URL.
    NameServer string
    Name of the server that will be used to perform DNS lookup.
    NetworkConfigurations []GetMonitorConfigurationNetworkConfiguration
    Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
    Protocol string
    Type of protocol.
    RecordType string
    DNS record type.
    ReqAuthenticationDetails []GetMonitorConfigurationReqAuthenticationDetail
    Details for request HTTP authentication.
    ReqAuthenticationScheme string
    Request HTTP authentication scheme.
    RequestHeaders []GetMonitorConfigurationRequestHeader
    List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    RequestMethod string
    Request HTTP method.
    RequestPostBody string
    Request post body content.
    RequestQueryParams []GetMonitorConfigurationRequestQueryParam
    List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
    VerifyResponseCodes []string
    Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
    VerifyResponseContent string
    Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
    VerifyTexts []GetMonitorConfigurationVerifyText
    Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
    clientCertificateDetails List<GetMonitorConfigurationClientCertificateDetail>
    Details for client certificate.
    configType String
    Type of configuration.
    dnsConfigurations List<GetMonitorConfigurationDnsConfiguration>
    Information about the DNS settings.
    isCertificateValidationEnabled Boolean
    If certificate validation is enabled, then the call will fail in case of certification errors.
    isDefaultSnapshotEnabled Boolean
    If disabled, auto snapshots are not collected.
    isFailureRetried Boolean
    If isFailureRetried is enabled, then a failed call will be retried.
    isQueryRecursive Boolean
    If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
    isRedirectionEnabled Boolean
    If redirection is enabled, then redirects will be allowed while accessing target URL.
    nameServer String
    Name of the server that will be used to perform DNS lookup.
    networkConfigurations List<GetMonitorConfigurationNetworkConfiguration>
    Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
    protocol String
    Type of protocol.
    recordType String
    DNS record type.
    reqAuthenticationDetails List<GetMonitorConfigurationReqAuthenticationDetail>
    Details for request HTTP authentication.
    reqAuthenticationScheme String
    Request HTTP authentication scheme.
    requestHeaders List<GetMonitorConfigurationRequestHeader>
    List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    requestMethod String
    Request HTTP method.
    requestPostBody String
    Request post body content.
    requestQueryParams List<GetMonitorConfigurationRequestQueryParam>
    List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
    verifyResponseCodes List<String>
    Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
    verifyResponseContent String
    Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
    verifyTexts List<GetMonitorConfigurationVerifyText>
    Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
    clientCertificateDetails GetMonitorConfigurationClientCertificateDetail[]
    Details for client certificate.
    configType string
    Type of configuration.
    dnsConfigurations GetMonitorConfigurationDnsConfiguration[]
    Information about the DNS settings.
    isCertificateValidationEnabled boolean
    If certificate validation is enabled, then the call will fail in case of certification errors.
    isDefaultSnapshotEnabled boolean
    If disabled, auto snapshots are not collected.
    isFailureRetried boolean
    If isFailureRetried is enabled, then a failed call will be retried.
    isQueryRecursive boolean
    If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
    isRedirectionEnabled boolean
    If redirection is enabled, then redirects will be allowed while accessing target URL.
    nameServer string
    Name of the server that will be used to perform DNS lookup.
    networkConfigurations GetMonitorConfigurationNetworkConfiguration[]
    Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
    protocol string
    Type of protocol.
    recordType string
    DNS record type.
    reqAuthenticationDetails GetMonitorConfigurationReqAuthenticationDetail[]
    Details for request HTTP authentication.
    reqAuthenticationScheme string
    Request HTTP authentication scheme.
    requestHeaders GetMonitorConfigurationRequestHeader[]
    List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    requestMethod string
    Request HTTP method.
    requestPostBody string
    Request post body content.
    requestQueryParams GetMonitorConfigurationRequestQueryParam[]
    List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
    verifyResponseCodes string[]
    Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
    verifyResponseContent string
    Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
    verifyTexts GetMonitorConfigurationVerifyText[]
    Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
    client_certificate_details Sequence[apmsynthetics.GetMonitorConfigurationClientCertificateDetail]
    Details for client certificate.
    config_type str
    Type of configuration.
    dns_configurations Sequence[apmsynthetics.GetMonitorConfigurationDnsConfiguration]
    Information about the DNS settings.
    is_certificate_validation_enabled bool
    If certificate validation is enabled, then the call will fail in case of certification errors.
    is_default_snapshot_enabled bool
    If disabled, auto snapshots are not collected.
    is_failure_retried bool
    If isFailureRetried is enabled, then a failed call will be retried.
    is_query_recursive bool
    If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
    is_redirection_enabled bool
    If redirection is enabled, then redirects will be allowed while accessing target URL.
    name_server str
    Name of the server that will be used to perform DNS lookup.
    network_configurations Sequence[apmsynthetics.GetMonitorConfigurationNetworkConfiguration]
    Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
    protocol str
    Type of protocol.
    record_type str
    DNS record type.
    req_authentication_details Sequence[apmsynthetics.GetMonitorConfigurationReqAuthenticationDetail]
    Details for request HTTP authentication.
    req_authentication_scheme str
    Request HTTP authentication scheme.
    request_headers Sequence[apmsynthetics.GetMonitorConfigurationRequestHeader]
    List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    request_method str
    Request HTTP method.
    request_post_body str
    Request post body content.
    request_query_params Sequence[apmsynthetics.GetMonitorConfigurationRequestQueryParam]
    List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
    verify_response_codes Sequence[str]
    Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
    verify_response_content str
    Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
    verify_texts Sequence[apmsynthetics.GetMonitorConfigurationVerifyText]
    Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
    clientCertificateDetails List<Property Map>
    Details for client certificate.
    configType String
    Type of configuration.
    dnsConfigurations List<Property Map>
    Information about the DNS settings.
    isCertificateValidationEnabled Boolean
    If certificate validation is enabled, then the call will fail in case of certification errors.
    isDefaultSnapshotEnabled Boolean
    If disabled, auto snapshots are not collected.
    isFailureRetried Boolean
    If isFailureRetried is enabled, then a failed call will be retried.
    isQueryRecursive Boolean
    If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
    isRedirectionEnabled Boolean
    If redirection is enabled, then redirects will be allowed while accessing target URL.
    nameServer String
    Name of the server that will be used to perform DNS lookup.
    networkConfigurations List<Property Map>
    Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
    protocol String
    Type of protocol.
    recordType String
    DNS record type.
    reqAuthenticationDetails List<Property Map>
    Details for request HTTP authentication.
    reqAuthenticationScheme String
    Request HTTP authentication scheme.
    requestHeaders List<Property Map>
    List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    requestMethod String
    Request HTTP method.
    requestPostBody String
    Request post body content.
    requestQueryParams List<Property Map>
    List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
    verifyResponseCodes List<String>
    Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
    verifyResponseContent String
    Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
    verifyTexts List<Property Map>
    Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

    GetMonitorConfigurationClientCertificateDetail

    ClientCertificates []GetMonitorConfigurationClientCertificateDetailClientCertificate
    Client certificate in PEM format.
    PrivateKeys []GetMonitorConfigurationClientCertificateDetailPrivateKey
    The private key associated with the client certificate in PEM format.
    clientCertificates GetMonitorConfigurationClientCertificateDetailClientCertificate[]
    Client certificate in PEM format.
    privateKeys GetMonitorConfigurationClientCertificateDetailPrivateKey[]
    The private key associated with the client certificate in PEM format.
    clientCertificates List<Property Map>
    Client certificate in PEM format.
    privateKeys List<Property Map>
    The private key associated with the client certificate in PEM format.

    GetMonitorConfigurationClientCertificateDetailClientCertificate

    Content string
    Content of the private key file.
    FileName string
    Name of the private key file.
    Content string
    Content of the private key file.
    FileName string
    Name of the private key file.
    content String
    Content of the private key file.
    fileName String
    Name of the private key file.
    content string
    Content of the private key file.
    fileName string
    Name of the private key file.
    content str
    Content of the private key file.
    file_name str
    Name of the private key file.
    content String
    Content of the private key file.
    fileName String
    Name of the private key file.

    GetMonitorConfigurationClientCertificateDetailPrivateKey

    Content string
    Content of the private key file.
    FileName string
    Name of the private key file.
    Content string
    Content of the private key file.
    FileName string
    Name of the private key file.
    content String
    Content of the private key file.
    fileName String
    Name of the private key file.
    content string
    Content of the private key file.
    fileName string
    Name of the private key file.
    content str
    Content of the private key file.
    file_name str
    Name of the private key file.
    content String
    Content of the private key file.
    fileName String
    Name of the private key file.

    GetMonitorConfigurationDnsConfiguration

    IsOverrideDns bool
    If isOverrideDns is true, then DNS settings will be overridden.
    OverrideDnsIp string
    Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
    IsOverrideDns bool
    If isOverrideDns is true, then DNS settings will be overridden.
    OverrideDnsIp string
    Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
    isOverrideDns Boolean
    If isOverrideDns is true, then DNS settings will be overridden.
    overrideDnsIp String
    Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
    isOverrideDns boolean
    If isOverrideDns is true, then DNS settings will be overridden.
    overrideDnsIp string
    Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
    is_override_dns bool
    If isOverrideDns is true, then DNS settings will be overridden.
    override_dns_ip str
    Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
    isOverrideDns Boolean
    If isOverrideDns is true, then DNS settings will be overridden.
    overrideDnsIp String
    Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.

    GetMonitorConfigurationNetworkConfiguration

    NumberOfHops int
    Number of hops.
    ProbeMode string
    Type of probe mode when TCP protocol is selected.
    ProbePerHop int
    Number of probes per hop.
    Protocol string
    Type of protocol.
    TransmissionRate int
    Number of probe packets sent out simultaneously.
    NumberOfHops int
    Number of hops.
    ProbeMode string
    Type of probe mode when TCP protocol is selected.
    ProbePerHop int
    Number of probes per hop.
    Protocol string
    Type of protocol.
    TransmissionRate int
    Number of probe packets sent out simultaneously.
    numberOfHops Integer
    Number of hops.
    probeMode String
    Type of probe mode when TCP protocol is selected.
    probePerHop Integer
    Number of probes per hop.
    protocol String
    Type of protocol.
    transmissionRate Integer
    Number of probe packets sent out simultaneously.
    numberOfHops number
    Number of hops.
    probeMode string
    Type of probe mode when TCP protocol is selected.
    probePerHop number
    Number of probes per hop.
    protocol string
    Type of protocol.
    transmissionRate number
    Number of probe packets sent out simultaneously.
    number_of_hops int
    Number of hops.
    probe_mode str
    Type of probe mode when TCP protocol is selected.
    probe_per_hop int
    Number of probes per hop.
    protocol str
    Type of protocol.
    transmission_rate int
    Number of probe packets sent out simultaneously.
    numberOfHops Number
    Number of hops.
    probeMode String
    Type of probe mode when TCP protocol is selected.
    probePerHop Number
    Number of probes per hop.
    protocol String
    Type of protocol.
    transmissionRate Number
    Number of probe packets sent out simultaneously.

    GetMonitorConfigurationReqAuthenticationDetail

    AuthHeaders List<GetMonitorConfigurationReqAuthenticationDetailAuthHeader>
    List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    AuthRequestMethod string
    Request method.
    AuthRequestPostBody string
    Request post body.
    AuthToken string
    Authentication token.
    AuthUrl string
    URL to get authentication token.
    AuthUserName string
    User name for authentication.
    AuthUserPassword string
    User password for authentication.
    OauthScheme string
    Request HTTP OAuth scheme.
    AuthHeaders []GetMonitorConfigurationReqAuthenticationDetailAuthHeader
    List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    AuthRequestMethod string
    Request method.
    AuthRequestPostBody string
    Request post body.
    AuthToken string
    Authentication token.
    AuthUrl string
    URL to get authentication token.
    AuthUserName string
    User name for authentication.
    AuthUserPassword string
    User password for authentication.
    OauthScheme string
    Request HTTP OAuth scheme.
    authHeaders List<GetMonitorConfigurationReqAuthenticationDetailAuthHeader>
    List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    authRequestMethod String
    Request method.
    authRequestPostBody String
    Request post body.
    authToken String
    Authentication token.
    authUrl String
    URL to get authentication token.
    authUserName String
    User name for authentication.
    authUserPassword String
    User password for authentication.
    oauthScheme String
    Request HTTP OAuth scheme.
    authHeaders GetMonitorConfigurationReqAuthenticationDetailAuthHeader[]
    List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    authRequestMethod string
    Request method.
    authRequestPostBody string
    Request post body.
    authToken string
    Authentication token.
    authUrl string
    URL to get authentication token.
    authUserName string
    User name for authentication.
    authUserPassword string
    User password for authentication.
    oauthScheme string
    Request HTTP OAuth scheme.
    auth_headers Sequence[apmsynthetics.GetMonitorConfigurationReqAuthenticationDetailAuthHeader]
    List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    auth_request_method str
    Request method.
    auth_request_post_body str
    Request post body.
    auth_token str
    Authentication token.
    auth_url str
    URL to get authentication token.
    auth_user_name str
    User name for authentication.
    auth_user_password str
    User password for authentication.
    oauth_scheme str
    Request HTTP OAuth scheme.
    authHeaders List<Property Map>
    List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
    authRequestMethod String
    Request method.
    authRequestPostBody String
    Request post body.
    authToken String
    Authentication token.
    authUrl String
    URL to get authentication token.
    authUserName String
    User name for authentication.
    authUserPassword String
    User password for authentication.
    oauthScheme String
    Request HTTP OAuth scheme.

    GetMonitorConfigurationReqAuthenticationDetailAuthHeader

    HeaderName string
    Name of the header.
    HeaderValue string
    Value of the header.
    HeaderName string
    Name of the header.
    HeaderValue string
    Value of the header.
    headerName String
    Name of the header.
    headerValue String
    Value of the header.
    headerName string
    Name of the header.
    headerValue string
    Value of the header.
    header_name str
    Name of the header.
    header_value str
    Value of the header.
    headerName String
    Name of the header.
    headerValue String
    Value of the header.

    GetMonitorConfigurationRequestHeader

    HeaderName string
    Name of the header.
    HeaderValue string
    Value of the header.
    HeaderName string
    Name of the header.
    HeaderValue string
    Value of the header.
    headerName String
    Name of the header.
    headerValue String
    Value of the header.
    headerName string
    Name of the header.
    headerValue string
    Value of the header.
    header_name str
    Name of the header.
    header_value str
    Value of the header.
    headerName String
    Name of the header.
    headerValue String
    Value of the header.

    GetMonitorConfigurationRequestQueryParam

    ParamName string
    Name of the parameter.
    ParamValue string
    Value of the parameter.
    ParamName string
    Name of the parameter.
    ParamValue string
    Value of the parameter.
    paramName String
    Name of the parameter.
    paramValue String
    Value of the parameter.
    paramName string
    Name of the parameter.
    paramValue string
    Value of the parameter.
    param_name str
    Name of the parameter.
    param_value str
    Value of the parameter.
    paramName String
    Name of the parameter.
    paramValue String
    Value of the parameter.

    GetMonitorConfigurationVerifyText

    Text string
    Verification text in the response.
    Text string
    Verification text in the response.
    text String
    Verification text in the response.
    text string
    Verification text in the response.
    text str
    Verification text in the response.
    text String
    Verification text in the response.

    GetMonitorMaintenanceWindowSchedule

    TimeEnded string
    End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    TimeStarted string
    Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    TimeEnded string
    End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    TimeStarted string
    Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeEnded String
    End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeStarted String
    Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeEnded string
    End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeStarted string
    Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    time_ended str
    End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    time_started str
    Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeEnded String
    End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeStarted String
    Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

    GetMonitorScriptParameter

    IsOverwritten bool
    If parameter value is default or overwritten.
    IsSecret bool
    Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
    MonitorScriptParameters List<GetMonitorScriptParameterMonitorScriptParameter>
    Details of the script parameter that can be used to overwrite the parameter present in the script.
    ParamName string
    Name of the parameter.
    ParamValue string
    Value of the parameter.
    IsOverwritten bool
    If parameter value is default or overwritten.
    IsSecret bool
    Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
    MonitorScriptParameters []GetMonitorScriptParameterMonitorScriptParameter
    Details of the script parameter that can be used to overwrite the parameter present in the script.
    ParamName string
    Name of the parameter.
    ParamValue string
    Value of the parameter.
    isOverwritten Boolean
    If parameter value is default or overwritten.
    isSecret Boolean
    Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
    monitorScriptParameters List<GetMonitorScriptParameterMonitorScriptParameter>
    Details of the script parameter that can be used to overwrite the parameter present in the script.
    paramName String
    Name of the parameter.
    paramValue String
    Value of the parameter.
    isOverwritten boolean
    If parameter value is default or overwritten.
    isSecret boolean
    Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
    monitorScriptParameters GetMonitorScriptParameterMonitorScriptParameter[]
    Details of the script parameter that can be used to overwrite the parameter present in the script.
    paramName string
    Name of the parameter.
    paramValue string
    Value of the parameter.
    is_overwritten bool
    If parameter value is default or overwritten.
    is_secret bool
    Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
    monitor_script_parameters Sequence[apmsynthetics.GetMonitorScriptParameterMonitorScriptParameter]
    Details of the script parameter that can be used to overwrite the parameter present in the script.
    param_name str
    Name of the parameter.
    param_value str
    Value of the parameter.
    isOverwritten Boolean
    If parameter value is default or overwritten.
    isSecret Boolean
    Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
    monitorScriptParameters List<Property Map>
    Details of the script parameter that can be used to overwrite the parameter present in the script.
    paramName String
    Name of the parameter.
    paramValue String
    Value of the parameter.

    GetMonitorScriptParameterMonitorScriptParameter

    ParamName string
    Name of the parameter.
    ParamValue string
    Value of the parameter.
    ParamName string
    Name of the parameter.
    ParamValue string
    Value of the parameter.
    paramName String
    Name of the parameter.
    paramValue String
    Value of the parameter.
    paramName string
    Name of the parameter.
    paramValue string
    Value of the parameter.
    param_name str
    Name of the parameter.
    param_value str
    Value of the parameter.
    paramName String
    Name of the parameter.
    paramValue String
    Value of the parameter.

    GetMonitorVantagePoint

    DisplayName string
    Unique name that can be edited. The name should not contain any confidential information.
    Name string
    Name of the vantage point.
    DisplayName string
    Unique name that can be edited. The name should not contain any confidential information.
    Name string
    Name of the vantage point.
    displayName String
    Unique name that can be edited. The name should not contain any confidential information.
    name String
    Name of the vantage point.
    displayName string
    Unique name that can be edited. The name should not contain any confidential information.
    name string
    Name of the vantage point.
    display_name str
    Unique name that can be edited. The name should not contain any confidential information.
    name str
    Name of the vantage point.
    displayName String
    Unique name that can be edited. The name should not contain any confidential information.
    name String
    Name of the vantage point.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi