Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
oci.StackMonitoring.getMonitoredResourceTask
Explore with Pulumi AI
This data source provides details about a specific Monitored Resource Task resource in Oracle Cloud Infrastructure Stack Monitoring service.
Gets stack monitoring resource task details by identifier OCID.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testMonitoredResourceTask = oci.StackMonitoring.getMonitoredResourceTask({
monitoredResourceTaskId: testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.id,
});
import pulumi
import pulumi_oci as oci
test_monitored_resource_task = oci.StackMonitoring.get_monitored_resource_task(monitored_resource_task_id=test_monitored_resource_task_oci_stack_monitoring_monitored_resource_task["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/stackmonitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := stackmonitoring.GetMonitoredResourceTask(ctx, &stackmonitoring.GetMonitoredResourceTaskArgs{
MonitoredResourceTaskId: testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.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 testMonitoredResourceTask = Oci.StackMonitoring.GetMonitoredResourceTask.Invoke(new()
{
MonitoredResourceTaskId = testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.StackMonitoring.StackMonitoringFunctions;
import com.pulumi.oci.StackMonitoring.inputs.GetMonitoredResourceTaskArgs;
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 testMonitoredResourceTask = StackMonitoringFunctions.getMonitoredResourceTask(GetMonitoredResourceTaskArgs.builder()
.monitoredResourceTaskId(testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.id())
.build());
}
}
variables:
testMonitoredResourceTask:
fn::invoke:
function: oci:StackMonitoring:getMonitoredResourceTask
arguments:
monitoredResourceTaskId: ${testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.id}
Using getMonitoredResourceTask
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 getMonitoredResourceTask(args: GetMonitoredResourceTaskArgs, opts?: InvokeOptions): Promise<GetMonitoredResourceTaskResult>
function getMonitoredResourceTaskOutput(args: GetMonitoredResourceTaskOutputArgs, opts?: InvokeOptions): Output<GetMonitoredResourceTaskResult>
def get_monitored_resource_task(monitored_resource_task_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetMonitoredResourceTaskResult
def get_monitored_resource_task_output(monitored_resource_task_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetMonitoredResourceTaskResult]
func GetMonitoredResourceTask(ctx *Context, args *GetMonitoredResourceTaskArgs, opts ...InvokeOption) (*GetMonitoredResourceTaskResult, error)
func GetMonitoredResourceTaskOutput(ctx *Context, args *GetMonitoredResourceTaskOutputArgs, opts ...InvokeOption) GetMonitoredResourceTaskResultOutput
> Note: This function is named GetMonitoredResourceTask
in the Go SDK.
public static class GetMonitoredResourceTask
{
public static Task<GetMonitoredResourceTaskResult> InvokeAsync(GetMonitoredResourceTaskArgs args, InvokeOptions? opts = null)
public static Output<GetMonitoredResourceTaskResult> Invoke(GetMonitoredResourceTaskInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMonitoredResourceTaskResult> getMonitoredResourceTask(GetMonitoredResourceTaskArgs args, InvokeOptions options)
public static Output<GetMonitoredResourceTaskResult> getMonitoredResourceTask(GetMonitoredResourceTaskArgs args, InvokeOptions options)
fn::invoke:
function: oci:StackMonitoring/getMonitoredResourceTask:getMonitoredResourceTask
arguments:
# arguments dictionary
The following arguments are supported:
- Monitored
Resource Task Id This property is required. string - The OCID of stack monitoring resource task.
- Monitored
Resource Task Id This property is required. string - The OCID of stack monitoring resource task.
- monitored
Resource Task Id This property is required. String - The OCID of stack monitoring resource task.
- monitored
Resource Task Id This property is required. string - The OCID of stack monitoring resource task.
- monitored_
resource_ task_ id This property is required. str - The OCID of stack monitoring resource task.
- monitored
Resource Task Id This property is required. String - The OCID of stack monitoring resource task.
getMonitoredResourceTask Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment identifier.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Dictionary<string, string>
- 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
- Task identifier OCID.
- Monitored
Resource stringTask Id - Name string
- Property name.
- State string
- The current state of the stack monitoring resource task.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Task
Details List<GetMonitored Resource Task Task Detail> - The request details for the performing the task.
- Tenant
Id string - The OCID of the tenancy.
- Time
Created string - The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
- Time
Updated string - The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
- Type string
- Type of the task.
- Work
Request List<string>Ids - Identifiers OCID for work requests submitted for this task.
- Compartment
Id string - The OCID of the compartment identifier.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- map[string]string
- 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
- Task identifier OCID.
- Monitored
Resource stringTask Id - Name string
- Property name.
- State string
- The current state of the stack monitoring resource task.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Task
Details []GetMonitored Resource Task Task Detail - The request details for the performing the task.
- Tenant
Id string - The OCID of the tenancy.
- Time
Created string - The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
- Time
Updated string - The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
- Type string
- Type of the task.
- Work
Request []stringIds - Identifiers OCID for work requests submitted for this task.
- compartment
Id String - The OCID of the compartment identifier.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Map<String,String>
- 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
- Task identifier OCID.
- monitored
Resource StringTask Id - name String
- Property name.
- state String
- The current state of the stack monitoring resource task.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- task
Details List<GetMonitored Resource Task Task Detail> - The request details for the performing the task.
- tenant
Id String - The OCID of the tenancy.
- time
Created String - The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
- time
Updated String - The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
- type String
- Type of the task.
- work
Request List<String>Ids - Identifiers OCID for work requests submitted for this task.
- compartment
Id string - The OCID of the compartment identifier.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- {[key: string]: string}
- 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
- Task identifier OCID.
- monitored
Resource stringTask Id - name string
- Property name.
- state string
- The current state of the stack monitoring resource task.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- task
Details GetMonitored Resource Task Task Detail[] - The request details for the performing the task.
- tenant
Id string - The OCID of the tenancy.
- time
Created string - The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
- time
Updated string - The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
- type string
- Type of the task.
- work
Request string[]Ids - Identifiers OCID for work requests submitted for this task.
- compartment_
id str - The OCID of the compartment identifier.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Mapping[str, str]
- 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
- Task identifier OCID.
- monitored_
resource_ strtask_ id - name str
- Property name.
- state str
- The current state of the stack monitoring resource task.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- task_
details Sequence[stackmonitoring.Get Monitored Resource Task Task Detail] - The request details for the performing the task.
- tenant_
id str - The OCID of the tenancy.
- time_
created str - The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
- time_
updated str - The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
- type str
- Type of the task.
- work_
request_ Sequence[str]ids - Identifiers OCID for work requests submitted for this task.
- compartment
Id String - The OCID of the compartment identifier.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Map<String>
- 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
- Task identifier OCID.
- monitored
Resource StringTask Id - name String
- Property name.
- state String
- The current state of the stack monitoring resource task.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- task
Details List<Property Map> - The request details for the performing the task.
- tenant
Id String - The OCID of the tenancy.
- time
Created String - The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
- time
Updated String - The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
- type String
- Type of the task.
- work
Request List<String>Ids - Identifiers OCID for work requests submitted for this task.
Supporting Types
GetMonitoredResourceTaskTaskDetail
- Agent
Id This property is required. string - Management Agent Identifier OCID.
- Availability
Proxy Metric Collection Interval This property is required. int - Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
- Availability
Proxy Metrics This property is required. List<string> - List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
- Console
Path Prefix This property is required. string - The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
- External
Id Mapping This property is required. string - The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
- Handler
Type This property is required. string - Type of the handler.
- Is
Enable This property is required. bool - True to enable the receiver and false to disable the receiver on the agent.
- Lifecycle
Status Mappings For Up Statuses This property is required. List<string> - Lifecycle states of the external resource which reflects the status of the resource being up.
- Namespace
This property is required. string - Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
- Receiver
Properties This property is required. List<GetMonitored Resource Task Task Detail Receiver Property> - Properties for agent receiver.
- Resource
Group This property is required. string - The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
- Resource
Name Filter This property is required. string - The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
- Resource
Name Mapping This property is required. string - The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
- Resource
Type Filter This property is required. string - The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
- Resource
Type Mapping This property is required. string - The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
- Resource
Types Configurations This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration> - A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
- Service
Base Url This property is required. string - The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
- Should
Use Metrics Flow For Status This property is required. bool - Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
- Source
This property is required. string - Source from where the metrics pushed to telemetry. Possible values:
- OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
- OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
- OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
- OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
- Type
This property is required. string - Type of the task.
- Agent
Id This property is required. string - Management Agent Identifier OCID.
- Availability
Proxy Metric Collection Interval This property is required. int - Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
- Availability
Proxy Metrics This property is required. []string - List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
- Console
Path Prefix This property is required. string - The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
- External
Id Mapping This property is required. string - The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
- Handler
Type This property is required. string - Type of the handler.
- Is
Enable This property is required. bool - True to enable the receiver and false to disable the receiver on the agent.
- Lifecycle
Status Mappings For Up Statuses This property is required. []string - Lifecycle states of the external resource which reflects the status of the resource being up.
- Namespace
This property is required. string - Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
- Receiver
Properties This property is required. []GetMonitored Resource Task Task Detail Receiver Property - Properties for agent receiver.
- Resource
Group This property is required. string - The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
- Resource
Name Filter This property is required. string - The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
- Resource
Name Mapping This property is required. string - The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
- Resource
Type Filter This property is required. string - The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
- Resource
Type Mapping This property is required. string - The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
- Resource
Types Configurations This property is required. []GetMonitored Resource Task Task Detail Resource Types Configuration - A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
- Service
Base Url This property is required. string - The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
- Should
Use Metrics Flow For Status This property is required. bool - Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
- Source
This property is required. string - Source from where the metrics pushed to telemetry. Possible values:
- OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
- OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
- OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
- OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
- Type
This property is required. string - Type of the task.
- agent
Id This property is required. String - Management Agent Identifier OCID.
- availability
Proxy Metric Collection Interval This property is required. Integer - Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
- availability
Proxy Metrics This property is required. List<String> - List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
- console
Path Prefix This property is required. String - The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
- external
Id Mapping This property is required. String - The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
- handler
Type This property is required. String - Type of the handler.
- is
Enable This property is required. Boolean - True to enable the receiver and false to disable the receiver on the agent.
- lifecycle
Status Mappings For Up Statuses This property is required. List<String> - Lifecycle states of the external resource which reflects the status of the resource being up.
- namespace
This property is required. String - Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
- receiver
Properties This property is required. List<GetMonitored Resource Task Task Detail Receiver Property> - Properties for agent receiver.
- resource
Group This property is required. String - The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
- resource
Name Filter This property is required. String - The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
- resource
Name Mapping This property is required. String - The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
- resource
Type Filter This property is required. String - The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
- resource
Type Mapping This property is required. String - The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
- resource
Types Configurations This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration> - A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
- service
Base Url This property is required. String - The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
- should
Use Metrics Flow For Status This property is required. Boolean - Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
- source
This property is required. String - Source from where the metrics pushed to telemetry. Possible values:
- OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
- OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
- OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
- OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
- type
This property is required. String - Type of the task.
- agent
Id This property is required. string - Management Agent Identifier OCID.
- availability
Proxy Metric Collection Interval This property is required. number - Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
- availability
Proxy Metrics This property is required. string[] - List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
- console
Path Prefix This property is required. string - The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
- external
Id Mapping This property is required. string - The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
- handler
Type This property is required. string - Type of the handler.
- is
Enable This property is required. boolean - True to enable the receiver and false to disable the receiver on the agent.
- lifecycle
Status Mappings For Up Statuses This property is required. string[] - Lifecycle states of the external resource which reflects the status of the resource being up.
- namespace
This property is required. string - Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
- receiver
Properties This property is required. GetMonitored Resource Task Task Detail Receiver Property[] - Properties for agent receiver.
- resource
Group This property is required. string - The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
- resource
Name Filter This property is required. string - The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
- resource
Name Mapping This property is required. string - The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
- resource
Type Filter This property is required. string - The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
- resource
Type Mapping This property is required. string - The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
- resource
Types Configurations This property is required. GetMonitored Resource Task Task Detail Resource Types Configuration[] - A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
- service
Base Url This property is required. string - The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
- should
Use Metrics Flow For Status This property is required. boolean - Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
- source
This property is required. string - Source from where the metrics pushed to telemetry. Possible values:
- OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
- OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
- OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
- OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
- type
This property is required. string - Type of the task.
- agent_
id This property is required. str - Management Agent Identifier OCID.
- availability_
proxy_ metric_ collection_ interval This property is required. int - Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
- availability_
proxy_ metrics This property is required. Sequence[str] - List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
- console_
path_ prefix This property is required. str - The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
- external_
id_ mapping This property is required. str - The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
- handler_
type This property is required. str - Type of the handler.
- is_
enable This property is required. bool - True to enable the receiver and false to disable the receiver on the agent.
- lifecycle_
status_ mappings_ for_ up_ statuses This property is required. Sequence[str] - Lifecycle states of the external resource which reflects the status of the resource being up.
- namespace
This property is required. str - Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
- receiver_
properties This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Receiver Property] - Properties for agent receiver.
- resource_
group This property is required. str - The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
- resource_
name_ filter This property is required. str - The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
- resource_
name_ mapping This property is required. str - The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
- resource_
type_ filter This property is required. str - The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
- resource_
type_ mapping This property is required. str - The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
- resource_
types_ configurations This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Resource Types Configuration] - A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
- service_
base_ url This property is required. str - The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
- should_
use_ metrics_ flow_ for_ status This property is required. bool - Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
- source
This property is required. str - Source from where the metrics pushed to telemetry. Possible values:
- OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
- OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
- OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
- OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
- type
This property is required. str - Type of the task.
- agent
Id This property is required. String - Management Agent Identifier OCID.
- availability
Proxy Metric Collection Interval This property is required. Number - Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
- availability
Proxy Metrics This property is required. List<String> - List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
- console
Path Prefix This property is required. String - The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
- external
Id Mapping This property is required. String - The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
- handler
Type This property is required. String - Type of the handler.
- is
Enable This property is required. Boolean - True to enable the receiver and false to disable the receiver on the agent.
- lifecycle
Status Mappings For Up Statuses This property is required. List<String> - Lifecycle states of the external resource which reflects the status of the resource being up.
- namespace
This property is required. String - Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
- receiver
Properties This property is required. List<Property Map> - Properties for agent receiver.
- resource
Group This property is required. String - The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
- resource
Name Filter This property is required. String - The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
- resource
Name Mapping This property is required. String - The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
- resource
Type Filter This property is required. String - The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
- resource
Type Mapping This property is required. String - The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
- resource
Types Configurations This property is required. List<Property Map> - A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
- service
Base Url This property is required. String - The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
- should
Use Metrics Flow For Status This property is required. Boolean - Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
- source
This property is required. String - Source from where the metrics pushed to telemetry. Possible values:
- OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
- OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
- OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
- OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
- type
This property is required. String - Type of the task.
GetMonitoredResourceTaskTaskDetailReceiverProperty
- Listener
Port This property is required. int - Receiver listener port.
- Listener
Port This property is required. int - Receiver listener port.
- listener
Port This property is required. Integer - Receiver listener port.
- listener
Port This property is required. number - Receiver listener port.
- listener_
port This property is required. int - Receiver listener port.
- listener
Port This property is required. Number - Receiver listener port.
GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration
- Availability
Metrics Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Availability Metrics Config> - Availability metrics details.
- Handler
Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config> - Specific resource mapping configurations for Agent Extension Handlers.
- Resource
Type This property is required. string - Resource type.
- Availability
Metrics Configs This property is required. []GetMonitored Resource Task Task Detail Resource Types Configuration Availability Metrics Config - Availability metrics details.
- Handler
Configs This property is required. []GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config - Specific resource mapping configurations for Agent Extension Handlers.
- Resource
Type This property is required. string - Resource type.
- availability
Metrics Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Availability Metrics Config> - Availability metrics details.
- handler
Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config> - Specific resource mapping configurations for Agent Extension Handlers.
- resource
Type This property is required. String - Resource type.
- availability
Metrics Configs This property is required. GetMonitored Resource Task Task Detail Resource Types Configuration Availability Metrics Config[] - Availability metrics details.
- handler
Configs This property is required. GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config[] - Specific resource mapping configurations for Agent Extension Handlers.
- resource
Type This property is required. string - Resource type.
- availability_
metrics_ configs This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Resource Types Configuration Availability Metrics Config] - Availability metrics details.
- handler_
configs This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Resource Types Configuration Handler Config] - Specific resource mapping configurations for Agent Extension Handlers.
- resource_
type This property is required. str - Resource type.
- availability
Metrics Configs This property is required. List<Property Map> - Availability metrics details.
- handler
Configs This property is required. List<Property Map> - Specific resource mapping configurations for Agent Extension Handlers.
- resource
Type This property is required. String - Resource type.
GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationAvailabilityMetricsConfig
- Collection
Interval In Seconds This property is required. int - Availability metric collection internal in seconds.
- Metrics
This property is required. List<string> - List of metrics used for availability calculation for the resource.
- Collection
Interval In Seconds This property is required. int - Availability metric collection internal in seconds.
- Metrics
This property is required. []string - List of metrics used for availability calculation for the resource.
- collection
Interval In Seconds This property is required. Integer - Availability metric collection internal in seconds.
- metrics
This property is required. List<String> - List of metrics used for availability calculation for the resource.
- collection
Interval In Seconds This property is required. number - Availability metric collection internal in seconds.
- metrics
This property is required. string[] - List of metrics used for availability calculation for the resource.
- collection_
interval_ in_ seconds This property is required. int - Availability metric collection internal in seconds.
- metrics
This property is required. Sequence[str] - List of metrics used for availability calculation for the resource.
- collection
Interval In Seconds This property is required. Number - Availability metric collection internal in seconds.
- metrics
This property is required. List<String> - List of metrics used for availability calculation for the resource.
GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfig
- Collectd
Resource Name Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Collectd Resource Name Config> - Resource name generation overriding configurations for collectd resource types.
- Collector
Types This property is required. List<string> - List of collector/plugin names.
- Handler
Properties This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Handler Property> - List of handler configuration properties
- Metric
Mappings This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Mapping> - List of AgentExtensionHandlerMetricMappingDetails.
- Metric
Name Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Name Config> - Metric name generation overriding configurations.
- Metric
Upload Interval In Seconds This property is required. int - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- Telegraf
Resource Name Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Telegraf Resource Name Config> - Resource name generation overriding configurations for telegraf resource types.
- Telemetry
Resource Group This property is required. string - Resource group string; if not specified, the resource group string will be generated by the handler.
- Collectd
Resource Name Configs This property is required. []GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Collectd Resource Name Config - Resource name generation overriding configurations for collectd resource types.
- Collector
Types This property is required. []string - List of collector/plugin names.
- Handler
Properties This property is required. []GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Handler Property - List of handler configuration properties
- Metric
Mappings This property is required. []GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Mapping - List of AgentExtensionHandlerMetricMappingDetails.
- Metric
Name Configs This property is required. []GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Name Config - Metric name generation overriding configurations.
- Metric
Upload Interval In Seconds This property is required. int - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- Telegraf
Resource Name Configs This property is required. []GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Telegraf Resource Name Config - Resource name generation overriding configurations for telegraf resource types.
- Telemetry
Resource Group This property is required. string - Resource group string; if not specified, the resource group string will be generated by the handler.
- collectd
Resource Name Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Collectd Resource Name Config> - Resource name generation overriding configurations for collectd resource types.
- collector
Types This property is required. List<String> - List of collector/plugin names.
- handler
Properties This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Handler Property> - List of handler configuration properties
- metric
Mappings This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Mapping> - List of AgentExtensionHandlerMetricMappingDetails.
- metric
Name Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Name Config> - Metric name generation overriding configurations.
- metric
Upload Interval In Seconds This property is required. Integer - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- telegraf
Resource Name Configs This property is required. List<GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Telegraf Resource Name Config> - Resource name generation overriding configurations for telegraf resource types.
- telemetry
Resource Group This property is required. String - Resource group string; if not specified, the resource group string will be generated by the handler.
- collectd
Resource Name Configs This property is required. GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Collectd Resource Name Config[] - Resource name generation overriding configurations for collectd resource types.
- collector
Types This property is required. string[] - List of collector/plugin names.
- handler
Properties This property is required. GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Handler Property[] - List of handler configuration properties
- metric
Mappings This property is required. GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Mapping[] - List of AgentExtensionHandlerMetricMappingDetails.
- metric
Name Configs This property is required. GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Name Config[] - Metric name generation overriding configurations.
- metric
Upload Interval In Seconds This property is required. number - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- telegraf
Resource Name Configs This property is required. GetMonitored Resource Task Task Detail Resource Types Configuration Handler Config Telegraf Resource Name Config[] - Resource name generation overriding configurations for telegraf resource types.
- telemetry
Resource Group This property is required. string - Resource group string; if not specified, the resource group string will be generated by the handler.
- collectd_
resource_ name_ configs This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Resource Types Configuration Handler Config Collectd Resource Name Config] - Resource name generation overriding configurations for collectd resource types.
- collector_
types This property is required. Sequence[str] - List of collector/plugin names.
- handler_
properties This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Resource Types Configuration Handler Config Handler Property] - List of handler configuration properties
- metric_
mappings This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Mapping] - List of AgentExtensionHandlerMetricMappingDetails.
- metric_
name_ configs This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Resource Types Configuration Handler Config Metric Name Config] - Metric name generation overriding configurations.
- metric_
upload_ interval_ in_ seconds This property is required. int - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- telegraf_
resource_ name_ configs This property is required. Sequence[stackmonitoring.Get Monitored Resource Task Task Detail Resource Types Configuration Handler Config Telegraf Resource Name Config] - Resource name generation overriding configurations for telegraf resource types.
- telemetry_
resource_ group This property is required. str - Resource group string; if not specified, the resource group string will be generated by the handler.
- collectd
Resource Name Configs This property is required. List<Property Map> - Resource name generation overriding configurations for collectd resource types.
- collector
Types This property is required. List<String> - List of collector/plugin names.
- handler
Properties This property is required. List<Property Map> - List of handler configuration properties
- metric
Mappings This property is required. List<Property Map> - List of AgentExtensionHandlerMetricMappingDetails.
- metric
Name Configs This property is required. List<Property Map> - Metric name generation overriding configurations.
- metric
Upload Interval In Seconds This property is required. Number - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- telegraf
Resource Name Configs This property is required. List<Property Map> - Resource name generation overriding configurations for telegraf resource types.
- telemetry
Resource Group This property is required. String - Resource group string; if not specified, the resource group string will be generated by the handler.
GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig
- Exclude
Properties This property is required. List<string> - List of property names to be excluded.
- Include
Properties This property is required. List<string> - List of property names to be included.
- Suffix
This property is required. string - String to be suffixed to the resource name.
- Exclude
Properties This property is required. []string - List of property names to be excluded.
- Include
Properties This property is required. []string - List of property names to be included.
- Suffix
This property is required. string - String to be suffixed to the resource name.
- exclude
Properties This property is required. List<String> - List of property names to be excluded.
- include
Properties This property is required. List<String> - List of property names to be included.
- suffix
This property is required. String - String to be suffixed to the resource name.
- exclude
Properties This property is required. string[] - List of property names to be excluded.
- include
Properties This property is required. string[] - List of property names to be included.
- suffix
This property is required. string - String to be suffixed to the resource name.
- exclude_
properties This property is required. Sequence[str] - List of property names to be excluded.
- include_
properties This property is required. Sequence[str] - List of property names to be included.
- suffix
This property is required. str - String to be suffixed to the resource name.
- exclude
Properties This property is required. List<String> - List of property names to be excluded.
- include
Properties This property is required. List<String> - List of property names to be included.
- suffix
This property is required. String - String to be suffixed to the resource name.
GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty
GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping
- Collector
Metric Name This property is required. string - Metric name as defined by the collector.
- Is
Skip Upload This property is required. bool - Is ignoring this metric.
- Metric
Upload Interval In Seconds This property is required. int - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- Telemetry
Metric Name This property is required. string - Metric name to be upload to telemetry.
- Collector
Metric Name This property is required. string - Metric name as defined by the collector.
- Is
Skip Upload This property is required. bool - Is ignoring this metric.
- Metric
Upload Interval In Seconds This property is required. int - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- Telemetry
Metric Name This property is required. string - Metric name to be upload to telemetry.
- collector
Metric Name This property is required. String - Metric name as defined by the collector.
- is
Skip Upload This property is required. Boolean - Is ignoring this metric.
- metric
Upload Interval In Seconds This property is required. Integer - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- telemetry
Metric Name This property is required. String - Metric name to be upload to telemetry.
- collector
Metric Name This property is required. string - Metric name as defined by the collector.
- is
Skip Upload This property is required. boolean - Is ignoring this metric.
- metric
Upload Interval In Seconds This property is required. number - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- telemetry
Metric Name This property is required. string - Metric name to be upload to telemetry.
- collector_
metric_ name This property is required. str - Metric name as defined by the collector.
- is_
skip_ upload This property is required. bool - Is ignoring this metric.
- metric_
upload_ interval_ in_ seconds This property is required. int - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- telemetry_
metric_ name This property is required. str - Metric name to be upload to telemetry.
- collector
Metric Name This property is required. String - Metric name as defined by the collector.
- is
Skip Upload This property is required. Boolean - Is ignoring this metric.
- metric
Upload Interval In Seconds This property is required. Number - Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
- telemetry
Metric Name This property is required. String - Metric name to be upload to telemetry.
GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig
- Exclude
Pattern On Prefix This property is required. string - String pattern to be removed from the prefix of the metric name.
- Is
Prefix With Collector Type This property is required. bool - is prefixing the metric with collector type.
- Exclude
Pattern On Prefix This property is required. string - String pattern to be removed from the prefix of the metric name.
- Is
Prefix With Collector Type This property is required. bool - is prefixing the metric with collector type.
- exclude
Pattern On Prefix This property is required. String - String pattern to be removed from the prefix of the metric name.
- is
Prefix With Collector Type This property is required. Boolean - is prefixing the metric with collector type.
- exclude
Pattern On Prefix This property is required. string - String pattern to be removed from the prefix of the metric name.
- is
Prefix With Collector Type This property is required. boolean - is prefixing the metric with collector type.
- exclude_
pattern_ on_ prefix This property is required. str - String pattern to be removed from the prefix of the metric name.
- is_
prefix_ with_ collector_ type This property is required. bool - is prefixing the metric with collector type.
- exclude
Pattern On Prefix This property is required. String - String pattern to be removed from the prefix of the metric name.
- is
Prefix With Collector Type This property is required. Boolean - is prefixing the metric with collector type.
GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig
This property is required. List<string>- List of tag names to be excluded.
This property is required. List<string>- List of tag names to be included.
This property is required. bool- Flag to indicate if only tags will be used for resource name generation.
This property is required. []string- List of tag names to be excluded.
This property is required. []string- List of tag names to be included.
This property is required. bool- Flag to indicate if only tags will be used for resource name generation.
This property is required. List<String>- List of tag names to be excluded.
This property is required. List<String>- List of tag names to be included.
This property is required. Boolean- Flag to indicate if only tags will be used for resource name generation.
This property is required. string[]- List of tag names to be excluded.
This property is required. string[]- List of tag names to be included.
This property is required. boolean- Flag to indicate if only tags will be used for resource name generation.
This property is required. Sequence[str]- List of tag names to be excluded.
This property is required. Sequence[str]- List of tag names to be included.
This property is required. bool- Flag to indicate if only tags will be used for resource name generation.
This property is required. List<String>- List of tag names to be excluded.
This property is required. List<String>- List of tag names to be included.
This property is required. Boolean- Flag to indicate if only tags will be used for resource name generation.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.