1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FleetAppsManagement
  5. SchedulerDefinition
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.FleetAppsManagement.SchedulerDefinition

Explore with Pulumi AI

This resource provides the Scheduler Definition resource in Oracle Cloud Infrastructure Fleet Apps Management service.

Create a SchedulerDefinition to perform lifecycle operations.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSchedulerDefinition = new oci.fleetappsmanagement.SchedulerDefinition("test_scheduler_definition", {
    actionGroups: [{
        resourceId: testResource.id,
        runbookId: testRunbook.id,
        applicationType: schedulerDefinitionActionGroupsApplicationType,
        lifecycleOperation: schedulerDefinitionActionGroupsLifecycleOperation,
        product: schedulerDefinitionActionGroupsProduct,
        subjects: schedulerDefinitionActionGroupsSubjects,
        targetId: testTarget.id,
        type: schedulerDefinitionActionGroupsType,
    }],
    compartmentId: compartmentId,
    schedule: {
        executionStartdate: schedulerDefinitionScheduleExecutionStartdate,
        type: schedulerDefinitionScheduleType,
        duration: schedulerDefinitionScheduleDuration,
        maintenanceWindowId: testMaintenanceWindow.id,
        recurrences: schedulerDefinitionScheduleRecurrences,
    },
    activityInitiationCutOff: schedulerDefinitionActivityInitiationCutOff,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: schedulerDefinitionDescription,
    displayName: schedulerDefinitionDisplayName,
    freeformTags: {
        "bar-key": "value",
    },
    runBooks: [{
        id: schedulerDefinitionRunBooksId,
        inputParameters: [{
            stepName: schedulerDefinitionRunBooksInputParametersStepName,
            arguments: [{
                name: schedulerDefinitionRunBooksInputParametersArgumentsName,
                value: schedulerDefinitionRunBooksInputParametersArgumentsValue,
            }],
        }],
    }],
});
Copy
import pulumi
import pulumi_oci as oci

