oci.ApmSynthetics.Config

VantagePoints List<ConfigVantagePoint>

(Updatable) 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.

(Updatable) A list of public and dedicated vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points, and /dedicatedVantagePoints to fetch dedicated vantage points.

** 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

AvailabilityConfiguration ConfigAvailabilityConfiguration

(Updatable) Monitor availability configuration details.

Configuration ConfigConfiguration

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

(Updatable) Details of monitor configuration.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsRunNow bool

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

IsRunOnce bool

(Updatable) If runOnce is enabled, then the monitor will run once.

MaintenanceWindowSchedule ConfigMaintenanceWindowSchedule

(Updatable) Details required to schedule maintenance window.

SchedulingPolicy string

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

ScriptId string

(Updatable) 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<ConfigScriptParameter>

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

Status string

(Updatable) Enables or disables the monitor.

Target string

(Updatable) 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

(Updatable) 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.

ApmDomainId string

(Updatable) The APM domain ID the request is intended for.

DisplayName string

Unique name that can be edited. The name should not contain any confidential information.

MonitorType string

Type of monitor.

VantagePoints []ConfigVantagePointArgs

** 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

AvailabilityConfiguration ConfigAvailabilityConfigurationArgs

(Updatable) Monitor availability configuration details.

Configuration ConfigConfigurationArgs

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

(Updatable) Details of monitor configuration.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsRunNow bool

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

IsRunOnce bool

(Updatable) If runOnce is enabled, then the monitor will run once.

MaintenanceWindowSchedule ConfigMaintenanceWindowScheduleArgs

(Updatable) Details required to schedule maintenance window.

SchedulingPolicy string

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

ScriptId string

(Updatable) 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 []ConfigScriptParameterArgs

Status string

(Updatable) Enables or disables the monitor.

Target string

vantagePoints List<ConfigVantagePoint>

apmDomainId String

(Updatable) The APM domain ID the request is intended for.

displayName String

Unique name that can be edited. The name should not contain any confidential information.

monitorType String

Type of monitor.

repeatIntervalInSeconds Integer

** 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

availabilityConfiguration ConfigAvailabilityConfiguration

(Updatable) Monitor availability configuration details.

batchIntervalInSeconds Integer

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

maintenanceWindowSchedule ConfigMaintenanceWindowSchedule

(Updatable) Details of monitor configuration.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunNow Boolean

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

isRunOnce Boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

(Updatable) Details required to schedule maintenance window.

schedulingPolicy String

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

scriptId String

(Updatable) 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<ConfigScriptParameter>

status String

(Updatable) Enables or disables the monitor.

target String

timeoutInSeconds Integer

apmDomainId string

(Updatable) The APM domain ID the request is intended for.

displayName string

Unique name that can be edited. The name should not contain any confidential information.

monitorType string

Type of monitor.

repeatIntervalInSeconds number

vantagePoints ConfigVantagePoint[]

** 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

availabilityConfiguration ConfigAvailabilityConfiguration

(Updatable) Monitor availability configuration details.

batchIntervalInSeconds number

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

maintenanceWindowSchedule ConfigMaintenanceWindowSchedule

(Updatable) Details of monitor configuration.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunNow boolean

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

isRunOnce boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

(Updatable) Details required to schedule maintenance window.

schedulingPolicy string

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

scriptId string

(Updatable) 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 ConfigScriptParameter[]

status string

(Updatable) Enables or disables the monitor.

target string

timeoutInSeconds number

apm_domain_id str

(Updatable) The APM domain ID the request is intended for.

display_name str

Unique name that can be edited. The name should not contain any confidential information.

monitor_type str

Type of monitor.

repeat_interval_in_seconds int

vantage_points Sequence[apmsynthetics.ConfigVantagePointArgs]

** 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

availability_configuration apmsynthetics.ConfigAvailabilityConfigurationArgs

(Updatable) Monitor availability configuration details.

batch_interval_in_seconds int

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

configuration apmsynthetics.ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

is_run_now bool

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

is_run_once bool

(Updatable) If runOnce is enabled, then the monitor will run once.

maintenance_window_schedule apmsynthetics.ConfigMaintenanceWindowScheduleArgs

(Updatable) Details required to schedule maintenance window.

scheduling_policy str

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

script_id str

(Updatable) 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.ConfigScriptParameterArgs]

status str

(Updatable) Enables or disables the monitor.

target str

timeout_in_seconds int

apmDomainId String

(Updatable) The APM domain ID the request is intended for.

displayName String

Unique name that can be edited. The name should not contain any confidential information.

monitorType String

Type of monitor.

repeatIntervalInSeconds Number

vantagePoints List<Property Map>

** 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

availabilityConfiguration Property Map

(Updatable) Monitor availability configuration details.

batchIntervalInSeconds Number

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

configuration Property Map

(Updatable) Details of monitor configuration.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunNow Boolean

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

isRunOnce Boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

maintenanceWindowSchedule Property Map

(Updatable) Details required to schedule maintenance window.

schedulingPolicy String

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

scriptId String

(Updatable) 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>

status String

(Updatable) Enables or disables the monitor.

target String

