Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApmTraces
  5. ScheduledQuery
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

oci.ApmTraces.ScheduledQuery

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Scheduled Query resource in Oracle Cloud Infrastructure Apm Traces service.

    Create a scheduled query in the APM Domain.

    Create ScheduledQuery Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScheduledQuery(name: string, args: ScheduledQueryArgs, opts?: CustomResourceOptions);
    @overload
def ScheduledQuery(resource_name: str,
                   args: ScheduledQueryArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ScheduledQuery(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   apm_domain_id: Optional[str] = None,
                   defined_tags: Optional[Mapping[str, str]] = None,
                   freeform_tags: Optional[Mapping[str, str]] = None,
                   opc_dry_run: Optional[str] = None,
                   scheduled_query_description: Optional[str] = None,
                   scheduled_query_maximum_runtime_in_seconds: Optional[str] = None,
                   scheduled_query_name: Optional[str] = None,
                   scheduled_query_processing_configuration: Optional[ScheduledQueryScheduledQueryProcessingConfigurationArgs] = None,
                   scheduled_query_processing_sub_type: Optional[str] = None,
                   scheduled_query_processing_type: Optional[str] = None,
                   scheduled_query_retention_criteria: Optional[str] = None,
                   scheduled_query_retention_period_in_ms: Optional[str] = None,
                   scheduled_query_schedule: Optional[str] = None,
                   scheduled_query_text: Optional[str] = None)
    func NewScheduledQuery(ctx *Context, name string, args ScheduledQueryArgs, opts ...ResourceOption) (*ScheduledQuery, error)
    public ScheduledQuery(string name, ScheduledQueryArgs args, CustomResourceOptions? opts = null)
    public ScheduledQuery(String name, ScheduledQueryArgs args)
public ScheduledQuery(String name, ScheduledQueryArgs args, CustomResourceOptions options)

    type: oci:ApmTraces:ScheduledQuery
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var scheduledQueryResource = new Oci.ApmTraces.ScheduledQuery("scheduledQueryResource", new()
{
    ApmDomainId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    OpcDryRun = "string",
    ScheduledQueryDescription = "string",
    ScheduledQueryMaximumRuntimeInSeconds = "string",
    ScheduledQueryName = "string",
    ScheduledQueryProcessingConfiguration = new Oci.ApmTraces.Inputs.ScheduledQueryScheduledQueryProcessingConfigurationArgs
    {
        CustomMetric = new Oci.ApmTraces.Inputs.ScheduledQueryScheduledQueryProcessingConfigurationCustomMetricArgs
        {
            Name = "string",
            Compartment = "string",
            Description = "string",
            IsAnomalyDetectionEnabled = false,
            IsMetricPublished = false,
            Namespace = "string",
            ResourceGroup = "string",
            Unit = "string",
        },
        ObjectStorage = new Oci.ApmTraces.Inputs.ScheduledQueryScheduledQueryProcessingConfigurationObjectStorageArgs
        {
            Bucket = "string",
            NameSpace = "string",
            ObjectNamePrefix = "string",
        },
        Streaming = new Oci.ApmTraces.Inputs.ScheduledQueryScheduledQueryProcessingConfigurationStreamingArgs
        {
            StreamId = "string",
        },
    },
    ScheduledQueryProcessingSubType = "string",
    ScheduledQueryProcessingType = "string",
    ScheduledQueryRetentionCriteria = "string",
    ScheduledQueryRetentionPeriodInMs = "string",
    ScheduledQuerySchedule = "string",
    ScheduledQueryText = "string",
});

    example, err := apmtraces.NewScheduledQuery(ctx, "scheduledQueryResource", &apmtraces.ScheduledQueryArgs{
	ApmDomainId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	OpcDryRun:                             pulumi.String("string"),
	ScheduledQueryDescription:             pulumi.String("string"),
	ScheduledQueryMaximumRuntimeInSeconds: pulumi.String("string"),
	ScheduledQueryName:                    pulumi.String("string"),
	ScheduledQueryProcessingConfiguration: &apmtraces.ScheduledQueryScheduledQueryProcessingConfigurationArgs{
		CustomMetric: &apmtraces.ScheduledQueryScheduledQueryProcessingConfigurationCustomMetricArgs{
			Name:                      pulumi.String("string"),
			Compartment:               pulumi.String("string"),
			Description:               pulumi.String("string"),
			IsAnomalyDetectionEnabled: pulumi.Bool(false),
			IsMetricPublished:         pulumi.Bool(false),
			Namespace:                 pulumi.String("string"),
			ResourceGroup:             pulumi.String("string"),
			Unit:                      pulumi.String("string"),
		},
		ObjectStorage: &apmtraces.ScheduledQueryScheduledQueryProcessingConfigurationObjectStorageArgs{
			Bucket:           pulumi.String("string"),
			NameSpace:        pulumi.String("string"),
			ObjectNamePrefix: pulumi.String("string"),
		},
		Streaming: &apmtraces.ScheduledQueryScheduledQueryProcessingConfigurationStreamingArgs{
			StreamId: pulumi.String("string"),
		},
	},
	ScheduledQueryProcessingSubType:   pulumi.String("string"),
	ScheduledQueryProcessingType:      pulumi.String("string"),
	ScheduledQueryRetentionCriteria:   pulumi.String("string"),
	ScheduledQueryRetentionPeriodInMs: pulumi.String("string"),
	ScheduledQuerySchedule:            pulumi.String("string"),
	ScheduledQueryText:                pulumi.String("string"),
})

    var scheduledQueryResource = new ScheduledQuery("scheduledQueryResource", ScheduledQueryArgs.builder()
    .apmDomainId("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .opcDryRun("string")
    .scheduledQueryDescription("string")
    .scheduledQueryMaximumRuntimeInSeconds("string")
    .scheduledQueryName("string")
    .scheduledQueryProcessingConfiguration(ScheduledQueryScheduledQueryProcessingConfigurationArgs.builder()
        .customMetric(ScheduledQueryScheduledQueryProcessingConfigurationCustomMetricArgs.builder()
            .name("string")
            .compartment("string")
            .description("string")
            .isAnomalyDetectionEnabled(false)
            .isMetricPublished(false)
            .namespace("string")
            .resourceGroup("string")
            .unit("string")
            .build())
        .objectStorage(ScheduledQueryScheduledQueryProcessingConfigurationObjectStorageArgs.builder()
            .bucket("string")
            .nameSpace("string")
            .objectNamePrefix("string")
            .build())
        .streaming(ScheduledQueryScheduledQueryProcessingConfigurationStreamingArgs.builder()
            .streamId("string")
            .build())
        .build())
    .scheduledQueryProcessingSubType("string")
    .scheduledQueryProcessingType("string")
    .scheduledQueryRetentionCriteria("string")
    .scheduledQueryRetentionPeriodInMs("string")
    .scheduledQuerySchedule("string")
    .scheduledQueryText("string")
    .build());

    scheduled_query_resource = oci.apmtraces.ScheduledQuery("scheduledQueryResource",
    apm_domain_id="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    opc_dry_run="string",
    scheduled_query_description="string",
    scheduled_query_maximum_runtime_in_seconds="string",
    scheduled_query_name="string",
    scheduled_query_processing_configuration={
        "custom_metric": {
            "name": "string",
            "compartment": "string",
            "description": "string",
            "is_anomaly_detection_enabled": False,
            "is_metric_published": False,
            "namespace": "string",
            "resource_group": "string",
            "unit": "string",
        },
        "object_storage": {
            "bucket": "string",
            "name_space": "string",
            "object_name_prefix": "string",
        },
        "streaming": {
            "stream_id": "string",
        },
    },
    scheduled_query_processing_sub_type="string",
    scheduled_query_processing_type="string",
    scheduled_query_retention_criteria="string",
    scheduled_query_retention_period_in_ms="string",
    scheduled_query_schedule="string",
    scheduled_query_text="string")

    const scheduledQueryResource = new oci.apmtraces.ScheduledQuery("scheduledQueryResource", {
    apmDomainId: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    opcDryRun: "string",
    scheduledQueryDescription: "string",
    scheduledQueryMaximumRuntimeInSeconds: "string",
    scheduledQueryName: "string",
    scheduledQueryProcessingConfiguration: {
        customMetric: {
            name: "string",
            compartment: "string",
            description: "string",
            isAnomalyDetectionEnabled: false,
            isMetricPublished: false,
            namespace: "string",
            resourceGroup: "string",
            unit: "string",
        },
        objectStorage: {
            bucket: "string",
            nameSpace: "string",
            objectNamePrefix: "string",
        },
        streaming: {
            streamId: "string",
        },
    },
    scheduledQueryProcessingSubType: "string",
    scheduledQueryProcessingType: "string",
    scheduledQueryRetentionCriteria: "string",
    scheduledQueryRetentionPeriodInMs: "string",
    scheduledQuerySchedule: "string",
    scheduledQueryText: "string",
});

    type: oci:ApmTraces:ScheduledQuery
properties:
    apmDomainId: string
    definedTags:
        string: string
    freeformTags:
        string: string
    opcDryRun: string
    scheduledQueryDescription: string
    scheduledQueryMaximumRuntimeInSeconds: string
    scheduledQueryName: string
    scheduledQueryProcessingConfiguration:
        customMetric:
            compartment: string
            description: string
            isAnomalyDetectionEnabled: false
            isMetricPublished: false
            name: string
            namespace: string
            resourceGroup: string
            unit: string
        objectStorage:
            bucket: string
            nameSpace: string
            objectNamePrefix: string
        streaming:
            streamId: string
    scheduledQueryProcessingSubType: string
    scheduledQueryProcessingType: string
    scheduledQueryRetentionCriteria: string
    scheduledQueryRetentionPeriodInMs: string
    scheduledQuerySchedule: string
    scheduledQueryText: string

    ScheduledQuery Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ScheduledQuery resource accepts the following input properties:

    ApmDomainId string
    (Updatable) The APM Domain ID for the intended request.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    OpcDryRun string
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    ScheduledQueryDescription string
    (Updatable) Description for the scheduled query.
    ScheduledQueryMaximumRuntimeInSeconds string
    (Updatable) Maximum runtime for the scheduled query in seconds.
    ScheduledQueryName string
    (Updatable) Name of the scheduled query.
    ScheduledQueryProcessingConfiguration ScheduledQueryScheduledQueryProcessingConfiguration
    (Updatable) Definition of the scheduled query processing configuration.
    ScheduledQueryProcessingSubType string
    (Updatable) Processing sub type of the scheduled query.
    ScheduledQueryProcessingType string
    (Updatable) Type of the scheduled query.
    ScheduledQueryRetentionCriteria string
    (Updatable) Retention criteria for the scheduled query.
    ScheduledQueryRetentionPeriodInMs string
    (Updatable) Retention period for the scheduled query in milliseconds.
    ScheduledQuerySchedule string
    (Updatable) Schedule for the scheduled query.
    ScheduledQueryText string

    (Updatable) Scheduled query to be run.

    ** 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 for the intended request.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    OpcDryRun string
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    ScheduledQueryDescription string
    (Updatable) Description for the scheduled query.
    ScheduledQueryMaximumRuntimeInSeconds string
    (Updatable) Maximum runtime for the scheduled query in seconds.
    ScheduledQueryName string
    (Updatable) Name of the scheduled query.
    ScheduledQueryProcessingConfiguration ScheduledQueryScheduledQueryProcessingConfigurationArgs
    (Updatable) Definition of the scheduled query processing configuration.
    ScheduledQueryProcessingSubType string
    (Updatable) Processing sub type of the scheduled query.
    ScheduledQueryProcessingType string
    (Updatable) Type of the scheduled query.
    ScheduledQueryRetentionCriteria string
    (Updatable) Retention criteria for the scheduled query.
    ScheduledQueryRetentionPeriodInMs string
    (Updatable) Retention period for the scheduled query in milliseconds.
    ScheduledQuerySchedule string
    (Updatable) Schedule for the scheduled query.
    ScheduledQueryText string

    (Updatable) Scheduled query to be run.

    ** 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 for the intended request.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    opcDryRun String
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    scheduledQueryDescription String
    (Updatable) Description for the scheduled query.
    scheduledQueryMaximumRuntimeInSeconds String
    (Updatable) Maximum runtime for the scheduled query in seconds.
    scheduledQueryName String
    (Updatable) Name of the scheduled query.
    scheduledQueryProcessingConfiguration ScheduledQueryScheduledQueryProcessingConfiguration
    (Updatable) Definition of the scheduled query processing configuration.
    scheduledQueryProcessingSubType String
    (Updatable) Processing sub type of the scheduled query.
    scheduledQueryProcessingType String
    (Updatable) Type of the scheduled query.
    scheduledQueryRetentionCriteria String
    (Updatable) Retention criteria for the scheduled query.
    scheduledQueryRetentionPeriodInMs String
    (Updatable) Retention period for the scheduled query in milliseconds.
    scheduledQuerySchedule String
    (Updatable) Schedule for the scheduled query.
    scheduledQueryText String

    (Updatable) Scheduled query to be run.

    ** 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 for the intended request.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    opcDryRun string
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    scheduledQueryDescription string
    (Updatable) Description for the scheduled query.
    scheduledQueryMaximumRuntimeInSeconds string
    (Updatable) Maximum runtime for the scheduled query in seconds.
    scheduledQueryName string
    (Updatable) Name of the scheduled query.
    scheduledQueryProcessingConfiguration ScheduledQueryScheduledQueryProcessingConfiguration
    (Updatable) Definition of the scheduled query processing configuration.
    scheduledQueryProcessingSubType string
    (Updatable) Processing sub type of the scheduled query.
    scheduledQueryProcessingType string
    (Updatable) Type of the scheduled query.
    scheduledQueryRetentionCriteria string
    (Updatable) Retention criteria for the scheduled query.
    scheduledQueryRetentionPeriodInMs string
    (Updatable) Retention period for the scheduled query in milliseconds.
    scheduledQuerySchedule string
    (Updatable) Schedule for the scheduled query.
    scheduledQueryText string

    (Updatable) Scheduled query to be run.

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

    apm_domain_id str
    (Updatable) The APM Domain ID for the intended request.
    defined_tags Mapping[str, str]
    (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, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    opc_dry_run str
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    scheduled_query_description str
    (Updatable) Description for the scheduled query.
    scheduled_query_maximum_runtime_in_seconds str
    (Updatable) Maximum runtime for the scheduled query in seconds.
    scheduled_query_name str
    (Updatable) Name of the scheduled query.
    scheduled_query_processing_configuration ScheduledQueryScheduledQueryProcessingConfigurationArgs
    (Updatable) Definition of the scheduled query processing configuration.
    scheduled_query_processing_sub_type str
    (Updatable) Processing sub type of the scheduled query.
    scheduled_query_processing_type str
    (Updatable) Type of the scheduled query.
    scheduled_query_retention_criteria str
    (Updatable) Retention criteria for the scheduled query.
    scheduled_query_retention_period_in_ms str
    (Updatable) Retention period for the scheduled query in milliseconds.
    scheduled_query_schedule str
    (Updatable) Schedule for the scheduled query.
    scheduled_query_text str

    (Updatable) Scheduled query to be run.

    ** 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 for the intended request.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    opcDryRun String
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    scheduledQueryDescription String
    (Updatable) Description for the scheduled query.
    scheduledQueryMaximumRuntimeInSeconds String
    (Updatable) Maximum runtime for the scheduled query in seconds.
    scheduledQueryName String
    (Updatable) Name of the scheduled query.
    scheduledQueryProcessingConfiguration Property Map
    (Updatable) Definition of the scheduled query processing configuration.
    scheduledQueryProcessingSubType String
    (Updatable) Processing sub type of the scheduled query.
    scheduledQueryProcessingType String
    (Updatable) Type of the scheduled query.
    scheduledQueryRetentionCriteria String
    (Updatable) Retention criteria for the scheduled query.
    scheduledQueryRetentionPeriodInMs String
    (Updatable) Retention period for the scheduled query in milliseconds.
    scheduledQuerySchedule String
    (Updatable) Schedule for the scheduled query.
    scheduledQueryText String

    (Updatable) Scheduled query to be run.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduledQueryInstances string
    Scheduled query instances.
    ScheduledQueryNextRunInMs string
    Next run for the scheduled query.
    State string
    The current lifecycle state of the Scheduled Query.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    Id string
    The provider-assigned unique ID for this managed resource.
    ScheduledQueryInstances string
    Scheduled query instances.
    ScheduledQueryNextRunInMs string
    Next run for the scheduled query.
    State string
    The current lifecycle state of the Scheduled Query.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    id String
    The provider-assigned unique ID for this managed resource.
    scheduledQueryInstances String
    Scheduled query instances.
    scheduledQueryNextRunInMs String
    Next run for the scheduled query.
    state String
    The current lifecycle state of the Scheduled Query.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    id string
    The provider-assigned unique ID for this managed resource.
    scheduledQueryInstances string
    Scheduled query instances.
    scheduledQueryNextRunInMs string
    Next run for the scheduled query.
    state string
    The current lifecycle state of the Scheduled Query.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    id str
    The provider-assigned unique ID for this managed resource.
    scheduled_query_instances str
    Scheduled query instances.
    scheduled_query_next_run_in_ms str
    Next run for the scheduled query.
    state str
    The current lifecycle state of the Scheduled Query.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    id String
    The provider-assigned unique ID for this managed resource.
    scheduledQueryInstances String
    Scheduled query instances.
    scheduledQueryNextRunInMs String
    Next run for the scheduled query.
    state String
    The current lifecycle state of the Scheduled Query.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    Look up Existing ScheduledQuery Resource

    Get an existing ScheduledQuery 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?: ScheduledQueryState, opts?: CustomResourceOptions): ScheduledQuery
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apm_domain_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        opc_dry_run: Optional[str] = None,
        scheduled_query_description: Optional[str] = None,
        scheduled_query_instances: Optional[str] = None,
        scheduled_query_maximum_runtime_in_seconds: Optional[str] = None,
        scheduled_query_name: Optional[str] = None,
        scheduled_query_next_run_in_ms: Optional[str] = None,
        scheduled_query_processing_configuration: Optional[ScheduledQueryScheduledQueryProcessingConfigurationArgs] = None,
        scheduled_query_processing_sub_type: Optional[str] = None,
        scheduled_query_processing_type: Optional[str] = None,
        scheduled_query_retention_criteria: Optional[str] = None,
        scheduled_query_retention_period_in_ms: Optional[str] = None,
        scheduled_query_schedule: Optional[str] = None,
        scheduled_query_text: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None) -> ScheduledQuery
    func GetScheduledQuery(ctx *Context, name string, id IDInput, state *ScheduledQueryState, opts ...ResourceOption) (*ScheduledQuery, error)
    public static ScheduledQuery Get(string name, Input<string> id, ScheduledQueryState? state, CustomResourceOptions? opts = null)
    public static ScheduledQuery get(String name, Output<String> id, ScheduledQueryState state, CustomResourceOptions options)
    resources:  _:    type: oci:ApmTraces:ScheduledQuery    get:      id: ${id}
    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 for the intended request.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    OpcDryRun string
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    ScheduledQueryDescription string
    (Updatable) Description for the scheduled query.
    ScheduledQueryInstances string
    Scheduled query instances.
    ScheduledQueryMaximumRuntimeInSeconds string
    (Updatable) Maximum runtime for the scheduled query in seconds.
    ScheduledQueryName string
    (Updatable) Name of the scheduled query.
    ScheduledQueryNextRunInMs string
    Next run for the scheduled query.
    ScheduledQueryProcessingConfiguration ScheduledQueryScheduledQueryProcessingConfiguration
    (Updatable) Definition of the scheduled query processing configuration.
    ScheduledQueryProcessingSubType string
    (Updatable) Processing sub type of the scheduled query.
    ScheduledQueryProcessingType string
    (Updatable) Type of the scheduled query.
    ScheduledQueryRetentionCriteria string
    (Updatable) Retention criteria for the scheduled query.
    ScheduledQueryRetentionPeriodInMs string
    (Updatable) Retention period for the scheduled query in milliseconds.
    ScheduledQuerySchedule string
    (Updatable) Schedule for the scheduled query.
    ScheduledQueryText string

    (Updatable) Scheduled query to be run.

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

    State string
    The current lifecycle state of the Scheduled Query.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    ApmDomainId string
    (Updatable) The APM Domain ID for the intended request.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    OpcDryRun string
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    ScheduledQueryDescription string
    (Updatable) Description for the scheduled query.
    ScheduledQueryInstances string
    Scheduled query instances.
    ScheduledQueryMaximumRuntimeInSeconds string
    (Updatable) Maximum runtime for the scheduled query in seconds.
    ScheduledQueryName string
    (Updatable) Name of the scheduled query.
    ScheduledQueryNextRunInMs string
    Next run for the scheduled query.
    ScheduledQueryProcessingConfiguration ScheduledQueryScheduledQueryProcessingConfigurationArgs
    (Updatable) Definition of the scheduled query processing configuration.
    ScheduledQueryProcessingSubType string
    (Updatable) Processing sub type of the scheduled query.
    ScheduledQueryProcessingType string
    (Updatable) Type of the scheduled query.
    ScheduledQueryRetentionCriteria string
    (Updatable) Retention criteria for the scheduled query.
    ScheduledQueryRetentionPeriodInMs string
    (Updatable) Retention period for the scheduled query in milliseconds.
    ScheduledQuerySchedule string
    (Updatable) Schedule for the scheduled query.
    ScheduledQueryText string

    (Updatable) Scheduled query to be run.

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

    State string
    The current lifecycle state of the Scheduled Query.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    apmDomainId String
    (Updatable) The APM Domain ID for the intended request.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    opcDryRun String
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    scheduledQueryDescription String
    (Updatable) Description for the scheduled query.
    scheduledQueryInstances String
    Scheduled query instances.
    scheduledQueryMaximumRuntimeInSeconds String
    (Updatable) Maximum runtime for the scheduled query in seconds.
    scheduledQueryName String
    (Updatable) Name of the scheduled query.
    scheduledQueryNextRunInMs String
    Next run for the scheduled query.
    scheduledQueryProcessingConfiguration ScheduledQueryScheduledQueryProcessingConfiguration
    (Updatable) Definition of the scheduled query processing configuration.
    scheduledQueryProcessingSubType String
    (Updatable) Processing sub type of the scheduled query.
    scheduledQueryProcessingType String
    (Updatable) Type of the scheduled query.
    scheduledQueryRetentionCriteria String
    (Updatable) Retention criteria for the scheduled query.
    scheduledQueryRetentionPeriodInMs String
    (Updatable) Retention period for the scheduled query in milliseconds.
    scheduledQuerySchedule String
    (Updatable) Schedule for the scheduled query.
    scheduledQueryText String

    (Updatable) Scheduled query to be run.

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

    state String
    The current lifecycle state of the Scheduled Query.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    apmDomainId string
    (Updatable) The APM Domain ID for the intended request.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    opcDryRun string
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    scheduledQueryDescription string
    (Updatable) Description for the scheduled query.
    scheduledQueryInstances string
    Scheduled query instances.
    scheduledQueryMaximumRuntimeInSeconds string
    (Updatable) Maximum runtime for the scheduled query in seconds.
    scheduledQueryName string
    (Updatable) Name of the scheduled query.
    scheduledQueryNextRunInMs string
    Next run for the scheduled query.
    scheduledQueryProcessingConfiguration ScheduledQueryScheduledQueryProcessingConfiguration
    (Updatable) Definition of the scheduled query processing configuration.
    scheduledQueryProcessingSubType string
    (Updatable) Processing sub type of the scheduled query.
    scheduledQueryProcessingType string
    (Updatable) Type of the scheduled query.
    scheduledQueryRetentionCriteria string
    (Updatable) Retention criteria for the scheduled query.
    scheduledQueryRetentionPeriodInMs string
    (Updatable) Retention period for the scheduled query in milliseconds.
    scheduledQuerySchedule string
    (Updatable) Schedule for the scheduled query.
    scheduledQueryText string

    (Updatable) Scheduled query to be run.

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

    state string
    The current lifecycle state of the Scheduled Query.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    apm_domain_id str
    (Updatable) The APM Domain ID for the intended request.
    defined_tags Mapping[str, str]
    (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, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    opc_dry_run str
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    scheduled_query_description str
    (Updatable) Description for the scheduled query.
    scheduled_query_instances str
    Scheduled query instances.
    scheduled_query_maximum_runtime_in_seconds str
    (Updatable) Maximum runtime for the scheduled query in seconds.
    scheduled_query_name str
    (Updatable) Name of the scheduled query.
    scheduled_query_next_run_in_ms str
    Next run for the scheduled query.
    scheduled_query_processing_configuration ScheduledQueryScheduledQueryProcessingConfigurationArgs
    (Updatable) Definition of the scheduled query processing configuration.
    scheduled_query_processing_sub_type str
    (Updatable) Processing sub type of the scheduled query.
    scheduled_query_processing_type str
    (Updatable) Type of the scheduled query.
    scheduled_query_retention_criteria str
    (Updatable) Retention criteria for the scheduled query.
    scheduled_query_retention_period_in_ms str
    (Updatable) Retention period for the scheduled query in milliseconds.
    scheduled_query_schedule str
    (Updatable) Schedule for the scheduled query.
    scheduled_query_text str

    (Updatable) Scheduled query to be run.

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

    state str
    The current lifecycle state of the Scheduled Query.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    apmDomainId String
    (Updatable) The APM Domain ID for the intended request.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    opcDryRun String
    (Updatable) Indicates that the request is a dry run, if set to "true". A dry run request does not create or modify the resource and is used only to perform validation on the submitted data.
    scheduledQueryDescription String
    (Updatable) Description for the scheduled query.
    scheduledQueryInstances String
    Scheduled query instances.
    scheduledQueryMaximumRuntimeInSeconds String
    (Updatable) Maximum runtime for the scheduled query in seconds.
    scheduledQueryName String
    (Updatable) Name of the scheduled query.
    scheduledQueryNextRunInMs String
    Next run for the scheduled query.
    scheduledQueryProcessingConfiguration Property Map
    (Updatable) Definition of the scheduled query processing configuration.
    scheduledQueryProcessingSubType String
    (Updatable) Processing sub type of the scheduled query.
    scheduledQueryProcessingType String
    (Updatable) Type of the scheduled query.
    scheduledQueryRetentionCriteria String
    (Updatable) Retention criteria for the scheduled query.
    scheduledQueryRetentionPeriodInMs String
    (Updatable) Retention period for the scheduled query in milliseconds.
    scheduledQuerySchedule String
    (Updatable) Schedule for the scheduled query.
    scheduledQueryText String

    (Updatable) Scheduled query to be run.

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

    state String
    The current lifecycle state of the Scheduled Query.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    Supporting Types

    ScheduledQueryScheduledQueryProcessingConfiguration, ScheduledQueryScheduledQueryProcessingConfigurationArgs

    customMetric Property Map
    (Updatable) Definition of the Custom Metric.
    objectStorage Property Map
    (Updatable) Definition of the object storage.
    streaming Property Map
    (Updatable) Definition of the Stream.

    ScheduledQueryScheduledQueryProcessingConfigurationCustomMetric, ScheduledQueryScheduledQueryProcessingConfigurationCustomMetricArgs

    Name string
    (Updatable) Name of the Custom Metric.
    Compartment string
    (Updatable) Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.
    Description string
    (Updatable) Description of the Custom Metric.
    IsAnomalyDetectionEnabled bool
    (Updatable) Indicates whether anomaly Detection should be performed on the generated metric.
    IsMetricPublished bool
    (Updatable) Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.
    Namespace string
    (Updatable) Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.
    ResourceGroup string
    (Updatable) Resource Group of the Custom Metric.
    Unit string
    (Updatable) Unit in which the metric value is reported. For example 'ms'.
    Name string
    (Updatable) Name of the Custom Metric.
    Compartment string
    (Updatable) Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.
    Description string
    (Updatable) Description of the Custom Metric.
    IsAnomalyDetectionEnabled bool
    (Updatable) Indicates whether anomaly Detection should be performed on the generated metric.
    IsMetricPublished bool
    (Updatable) Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.
    Namespace string
    (Updatable) Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.
    ResourceGroup string
    (Updatable) Resource Group of the Custom Metric.
    Unit string
    (Updatable) Unit in which the metric value is reported. For example 'ms'.
    name String
    (Updatable) Name of the Custom Metric.
    compartment String
    (Updatable) Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.
    description String
    (Updatable) Description of the Custom Metric.
    isAnomalyDetectionEnabled Boolean
    (Updatable) Indicates whether anomaly Detection should be performed on the generated metric.
    isMetricPublished Boolean
    (Updatable) Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.
    namespace String
    (Updatable) Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.
    resourceGroup String
    (Updatable) Resource Group of the Custom Metric.
    unit String
    (Updatable) Unit in which the metric value is reported. For example 'ms'.
    name string
    (Updatable) Name of the Custom Metric.
    compartment string
    (Updatable) Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.
    description string
    (Updatable) Description of the Custom Metric.
    isAnomalyDetectionEnabled boolean
    (Updatable) Indicates whether anomaly Detection should be performed on the generated metric.
    isMetricPublished boolean
    (Updatable) Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.
    namespace string
    (Updatable) Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.
    resourceGroup string
    (Updatable) Resource Group of the Custom Metric.
    unit string
    (Updatable) Unit in which the metric value is reported. For example 'ms'.
    name str
    (Updatable) Name of the Custom Metric.
    compartment str
    (Updatable) Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.
    description str
    (Updatable) Description of the Custom Metric.
    is_anomaly_detection_enabled bool
    (Updatable) Indicates whether anomaly Detection should be performed on the generated metric.
    is_metric_published bool
    (Updatable) Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.
    namespace str
    (Updatable) Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.
    resource_group str
    (Updatable) Resource Group of the Custom Metric.
    unit str
    (Updatable) Unit in which the metric value is reported. For example 'ms'.
    name String
    (Updatable) Name of the Custom Metric.
    compartment String
    (Updatable) Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.
    description String
    (Updatable) Description of the Custom Metric.
    isAnomalyDetectionEnabled Boolean
    (Updatable) Indicates whether anomaly Detection should be performed on the generated metric.
    isMetricPublished Boolean
    (Updatable) Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.
    namespace String
    (Updatable) Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.
    resourceGroup String
    (Updatable) Resource Group of the Custom Metric.
    unit String
    (Updatable) Unit in which the metric value is reported. For example 'ms'.

    ScheduledQueryScheduledQueryProcessingConfigurationObjectStorage, ScheduledQueryScheduledQueryProcessingConfigurationObjectStorageArgs

    Bucket string
    (Updatable) Bucket name in the object store.
    NameSpace string
    (Updatable) Namespace in the object store.
    ObjectNamePrefix string
    (Updatable) Object name prefix in the object store.
    Bucket string
    (Updatable) Bucket name in the object store.
    NameSpace string
    (Updatable) Namespace in the object store.
    ObjectNamePrefix string
    (Updatable) Object name prefix in the object store.
    bucket String
    (Updatable) Bucket name in the object store.
    nameSpace String
    (Updatable) Namespace in the object store.
    objectNamePrefix String
    (Updatable) Object name prefix in the object store.
    bucket string
    (Updatable) Bucket name in the object store.
    nameSpace string
    (Updatable) Namespace in the object store.
    objectNamePrefix string
    (Updatable) Object name prefix in the object store.
    bucket str
    (Updatable) Bucket name in the object store.
    name_space str
    (Updatable) Namespace in the object store.
    object_name_prefix str
    (Updatable) Object name prefix in the object store.
    bucket String
    (Updatable) Bucket name in the object store.
    nameSpace String
    (Updatable) Namespace in the object store.
    objectNamePrefix String
    (Updatable) Object name prefix in the object store.

    ScheduledQueryScheduledQueryProcessingConfigurationStreaming, ScheduledQueryScheduledQueryProcessingConfigurationStreamingArgs

    StreamId string
    (Updatable) Stream Id.
    StreamId string
    (Updatable) Stream Id.
    streamId String
    (Updatable) Stream Id.
    streamId string
    (Updatable) Stream Id.
    stream_id str
    (Updatable) Stream Id.
    streamId String
    (Updatable) Stream Id.

    Import

    ScheduledQueries can be imported using the id, e.g.

    $ pulumi import oci:ApmTraces/scheduledQuery:ScheduledQuery test_scheduled_query "scheduledQueries/{scheduledQueryId}/apmDomainId/{apmDomainId}"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
    pulumi/pulumi-oci