test_scheduler_definition = oci.fleet_apps_management.SchedulerDefinition("test_scheduler_definition",
    action_groups=[{
        "resource_id": test_resource["id"],
        "runbook_id": test_runbook["id"],
        "application_type": scheduler_definition_action_groups_application_type,
        "lifecycle_operation": scheduler_definition_action_groups_lifecycle_operation,
        "product": scheduler_definition_action_groups_product,
        "subjects": scheduler_definition_action_groups_subjects,
        "target_id": test_target["id"],
        "type": scheduler_definition_action_groups_type,
    }],
    compartment_id=compartment_id,
    schedule={
        "execution_startdate": scheduler_definition_schedule_execution_startdate,
        "type": scheduler_definition_schedule_type,
        "duration": scheduler_definition_schedule_duration,
        "maintenance_window_id": test_maintenance_window["id"],
        "recurrences": scheduler_definition_schedule_recurrences,
    },
    activity_initiation_cut_off=scheduler_definition_activity_initiation_cut_off,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=scheduler_definition_description,
    display_name=scheduler_definition_display_name,
    freeform_tags={
        "bar-key": "value",
    },
    run_books=[{
        "id": scheduler_definition_run_books_id,
        "input_parameters": [{
            "step_name": scheduler_definition_run_books_input_parameters_step_name,
            "arguments": [{
                "name": scheduler_definition_run_books_input_parameters_arguments_name,
                "value": scheduler_definition_run_books_input_parameters_arguments_value,
            }],
        }],
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/fleetappsmanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fleetappsmanagement.NewSchedulerDefinition(ctx, "test_scheduler_definition", &fleetappsmanagement.SchedulerDefinitionArgs{
			ActionGroups: fleetappsmanagement.SchedulerDefinitionActionGroupArray{
				&fleetappsmanagement.SchedulerDefinitionActionGroupArgs{
					ResourceId:         pulumi.Any(testResource.Id),
					RunbookId:          pulumi.Any(testRunbook.Id),
					ApplicationType:    pulumi.Any(schedulerDefinitionActionGroupsApplicationType),
					LifecycleOperation: pulumi.Any(schedulerDefinitionActionGroupsLifecycleOperation),
					Product:            pulumi.Any(schedulerDefinitionActionGroupsProduct),
					Subjects:           pulumi.Any(schedulerDefinitionActionGroupsSubjects),
					TargetId:           pulumi.Any(testTarget.Id),
					Type:               pulumi.Any(schedulerDefinitionActionGroupsType),
				},
			},
			CompartmentId: pulumi.Any(compartmentId),
			Schedule: &fleetappsmanagement.SchedulerDefinitionScheduleArgs{
				ExecutionStartdate:  pulumi.Any(schedulerDefinitionScheduleExecutionStartdate),
				Type:                pulumi.Any(schedulerDefinitionScheduleType),
				Duration:            pulumi.Any(schedulerDefinitionScheduleDuration),
				MaintenanceWindowId: pulumi.Any(testMaintenanceWindow.Id),
				Recurrences:         pulumi.Any(schedulerDefinitionScheduleRecurrences),
			},
			ActivityInitiationCutOff: pulumi.Any(schedulerDefinitionActivityInitiationCutOff),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(schedulerDefinitionDescription),
			DisplayName: pulumi.Any(schedulerDefinitionDisplayName),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			RunBooks: fleetappsmanagement.SchedulerDefinitionRunBookArray{
				&fleetappsmanagement.SchedulerDefinitionRunBookArgs{
					Id: pulumi.Any(schedulerDefinitionRunBooksId),
					InputParameters: fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArray{
						&fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArgs{
							StepName: pulumi.Any(schedulerDefinitionRunBooksInputParametersStepName),
							Arguments: fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArgumentArray{
								&fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArgumentArgs{
									Name:  pulumi.Any(schedulerDefinitionRunBooksInputParametersArgumentsName),
									Value: pulumi.Any(schedulerDefinitionRunBooksInputParametersArgumentsValue),
								},
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSchedulerDefinition = new Oci.FleetAppsManagement.SchedulerDefinition("test_scheduler_definition", new()
    {
        ActionGroups = new[]
        {
            new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionActionGroupArgs
            {
                ResourceId = testResource.Id,
                RunbookId = testRunbook.Id,
                ApplicationType = schedulerDefinitionActionGroupsApplicationType,
                LifecycleOperation = schedulerDefinitionActionGroupsLifecycleOperation,
                Product = schedulerDefinitionActionGroupsProduct,
                Subjects = schedulerDefinitionActionGroupsSubjects,
                TargetId = testTarget.Id,
                Type = schedulerDefinitionActionGroupsType,
            },
        },
        CompartmentId = compartmentId,
        Schedule = new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionScheduleArgs
        {
            ExecutionStartdate = schedulerDefinitionScheduleExecutionStartdate,
            Type = schedulerDefinitionScheduleType,
            Duration = schedulerDefinitionScheduleDuration,
            MaintenanceWindowId = testMaintenanceWindow.Id,
            Recurrences = schedulerDefinitionScheduleRecurrences,
        },
        ActivityInitiationCutOff = schedulerDefinitionActivityInitiationCutOff,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = schedulerDefinitionDescription,
        DisplayName = schedulerDefinitionDisplayName,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        RunBooks = new[]
        {
            new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionRunBookArgs
            {
                Id = schedulerDefinitionRunBooksId,
                InputParameters = new[]
                {
                    new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionRunBookInputParameterArgs
                    {
                        StepName = schedulerDefinitionRunBooksInputParametersStepName,
                        Arguments = new[]
                        {
                            new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionRunBookInputParameterArgumentArgs
                            {
                                Name = schedulerDefinitionRunBooksInputParametersArgumentsName,
                                Value = schedulerDefinitionRunBooksInputParametersArgumentsValue,
                            },
                        },
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FleetAppsManagement.SchedulerDefinition;
import com.pulumi.oci.FleetAppsManagement.SchedulerDefinitionArgs;
import com.pulumi.oci.FleetAppsManagement.inputs.SchedulerDefinitionActionGroupArgs;
import com.pulumi.oci.FleetAppsManagement.inputs.SchedulerDefinitionScheduleArgs;
import com.pulumi.oci.FleetAppsManagement.inputs.SchedulerDefinitionRunBookArgs;
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) {
        var testSchedulerDefinition = new SchedulerDefinition("testSchedulerDefinition", SchedulerDefinitionArgs.builder()
            .actionGroups(SchedulerDefinitionActionGroupArgs.builder()
                .resourceId(testResource.id())
                .runbookId(testRunbook.id())
                .applicationType(schedulerDefinitionActionGroupsApplicationType)
                .lifecycleOperation(schedulerDefinitionActionGroupsLifecycleOperation)
                .product(schedulerDefinitionActionGroupsProduct)
                .subjects(schedulerDefinitionActionGroupsSubjects)
                .targetId(testTarget.id())
                .type(schedulerDefinitionActionGroupsType)
                .build())
            .compartmentId(compartmentId)
            .schedule(SchedulerDefinitionScheduleArgs.builder()
                .executionStartdate(schedulerDefinitionScheduleExecutionStartdate)
                .type(schedulerDefinitionScheduleType)
                .duration(schedulerDefinitionScheduleDuration)
                .maintenanceWindowId(testMaintenanceWindow.id())
                .recurrences(schedulerDefinitionScheduleRecurrences)
                .build())
            .activityInitiationCutOff(schedulerDefinitionActivityInitiationCutOff)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(schedulerDefinitionDescription)
            .displayName(schedulerDefinitionDisplayName)
            .freeformTags(Map.of("bar-key", "value"))
            .runBooks(SchedulerDefinitionRunBookArgs.builder()
                .id(schedulerDefinitionRunBooksId)
                .inputParameters(SchedulerDefinitionRunBookInputParameterArgs.builder()
                    .stepName(schedulerDefinitionRunBooksInputParametersStepName)
                    .arguments(SchedulerDefinitionRunBookInputParameterArgumentArgs.builder()
                        .name(schedulerDefinitionRunBooksInputParametersArgumentsName)
                        .value(schedulerDefinitionRunBooksInputParametersArgumentsValue)
                        .build())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  testSchedulerDefinition:
    type: oci:FleetAppsManagement:SchedulerDefinition
    name: test_scheduler_definition
    properties:
      actionGroups:
        - resourceId: ${testResource.id}
          runbookId: ${testRunbook.id}
          applicationType: ${schedulerDefinitionActionGroupsApplicationType}
          lifecycleOperation: ${schedulerDefinitionActionGroupsLifecycleOperation}
          product: ${schedulerDefinitionActionGroupsProduct}
          subjects: ${schedulerDefinitionActionGroupsSubjects}
          targetId: ${testTarget.id}
          type: ${schedulerDefinitionActionGroupsType}
      compartmentId: ${compartmentId}
      schedule:
        executionStartdate: ${schedulerDefinitionScheduleExecutionStartdate}
        type: ${schedulerDefinitionScheduleType}
        duration: ${schedulerDefinitionScheduleDuration}
        maintenanceWindowId: ${testMaintenanceWindow.id}
        recurrences: ${schedulerDefinitionScheduleRecurrences}
      activityInitiationCutOff: ${schedulerDefinitionActivityInitiationCutOff}
      definedTags:
        foo-namespace.bar-key: value
      description: ${schedulerDefinitionDescription}
      displayName: ${schedulerDefinitionDisplayName}
      freeformTags:
        bar-key: value
      runBooks:
        - id: ${schedulerDefinitionRunBooksId}
          inputParameters:
            - stepName: ${schedulerDefinitionRunBooksInputParametersStepName}
              arguments:
                - name: ${schedulerDefinitionRunBooksInputParametersArgumentsName}
                  value: ${schedulerDefinitionRunBooksInputParametersArgumentsValue}
Copy

Create SchedulerDefinition Resource

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

Constructor syntax

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

@overload
def SchedulerDefinition(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        action_groups: Optional[Sequence[_fleetappsmanagement.SchedulerDefinitionActionGroupArgs]] = None,
                        compartment_id: Optional[str] = None,
                        schedule: Optional[_fleetappsmanagement.SchedulerDefinitionScheduleArgs] = None,
                        activity_initiation_cut_off: Optional[int] = None,
                        defined_tags: Optional[Mapping[str, str]] = None,
                        description: Optional[str] = None,
                        display_name: Optional[str] = None,
                        freeform_tags: Optional[Mapping[str, str]] = None,
                        run_books: Optional[Sequence[_fleetappsmanagement.SchedulerDefinitionRunBookArgs]] = None)
func NewSchedulerDefinition(ctx *Context, name string, args SchedulerDefinitionArgs, opts ...ResourceOption) (*SchedulerDefinition, error)
public SchedulerDefinition(string name, SchedulerDefinitionArgs args, CustomResourceOptions? opts = null)
public SchedulerDefinition(String name, SchedulerDefinitionArgs args)
public SchedulerDefinition(String name, SchedulerDefinitionArgs args, CustomResourceOptions options)
type: oci:FleetAppsManagement:SchedulerDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SchedulerDefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SchedulerDefinitionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SchedulerDefinitionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SchedulerDefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SchedulerDefinitionArgs
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 schedulerDefinitionResource = new Oci.FleetAppsManagement.SchedulerDefinition("schedulerDefinitionResource", new()
{
    ActionGroups = new[]
    {
        new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionActionGroupArgs
        {
            ResourceId = "string",
            RunbookId = "string",
            ApplicationType = "string",
            LifecycleOperation = "string",
            Product = "string",
            Subjects = new[]
            {
                "string",
            },
            TargetId = "string",
            Type = "string",
        },
    },
    CompartmentId = "string",
    Schedule = new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionScheduleArgs
    {
        ExecutionStartdate = "string",
        Type = "string",
        Duration = "string",
        MaintenanceWindowId = "string",
        Recurrences = "string",
    },
    ActivityInitiationCutOff = 0,
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    RunBooks = new[]
    {
        new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionRunBookArgs
        {
            Id = "string",
            InputParameters = new[]
            {
                new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionRunBookInputParameterArgs
                {
                    StepName = "string",
                    Arguments = new[]
                    {
                        new Oci.FleetAppsManagement.Inputs.SchedulerDefinitionRunBookInputParameterArgumentArgs
                        {
                            Name = "string",
                            Value = "string",
                        },
                    },
                },
            },
        },
    },
});
Copy
example, err := FleetAppsManagement.NewSchedulerDefinition(ctx, "schedulerDefinitionResource", &FleetAppsManagement.SchedulerDefinitionArgs{
	ActionGroups: fleetappsmanagement.SchedulerDefinitionActionGroupArray{
		&fleetappsmanagement.SchedulerDefinitionActionGroupArgs{
			ResourceId:         pulumi.String("string"),
			RunbookId:          pulumi.String("string"),
			ApplicationType:    pulumi.String("string"),
			LifecycleOperation: pulumi.String("string"),
			Product:            pulumi.String("string"),
			Subjects: pulumi.StringArray{
				pulumi.String("string"),
			},
			TargetId: pulumi.String("string"),
			Type:     pulumi.String("string"),
		},
	},
	CompartmentId: pulumi.String("string"),
	Schedule: &fleetappsmanagement.SchedulerDefinitionScheduleArgs{
		ExecutionStartdate:  pulumi.String("string"),
		Type:                pulumi.String("string"),
		Duration:            pulumi.String("string"),
		MaintenanceWindowId: pulumi.String("string"),
		Recurrences:         pulumi.String("string"),
	},
	ActivityInitiationCutOff: pulumi.Int(0),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	RunBooks: fleetappsmanagement.SchedulerDefinitionRunBookArray{
		&fleetappsmanagement.SchedulerDefinitionRunBookArgs{
			Id: pulumi.String("string"),
			InputParameters: fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArray{
				&fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArgs{
					StepName: pulumi.String("string"),
					Arguments: fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArgumentArray{
						&fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArgumentArgs{
							Name:  pulumi.String("string"),
							Value: pulumi.String("string"),
						},
					},
				},
			},
		},
	},
})
Copy
var schedulerDefinitionResource = new SchedulerDefinition("schedulerDefinitionResource", SchedulerDefinitionArgs.builder()
    .actionGroups(SchedulerDefinitionActionGroupArgs.builder()
        .resourceId("string")
        .runbookId("string")
        .applicationType("string")
        .lifecycleOperation("string")
        .product("string")
        .subjects("string")
        .targetId("string")
        .type("string")
        .build())
    .compartmentId("string")
    .schedule(SchedulerDefinitionScheduleArgs.builder()
        .executionStartdate("string")
        .type("string")
        .duration("string")
        .maintenanceWindowId("string")
        .recurrences("string")
        .build())
    .activityInitiationCutOff(0)
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .runBooks(SchedulerDefinitionRunBookArgs.builder()
        .id("string")
        .inputParameters(SchedulerDefinitionRunBookInputParameterArgs.builder()
            .stepName("string")
            .arguments(SchedulerDefinitionRunBookInputParameterArgumentArgs.builder()
                .name("string")
                .value("string")
                .build())
            .build())
        .build())
    .build());
Copy
scheduler_definition_resource = oci.fleet_apps_management.SchedulerDefinition("schedulerDefinitionResource",
    action_groups=[{
        "resource_id": "string",
        "runbook_id": "string",
        "application_type": "string",
        "lifecycle_operation": "string",
        "product": "string",
        "subjects": ["string"],
        "target_id": "string",
        "type": "string",
    }],
    compartment_id="string",
    schedule={
        "execution_startdate": "string",
        "type": "string",
        "duration": "string",
        "maintenance_window_id": "string",
        "recurrences": "string",
    },
    activity_initiation_cut_off=0,
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    run_books=[{
        "id": "string",
        "input_parameters": [{
            "step_name": "string",
            "arguments": [{
                "name": "string",
                "value": "string",
            }],
        }],
    }])
Copy
const schedulerDefinitionResource = new oci.fleetappsmanagement.SchedulerDefinition("schedulerDefinitionResource", {
    actionGroups: [{
        resourceId: "string",
        runbookId: "string",
        applicationType: "string",
        lifecycleOperation: "string",
        product: "string",
        subjects: ["string"],
        targetId: "string",
        type: "string",
    }],
    compartmentId: "string",
    schedule: {
        executionStartdate: "string",
        type: "string",
        duration: "string",
        maintenanceWindowId: "string",
        recurrences: "string",
    },
    activityInitiationCutOff: 0,
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    runBooks: [{
        id: "string",
        inputParameters: [{
            stepName: "string",
            arguments: [{
                name: "string",
                value: "string",
            }],
        }],
    }],
});
Copy
type: oci:FleetAppsManagement:SchedulerDefinition
properties:
    actionGroups:
        - applicationType: string
          lifecycleOperation: string
          product: string
          resourceId: string
          runbookId: string
          subjects:
            - string
          targetId: string
          type: string
    activityInitiationCutOff: 0
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    runBooks:
        - id: string
          inputParameters:
            - arguments:
                - name: string
                  value: string
              stepName: string
    schedule:
        duration: string
        executionStartdate: string
        maintenanceWindowId: string
        recurrences: string
        type: string
Copy

SchedulerDefinition 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 SchedulerDefinition resource accepts the following input properties:

ActionGroups This property is required. List<SchedulerDefinitionActionGroup>
(Updatable) Action Groups associated with the Schedule.
CompartmentId
This property is required.
Changes to this property will trigger replacement.
string
Tenancy OCID
Schedule This property is required. SchedulerDefinitionSchedule
(Updatable) Schedule Information.
ActivityInitiationCutOff int
(Updatable) Activity Initiation Cut Off
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"}
Description string
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
RunBooks List<SchedulerDefinitionRunBook>
(Updatable) Runbooks.
ActionGroups This property is required. []SchedulerDefinitionActionGroupArgs
(Updatable) Action Groups associated with the Schedule.
CompartmentId
This property is required.
Changes to this property will trigger replacement.
string
Tenancy OCID
Schedule This property is required. SchedulerDefinitionScheduleArgs
(Updatable) Schedule Information.
ActivityInitiationCutOff int
(Updatable) Activity Initiation Cut Off
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"}
Description string
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
RunBooks []SchedulerDefinitionRunBookArgs
(Updatable) Runbooks.
actionGroups This property is required. List<SchedulerDefinitionActionGroup>
(Updatable) Action Groups associated with the Schedule.
compartmentId
This property is required.
Changes to this property will trigger replacement.
String
Tenancy OCID
schedule This property is required. SchedulerDefinitionSchedule
(Updatable) Schedule Information.
activityInitiationCutOff Integer
(Updatable) Activity Initiation Cut Off
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"}
description String
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
runBooks List<SchedulerDefinitionRunBook>
(Updatable) Runbooks.
actionGroups This property is required. SchedulerDefinitionActionGroup[]
(Updatable) Action Groups associated with the Schedule.
compartmentId
This property is required.
Changes to this property will trigger replacement.
string
Tenancy OCID
schedule This property is required. SchedulerDefinitionSchedule
(Updatable) Schedule Information.
activityInitiationCutOff number
(Updatable) Activity Initiation Cut Off
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"}
description string
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
displayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
runBooks SchedulerDefinitionRunBook[]
(Updatable) Runbooks.
action_groups This property is required. Sequence[fleetappsmanagement.SchedulerDefinitionActionGroupArgs]
(Updatable) Action Groups associated with the Schedule.
compartment_id
This property is required.
Changes to this property will trigger replacement.
str
Tenancy OCID
schedule This property is required. fleetappsmanagement.SchedulerDefinitionScheduleArgs
(Updatable) Schedule Information.
activity_initiation_cut_off int
(Updatable) Activity Initiation Cut Off
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"}
description str
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
display_name str
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
run_books Sequence[fleetappsmanagement.SchedulerDefinitionRunBookArgs]
(Updatable) Runbooks.
actionGroups This property is required. List<Property Map>
(Updatable) Action Groups associated with the Schedule.
compartmentId
This property is required.
Changes to this property will trigger replacement.
String
Tenancy OCID
schedule This property is required. Property Map
(Updatable) Schedule Information.
activityInitiationCutOff Number
(Updatable) Activity Initiation Cut Off
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
runBooks List<Property Map>
(Updatable) Runbooks.

Outputs

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

ActionGroupTypes List<string>
All ActionGroup Types that are part of the schedule.
ApplicationTypes List<string>
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
CountOfAffectedActionGroups int
Count of Action Groups affected by the Schedule.
CountOfAffectedResources int
Count of Resources affected by the Schedule.
CountOfAffectedTargets int
Count of Targets affected by the Schedule.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleOperations List<string>
All LifeCycle Operations that are part of the schedule.
Products List<string>
All products that are part of the schedule for PRODUCT ActionGroup Type.
ResourceRegion string
Associated region
State string
The current state of the SchedulerDefinition.
SystemTags Dictionary<string, string>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeOfNextRun string
The scheduled date for the next run of the Job.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
ActionGroupTypes []string
All ActionGroup Types that are part of the schedule.
ApplicationTypes []string
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
CountOfAffectedActionGroups int
Count of Action Groups affected by the Schedule.
CountOfAffectedResources int
Count of Resources affected by the Schedule.
CountOfAffectedTargets int
Count of Targets affected by the Schedule.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleOperations []string
All LifeCycle Operations that are part of the schedule.
Products []string
All products that are part of the schedule for PRODUCT ActionGroup Type.
ResourceRegion string
Associated region
State string
The current state of the SchedulerDefinition.
SystemTags map[string]string
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeOfNextRun string
The scheduled date for the next run of the Job.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
actionGroupTypes List<String>
All ActionGroup Types that are part of the schedule.
applicationTypes List<String>
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
countOfAffectedActionGroups Integer
Count of Action Groups affected by the Schedule.
countOfAffectedResources Integer
Count of Resources affected by the Schedule.
countOfAffectedTargets Integer
Count of Targets affected by the Schedule.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycleOperations List<String>
All LifeCycle Operations that are part of the schedule.
products List<String>
All products that are part of the schedule for PRODUCT ActionGroup Type.
resourceRegion String
Associated region
state String
The current state of the SchedulerDefinition.
systemTags Map<String,String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeOfNextRun String
The scheduled date for the next run of the Job.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.
actionGroupTypes string[]
All ActionGroup Types that are part of the schedule.
applicationTypes string[]
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
countOfAffectedActionGroups number
Count of Action Groups affected by the Schedule.
countOfAffectedResources number
Count of Resources affected by the Schedule.
countOfAffectedTargets number
Count of Targets affected by the Schedule.
id string
The provider-assigned unique ID for this managed resource.
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycleOperations string[]
All LifeCycle Operations that are part of the schedule.
products string[]
All products that are part of the schedule for PRODUCT ActionGroup Type.
resourceRegion string
Associated region
state string
The current state of the SchedulerDefinition.
systemTags {[key: string]: string}
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
timeOfNextRun string
The scheduled date for the next run of the Job.
timeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
action_group_types Sequence[str]
All ActionGroup Types that are part of the schedule.
application_types Sequence[str]
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
count_of_affected_action_groups int
Count of Action Groups affected by the Schedule.
count_of_affected_resources int
Count of Resources affected by the Schedule.
count_of_affected_targets int
Count of Targets affected by the Schedule.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycle_operations Sequence[str]
All LifeCycle Operations that are part of the schedule.
products Sequence[str]
All products that are part of the schedule for PRODUCT ActionGroup Type.
resource_region str
Associated region
state str
The current state of the SchedulerDefinition.
system_tags Mapping[str, str]
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The time this resource was created. An RFC3339 formatted datetime string.
time_of_next_run str
The scheduled date for the next run of the Job.
time_updated str
The time this resource was last updated. An RFC3339 formatted datetime string.
actionGroupTypes List<String>
All ActionGroup Types that are part of the schedule.
applicationTypes List<String>
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
countOfAffectedActionGroups Number
Count of Action Groups affected by the Schedule.
countOfAffectedResources Number
Count of Resources affected by the Schedule.
countOfAffectedTargets Number
Count of Targets affected by the Schedule.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycleOperations List<String>
All LifeCycle Operations that are part of the schedule.
products List<String>
All products that are part of the schedule for PRODUCT ActionGroup Type.
resourceRegion String
Associated region
state String
The current state of the SchedulerDefinition.
systemTags Map<String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeOfNextRun String
The scheduled date for the next run of the Job.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.

Look up Existing SchedulerDefinition Resource

Get an existing SchedulerDefinition 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?: SchedulerDefinitionState, opts?: CustomResourceOptions): SchedulerDefinition
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_group_types: Optional[Sequence[str]] = None,
        action_groups: Optional[Sequence[_fleetappsmanagement.SchedulerDefinitionActionGroupArgs]] = None,
        activity_initiation_cut_off: Optional[int] = None,
        application_types: Optional[Sequence[str]] = None,
        compartment_id: Optional[str] = None,
        count_of_affected_action_groups: Optional[int] = None,
        count_of_affected_resources: Optional[int] = None,
        count_of_affected_targets: Optional[int] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        lifecycle_operations: Optional[Sequence[str]] = None,
        products: Optional[Sequence[str]] = None,
        resource_region: Optional[str] = None,
        run_books: Optional[Sequence[_fleetappsmanagement.SchedulerDefinitionRunBookArgs]] = None,
        schedule: Optional[_fleetappsmanagement.SchedulerDefinitionScheduleArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_of_next_run: Optional[str] = None,
        time_updated: Optional[str] = None) -> SchedulerDefinition
func GetSchedulerDefinition(ctx *Context, name string, id IDInput, state *SchedulerDefinitionState, opts ...ResourceOption) (*SchedulerDefinition, error)
public static SchedulerDefinition Get(string name, Input<string> id, SchedulerDefinitionState? state, CustomResourceOptions? opts = null)
public static SchedulerDefinition get(String name, Output<String> id, SchedulerDefinitionState state, CustomResourceOptions options)
resources:  _:    type: oci:FleetAppsManagement:SchedulerDefinition    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ActionGroupTypes List<string>
All ActionGroup Types that are part of the schedule.
ActionGroups List<SchedulerDefinitionActionGroup>
(Updatable) Action Groups associated with the Schedule.
ActivityInitiationCutOff int
(Updatable) Activity Initiation Cut Off
ApplicationTypes List<string>
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
CompartmentId Changes to this property will trigger replacement. string
Tenancy OCID
CountOfAffectedActionGroups int
Count of Action Groups affected by the Schedule.
CountOfAffectedResources int
Count of Resources affected by the Schedule.
CountOfAffectedTargets int
Count of Targets affected by the Schedule.
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"}
Description string
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleOperations List<string>
All LifeCycle Operations that are part of the schedule.
Products List<string>
All products that are part of the schedule for PRODUCT ActionGroup Type.
ResourceRegion string
Associated region
RunBooks List<SchedulerDefinitionRunBook>
(Updatable) Runbooks.
Schedule SchedulerDefinitionSchedule
(Updatable) Schedule Information.
State string
The current state of the SchedulerDefinition.
SystemTags Dictionary<string, string>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeOfNextRun string
The scheduled date for the next run of the Job.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
ActionGroupTypes []string
All ActionGroup Types that are part of the schedule.
ActionGroups []SchedulerDefinitionActionGroupArgs
(Updatable) Action Groups associated with the Schedule.
ActivityInitiationCutOff int
(Updatable) Activity Initiation Cut Off
ApplicationTypes []string
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
CompartmentId Changes to this property will trigger replacement. string
Tenancy OCID
CountOfAffectedActionGroups int
Count of Action Groups affected by the Schedule.
CountOfAffectedResources int
Count of Resources affected by the Schedule.
CountOfAffectedTargets int
Count of Targets affected by the Schedule.
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"}
Description string
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
LifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleOperations []string
All LifeCycle Operations that are part of the schedule.
Products []string
All products that are part of the schedule for PRODUCT ActionGroup Type.
ResourceRegion string
Associated region
RunBooks []SchedulerDefinitionRunBookArgs
(Updatable) Runbooks.
Schedule SchedulerDefinitionScheduleArgs
(Updatable) Schedule Information.
State string
The current state of the SchedulerDefinition.
SystemTags map[string]string
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
TimeOfNextRun string
The scheduled date for the next run of the Job.
TimeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
actionGroupTypes List<String>
All ActionGroup Types that are part of the schedule.
actionGroups List<SchedulerDefinitionActionGroup>
(Updatable) Action Groups associated with the Schedule.
activityInitiationCutOff Integer
(Updatable) Activity Initiation Cut Off
applicationTypes List<String>
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
compartmentId Changes to this property will trigger replacement. String
Tenancy OCID
countOfAffectedActionGroups Integer
Count of Action Groups affected by the Schedule.
countOfAffectedResources Integer
Count of Resources affected by the Schedule.
countOfAffectedTargets Integer
Count of Targets affected by the Schedule.
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"}
description String
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycleOperations List<String>
All LifeCycle Operations that are part of the schedule.
products List<String>
All products that are part of the schedule for PRODUCT ActionGroup Type.
resourceRegion String
Associated region
runBooks List<SchedulerDefinitionRunBook>
(Updatable) Runbooks.
schedule SchedulerDefinitionSchedule
(Updatable) Schedule Information.
state String
The current state of the SchedulerDefinition.
systemTags Map<String,String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeOfNextRun String
The scheduled date for the next run of the Job.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.
actionGroupTypes string[]
All ActionGroup Types that are part of the schedule.
actionGroups SchedulerDefinitionActionGroup[]
(Updatable) Action Groups associated with the Schedule.
activityInitiationCutOff number
(Updatable) Activity Initiation Cut Off
applicationTypes string[]
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
compartmentId Changes to this property will trigger replacement. string
Tenancy OCID
countOfAffectedActionGroups number
Count of Action Groups affected by the Schedule.
countOfAffectedResources number
Count of Resources affected by the Schedule.
countOfAffectedTargets number
Count of Targets affected by the Schedule.
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"}
description string
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
displayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
lifecycleDetails string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycleOperations string[]
All LifeCycle Operations that are part of the schedule.
products string[]
All products that are part of the schedule for PRODUCT ActionGroup Type.
resourceRegion string
Associated region
runBooks SchedulerDefinitionRunBook[]
(Updatable) Runbooks.
schedule SchedulerDefinitionSchedule
(Updatable) Schedule Information.
state string
The current state of the SchedulerDefinition.
systemTags {[key: string]: string}
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The time this resource was created. An RFC3339 formatted datetime string.
timeOfNextRun string
The scheduled date for the next run of the Job.
timeUpdated string
The time this resource was last updated. An RFC3339 formatted datetime string.
action_group_types Sequence[str]
All ActionGroup Types that are part of the schedule.
action_groups Sequence[fleetappsmanagement.SchedulerDefinitionActionGroupArgs]
(Updatable) Action Groups associated with the Schedule.
activity_initiation_cut_off int
(Updatable) Activity Initiation Cut Off
application_types Sequence[str]
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
compartment_id Changes to this property will trigger replacement. str
Tenancy OCID
count_of_affected_action_groups int
Count of Action Groups affected by the Schedule.
count_of_affected_resources int
Count of Resources affected by the Schedule.
count_of_affected_targets int
Count of Targets affected by the Schedule.
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"}
description str
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
display_name str
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
lifecycle_details str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycle_operations Sequence[str]
All LifeCycle Operations that are part of the schedule.
products Sequence[str]
All products that are part of the schedule for PRODUCT ActionGroup Type.
resource_region str
Associated region
run_books Sequence[fleetappsmanagement.SchedulerDefinitionRunBookArgs]
(Updatable) Runbooks.
schedule fleetappsmanagement.SchedulerDefinitionScheduleArgs
(Updatable) Schedule Information.
state str
The current state of the SchedulerDefinition.
system_tags Mapping[str, str]
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The time this resource was created. An RFC3339 formatted datetime string.
time_of_next_run str
The scheduled date for the next run of the Job.
time_updated str
The time this resource was last updated. An RFC3339 formatted datetime string.
actionGroupTypes List<String>
All ActionGroup Types that are part of the schedule.
actionGroups List<Property Map>
(Updatable) Action Groups associated with the Schedule.
activityInitiationCutOff Number
(Updatable) Activity Initiation Cut Off
applicationTypes List<String>
All application types that are part of the schedule for ENVIRONMENT ActionGroup Type.
compartmentId Changes to this property will trigger replacement. String
Tenancy OCID
countOfAffectedActionGroups Number
Count of Action Groups affected by the Schedule.
countOfAffectedResources Number
Count of Resources affected by the Schedule.
countOfAffectedTargets Number
Count of Targets affected by the Schedule.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String
(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
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"}
lifecycleDetails String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycleOperations List<String>
All LifeCycle Operations that are part of the schedule.
products List<String>
All products that are part of the schedule for PRODUCT ActionGroup Type.
resourceRegion String
Associated region
runBooks List<Property Map>
(Updatable) Runbooks.
schedule Property Map
(Updatable) Schedule Information.
state String
The current state of the SchedulerDefinition.
systemTags Map<String>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time this resource was created. An RFC3339 formatted datetime string.
timeOfNextRun String
The scheduled date for the next run of the Job.
timeUpdated String
The time this resource was last updated. An RFC3339 formatted datetime string.

Supporting Types

SchedulerDefinitionActionGroup
, SchedulerDefinitionActionGroupArgs

ResourceId This property is required. string
(Updatable) Provide the ID of the resource. Example fleet ID.
RunbookId This property is required. string
(Updatable) ID of the runbook
ApplicationType string
(Updatable) Application Type associated. Only applicable if type is ENVIRONMENT.
LifecycleOperation string
(Updatable) LifeCycle Operation
Product string
(Updatable) Product associated. Only applicable if type is PRODUCT.
Subjects List<string>
(Updatable) Provide subjects that need to be considered for the schedule.
TargetId string
(Updatable) Provide the target if schedule is created against the target
Type string
(Updatable) ActionGroup Type associated.
ResourceId This property is required. string
(Updatable) Provide the ID of the resource. Example fleet ID.
RunbookId This property is required. string
(Updatable) ID of the runbook
ApplicationType string
(Updatable) Application Type associated. Only applicable if type is ENVIRONMENT.
LifecycleOperation string
(Updatable) LifeCycle Operation
Product string
(Updatable) Product associated. Only applicable if type is PRODUCT.
Subjects []string
(Updatable) Provide subjects that need to be considered for the schedule.
TargetId string
(Updatable) Provide the target if schedule is created against the target
Type string
(Updatable) ActionGroup Type associated.
resourceId This property is required. String
(Updatable) Provide the ID of the resource. Example fleet ID.
runbookId This property is required. String
(Updatable) ID of the runbook
applicationType String
(Updatable) Application Type associated. Only applicable if type is ENVIRONMENT.
lifecycleOperation String
(Updatable) LifeCycle Operation
product String
(Updatable) Product associated. Only applicable if type is PRODUCT.
subjects List<String>
(Updatable) Provide subjects that need to be considered for the schedule.
targetId String
(Updatable) Provide the target if schedule is created against the target
type String
(Updatable) ActionGroup Type associated.
resourceId This property is required. string
(Updatable) Provide the ID of the resource. Example fleet ID.
runbookId This property is required. string
(Updatable) ID of the runbook
applicationType string
(Updatable) Application Type associated. Only applicable if type is ENVIRONMENT.
lifecycleOperation string
(Updatable) LifeCycle Operation
product string
(Updatable) Product associated. Only applicable if type is PRODUCT.
subjects string[]
(Updatable) Provide subjects that need to be considered for the schedule.
targetId string
(Updatable) Provide the target if schedule is created against the target
type string
(Updatable) ActionGroup Type associated.
resource_id This property is required. str
(Updatable) Provide the ID of the resource. Example fleet ID.
runbook_id This property is required. str
(Updatable) ID of the runbook
application_type str
(Updatable) Application Type associated. Only applicable if type is ENVIRONMENT.
lifecycle_operation str
(Updatable) LifeCycle Operation
product str
(Updatable) Product associated. Only applicable if type is PRODUCT.
subjects Sequence[str]
(Updatable) Provide subjects that need to be considered for the schedule.
target_id str
(Updatable) Provide the target if schedule is created against the target
type str
(Updatable) ActionGroup Type associated.
resourceId This property is required. String
(Updatable) Provide the ID of the resource. Example fleet ID.
runbookId This property is required. String
(Updatable) ID of the runbook
applicationType String
(Updatable) Application Type associated. Only applicable if type is ENVIRONMENT.
lifecycleOperation String
(Updatable) LifeCycle Operation
product String
(Updatable) Product associated. Only applicable if type is PRODUCT.
subjects List<String>
(Updatable) Provide subjects that need to be considered for the schedule.
targetId String
(Updatable) Provide the target if schedule is created against the target
type String
(Updatable) ActionGroup Type associated.

SchedulerDefinitionRunBook
, SchedulerDefinitionRunBookArgs

Id This property is required. string
(Updatable) The ID of the Runbook
InputParameters List<SchedulerDefinitionRunBookInputParameter>
(Updatable) Input Parameters for the Task
Id This property is required. string
(Updatable) The ID of the Runbook
InputParameters []SchedulerDefinitionRunBookInputParameter
(Updatable) Input Parameters for the Task
id This property is required. String
(Updatable) The ID of the Runbook
inputParameters List<SchedulerDefinitionRunBookInputParameter>
(Updatable) Input Parameters for the Task
id This property is required. string
(Updatable) The ID of the Runbook
inputParameters SchedulerDefinitionRunBookInputParameter[]
(Updatable) Input Parameters for the Task
id This property is required. str
(Updatable) The ID of the Runbook
input_parameters Sequence[fleetappsmanagement.SchedulerDefinitionRunBookInputParameter]
(Updatable) Input Parameters for the Task
id This property is required. String
(Updatable) The ID of the Runbook
inputParameters List<Property Map>
(Updatable) Input Parameters for the Task

SchedulerDefinitionRunBookInputParameter
, SchedulerDefinitionRunBookInputParameterArgs

StepName This property is required. string
(Updatable) stepName for which the input parameters are provided
Arguments List<SchedulerDefinitionRunBookInputParameterArgument>
(Updatable) Arguments for the Task
StepName This property is required. string
(Updatable) stepName for which the input parameters are provided
Arguments []SchedulerDefinitionRunBookInputParameterArgument
(Updatable) Arguments for the Task
stepName This property is required. String
(Updatable) stepName for which the input parameters are provided
arguments List<SchedulerDefinitionRunBookInputParameterArgument>
(Updatable) Arguments for the Task
stepName This property is required. string
(Updatable) stepName for which the input parameters are provided
arguments SchedulerDefinitionRunBookInputParameterArgument[]
(Updatable) Arguments for the Task
step_name This property is required. str
(Updatable) stepName for which the input parameters are provided
arguments Sequence[fleetappsmanagement.SchedulerDefinitionRunBookInputParameterArgument]
(Updatable) Arguments for the Task
stepName This property is required. String
(Updatable) stepName for which the input parameters are provided
arguments List<Property Map>
(Updatable) Arguments for the Task

SchedulerDefinitionRunBookInputParameterArgument
, SchedulerDefinitionRunBookInputParameterArgumentArgs

Name This property is required. string
(Updatable) Name of the output variable
Value string
(Updatable) The task output
Name This property is required. string
(Updatable) Name of the output variable
Value string
(Updatable) The task output
name This property is required. String
(Updatable) Name of the output variable
value String
(Updatable) The task output
name This property is required. string
(Updatable) Name of the output variable
value string
(Updatable) The task output
name This property is required. str
(Updatable) Name of the output variable
value str
(Updatable) The task output
name This property is required. String
(Updatable) Name of the output variable
value String
(Updatable) The task output

SchedulerDefinitionSchedule
, SchedulerDefinitionScheduleArgs

ExecutionStartdate This property is required. string
(Updatable) Start Date for the schedule. An RFC3339 formatted datetime string
Type This property is required. string

(Updatable) Schedule Type

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

Duration string
(Updatable) Duration if schedule type is Custom
MaintenanceWindowId string
(Updatable) Provide MaintenanceWindowId if Schedule Type is Maintenance Window
Recurrences string
(Updatable) Recurrence rule specification if Schedule Type is Custom and Recurring
ExecutionStartdate This property is required. string
(Updatable) Start Date for the schedule. An RFC3339 formatted datetime string
Type This property is required. string

(Updatable) Schedule Type

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

Duration string
(Updatable) Duration if schedule type is Custom
MaintenanceWindowId string
(Updatable) Provide MaintenanceWindowId if Schedule Type is Maintenance Window
Recurrences string
(Updatable) Recurrence rule specification if Schedule Type is Custom and Recurring
executionStartdate This property is required. String
(Updatable) Start Date for the schedule. An RFC3339 formatted datetime string
type This property is required. String

(Updatable) Schedule Type

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

duration String
(Updatable) Duration if schedule type is Custom
maintenanceWindowId String
(Updatable) Provide MaintenanceWindowId if Schedule Type is Maintenance Window
recurrences String
(Updatable) Recurrence rule specification if Schedule Type is Custom and Recurring
executionStartdate This property is required. string
(Updatable) Start Date for the schedule. An RFC3339 formatted datetime string
type This property is required. string

(Updatable) Schedule Type

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

duration string
(Updatable) Duration if schedule type is Custom
maintenanceWindowId string
(Updatable) Provide MaintenanceWindowId if Schedule Type is Maintenance Window
recurrences string
(Updatable) Recurrence rule specification if Schedule Type is Custom and Recurring
execution_startdate This property is required. str
(Updatable) Start Date for the schedule. An RFC3339 formatted datetime string
type This property is required. str

(Updatable) Schedule Type

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

duration str
(Updatable) Duration if schedule type is Custom
maintenance_window_id str
(Updatable) Provide MaintenanceWindowId if Schedule Type is Maintenance Window
recurrences str
(Updatable) Recurrence rule specification if Schedule Type is Custom and Recurring
executionStartdate This property is required. String
(Updatable) Start Date for the schedule. An RFC3339 formatted datetime string
type This property is required. String

(Updatable) Schedule Type

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

duration String
(Updatable) Duration if schedule type is Custom
maintenanceWindowId String
(Updatable) Provide MaintenanceWindowId if Schedule Type is Maintenance Window
recurrences String
(Updatable) Recurrence rule specification if Schedule Type is Custom and Recurring

Import

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

$ pulumi import oci:FleetAppsManagement/schedulerDefinition:SchedulerDefinition test_scheduler_definition "id"
Copy

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.