timeoutInSeconds Number

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
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
VantagePointCount int: Number of vantage points where monitor is running.

Id string: The provider-assigned unique ID for this managed resource.
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
VantagePointCount int: Number of vantage points where monitor is running.

id String: The provider-assigned unique ID for this managed resource.
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
vantagePointCount Integer: Number of vantage points where monitor is running.

id string: The provider-assigned unique ID for this managed resource.
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
vantagePointCount number: Number of vantage points where monitor is running.

id str: The provider-assigned unique ID for this managed resource.
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
vantage_point_count int: Number of vantage points where monitor is running.

id String: The provider-assigned unique ID for this managed resource.
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
vantagePointCount Number: Number of vantage points where monitor is running.

Look up Existing Config Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apm_domain_id: Optional[str] = None,
        availability_configuration: Optional[_apmsynthetics.ConfigAvailabilityConfigurationArgs] = None,
        batch_interval_in_seconds: Optional[int] = None,
        configuration: Optional[_apmsynthetics.ConfigConfigurationArgs] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_run_now: Optional[bool] = None,
        is_run_once: Optional[bool] = None,
        maintenance_window_schedule: Optional[_apmsynthetics.ConfigMaintenanceWindowScheduleArgs] = None,
        monitor_type: Optional[str] = None,
        repeat_interval_in_seconds: Optional[int] = None,
        scheduling_policy: Optional[str] = None,
        script_id: Optional[str] = None,
        script_name: Optional[str] = None,
        script_parameters: Optional[Sequence[_apmsynthetics.ConfigScriptParameterArgs]] = None,
        status: Optional[str] = None,
        target: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        timeout_in_seconds: Optional[int] = None,
        vantage_point_count: Optional[int] = None,
        vantage_points: Optional[Sequence[_apmsynthetics.ConfigVantagePointArgs]] = None) -> Config

func GetConfig(ctx *Context, name string, id IDInput, state *ConfigState, opts ...ResourceOption) (*Config, error)

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

public static Config get(String name, Output<String> id, ConfigState 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.

The following state arguments are supported:

ApmDomainId string

(Updatable) The APM domain ID the request is intended for.

AvailabilityConfiguration ConfigAvailabilityConfiguration

(Updatable) Monitor availability configuration details.

Configuration ConfigConfiguration

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

(Updatable) Details of monitor configuration.

DefinedTags Dictionary<string, object>

(Updatable) 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>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsRunNow bool

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

IsRunOnce bool

(Updatable) If runOnce is enabled, then the monitor will run once.

MaintenanceWindowSchedule ConfigMaintenanceWindowSchedule

(Updatable) Details required to schedule maintenance window.

MonitorType string

Type of monitor.

ScriptParameters List<ConfigScriptParameter>

SchedulingPolicy string

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

ScriptId string

(Updatable) 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.

Status string

(Updatable) Enables or disables the monitor.

Target string

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

VantagePoints List<ConfigVantagePoint>

VantagePointCount int

Number of vantage points where monitor is running.

** 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

ApmDomainId string

(Updatable) The APM domain ID the request is intended for.

AvailabilityConfiguration ConfigAvailabilityConfigurationArgs

(Updatable) Monitor availability configuration details.

Configuration ConfigConfigurationArgs

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

(Updatable) Details of monitor configuration.

DefinedTags map[string]interface{}

(Updatable) 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{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsRunNow bool

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

IsRunOnce bool

(Updatable) If runOnce is enabled, then the monitor will run once.

MaintenanceWindowSchedule ConfigMaintenanceWindowScheduleArgs

(Updatable) Details required to schedule maintenance window.

MonitorType string

Type of monitor.

ScriptParameters []ConfigScriptParameterArgs

SchedulingPolicy string

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

ScriptId string

(Updatable) 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.

Status string

(Updatable) Enables or disables the monitor.

Target string

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

VantagePoints []ConfigVantagePointArgs

VantagePointCount int

Number of vantage points where monitor is running.

** 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

apmDomainId String

(Updatable) The APM domain ID the request is intended for.

availabilityConfiguration ConfigAvailabilityConfiguration

(Updatable) Monitor availability configuration details.

batchIntervalInSeconds Integer

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

maintenanceWindowSchedule ConfigMaintenanceWindowSchedule

(Updatable) Details of monitor configuration.

definedTags Map<String,Object>

(Updatable) 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>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunNow Boolean

(Updatable) If isRunNow is enabled, then the monitor will run immediately.

isRunOnce Boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

(Updatable) Details required to schedule maintenance window.

monitorType String

Type of monitor.

repeatIntervalInSeconds Integer

schedulingPolicy String

(Updatable) Scheduling policy to decide the distribution of monitor executions on vantage points.

scriptId String

(Updatable) 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<ConfigScriptParameter>

status String

(Updatable) Enables or disables the monitor.

target String

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

vantagePointCount Integer

Number of vantage points where monitor is running.

vantagePoints List<ConfigVantagePoint>

** 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

apmDomainId string

(Updatable) The APM domain ID the request is intended for.

availabilityConfiguration ConfigAvailabilityConfiguration

(Updatable) Monitor availability configuration details.

batchIntervalInSeconds number

(Updatable) Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).