Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FleetAppsManagement
  5. getRunbooks
Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.FleetAppsManagement.getRunbooks

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Runbooks in Oracle Cloud Infrastructure Fleet Apps Management service.

    Returns a list of all the runbooks in the specified compartment. The query parameter compartmentId is required unless the query parameter id is specified.

    Example Usage

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

const testRunbooks = oci.FleetAppsManagement.getRunbooks({
    compartmentId: compartmentId,
    displayName: runbookDisplayName,
    id: runbookId,
    operation: runbookOperation,
    platform: runbookPlatform,
    state: runbookState,
    type: runbookType,
});

    import pulumi
import pulumi_oci as oci

test_runbooks = oci.FleetAppsManagement.get_runbooks(compartment_id=compartment_id,
    display_name=runbook_display_name,
    id=runbook_id,
    operation=runbook_operation,
    platform=runbook_platform,
    state=runbook_state,
    type=runbook_type)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fleetappsmanagement.GetRunbooks(ctx, &fleetappsmanagement.GetRunbooksArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(runbookDisplayName),
			Id:            pulumi.StringRef(runbookId),
			Operation:     pulumi.StringRef(runbookOperation),
			Platform:      pulumi.StringRef(runbookPlatform),
			State:         pulumi.StringRef(runbookState),
			Type:          pulumi.StringRef(runbookType),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testRunbooks = Oci.FleetAppsManagement.GetRunbooks.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = runbookDisplayName,
        Id = runbookId,
        Operation = runbookOperation,
        Platform = runbookPlatform,
        State = runbookState,
        Type = runbookType,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FleetAppsManagement.FleetAppsManagementFunctions;
import com.pulumi.oci.FleetAppsManagement.inputs.GetRunbooksArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testRunbooks = FleetAppsManagementFunctions.getRunbooks(GetRunbooksArgs.builder()
            .compartmentId(compartmentId)
            .displayName(runbookDisplayName)
            .id(runbookId)
            .operation(runbookOperation)
            .platform(runbookPlatform)
            .state(runbookState)
            .type(runbookType)
            .build());

    }
}

    variables:
  testRunbooks:
    fn::invoke:
      function: oci:FleetAppsManagement:getRunbooks
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${runbookDisplayName}
        id: ${runbookId}
        operation: ${runbookOperation}
        platform: ${runbookPlatform}
        state: ${runbookState}
        type: ${runbookType}

    Using getRunbooks

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRunbooks(args: GetRunbooksArgs, opts?: InvokeOptions): Promise<GetRunbooksResult>
function getRunbooksOutput(args: GetRunbooksOutputArgs, opts?: InvokeOptions): Output<GetRunbooksResult>
    def get_runbooks(compartment_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[GetRunbooksFilter]] = None,
                 id: Optional[str] = None,
                 operation: Optional[str] = None,
                 platform: Optional[str] = None,
                 state: Optional[str] = None,
                 type: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetRunbooksResult
def get_runbooks_output(compartment_id: Optional[pulumi.Input[str]] = None,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetRunbooksFilterArgs]]]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 operation: Optional[pulumi.Input[str]] = None,
                 platform: Optional[pulumi.Input[str]] = None,
                 state: Optional[pulumi.Input[str]] = None,
                 type: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetRunbooksResult]
    func GetRunbooks(ctx *Context, args *GetRunbooksArgs, opts ...InvokeOption) (*GetRunbooksResult, error)
func GetRunbooksOutput(ctx *Context, args *GetRunbooksOutputArgs, opts ...InvokeOption) GetRunbooksResultOutput

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

    public static class GetRunbooks 
{
    public static Task<GetRunbooksResult> InvokeAsync(GetRunbooksArgs args, InvokeOptions? opts = null)
    public static Output<GetRunbooksResult> Invoke(GetRunbooksInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRunbooksResult> getRunbooks(GetRunbooksArgs args, InvokeOptions options)
public static Output<GetRunbooksResult> getRunbooks(GetRunbooksArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:FleetAppsManagement/getRunbooks:getRunbooks
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters List<GetRunbooksFilter>
    Id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    Operation string
    A filter to return runbooks whose operation matches the given lifecycle operation.
    Platform string
    A filter to return runbooks whose platform matches the given platform.
    State string
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    Type string
    A filter to return runbooks whose type matches the given type.
    CompartmentId string
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters []GetRunbooksFilter
    Id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    Operation string
    A filter to return runbooks whose operation matches the given lifecycle operation.
    Platform string
    A filter to return runbooks whose platform matches the given platform.
    State string
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    Type string
    A filter to return runbooks whose type matches the given type.
    compartmentId String
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<GetRunbooksFilter>
    id String
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    operation String
    A filter to return runbooks whose operation matches the given lifecycle operation.
    platform String
    A filter to return runbooks whose platform matches the given platform.
    state String
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    type String
    A filter to return runbooks whose type matches the given type.
    compartmentId string
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    displayName string
    A filter to return only resources that match the entire display name given.
    filters GetRunbooksFilter[]
    id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    operation string
    A filter to return runbooks whose operation matches the given lifecycle operation.
    platform string
    A filter to return runbooks whose platform matches the given platform.
    state string
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    type string
    A filter to return runbooks whose type matches the given type.
    compartment_id str
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    display_name str
    A filter to return only resources that match the entire display name given.
    filters Sequence[GetRunbooksFilter]
    id str
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    operation str
    A filter to return runbooks whose operation matches the given lifecycle operation.
    platform str
    A filter to return runbooks whose platform matches the given platform.
    state str
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    type str
    A filter to return runbooks whose type matches the given type.
    compartmentId String
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<Property Map>
    id String
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    operation String
    A filter to return runbooks whose operation matches the given lifecycle operation.
    platform String
    A filter to return runbooks whose platform matches the given platform.
    state String
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    type String
    A filter to return runbooks whose type matches the given type.

    getRunbooks Result

    The following output properties are available:

    RunbookCollections List<GetRunbooksRunbookCollection>
    The list of runbook_collection.
    CompartmentId string
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    Filters List<GetRunbooksFilter>
    Id string
    The OCID of the resource.
    Operation string
    The lifecycle operation performed by the runbook.
    Platform string
    The platform of the runbook.
    State string
    The current state of the runbook.
    Type string
    The type of the runbook.
    RunbookCollections []GetRunbooksRunbookCollection
    The list of runbook_collection.
    CompartmentId string
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    Filters []GetRunbooksFilter
    Id string
    The OCID of the resource.
    Operation string
    The lifecycle operation performed by the runbook.
    Platform string
    The platform of the runbook.
    State string
    The current state of the runbook.
    Type string
    The type of the runbook.
    runbookCollections List<GetRunbooksRunbookCollection>
    The list of runbook_collection.
    compartmentId String
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    filters List<GetRunbooksFilter>
    id String
    The OCID of the resource.
    operation String
    The lifecycle operation performed by the runbook.
    platform String
    The platform of the runbook.
    state String
    The current state of the runbook.
    type String
    The type of the runbook.
    runbookCollections GetRunbooksRunbookCollection[]
    The list of runbook_collection.
    compartmentId string
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    filters GetRunbooksFilter[]
    id string
    The OCID of the resource.
    operation string
    The lifecycle operation performed by the runbook.
    platform string
    The platform of the runbook.
    state string
    The current state of the runbook.
    type string
    The type of the runbook.
    runbook_collections Sequence[GetRunbooksRunbookCollection]
    The list of runbook_collection.
    compartment_id str
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    filters Sequence[GetRunbooksFilter]
    id str
    The OCID of the resource.
    operation str
    The lifecycle operation performed by the runbook.
    platform str
    The platform of the runbook.
    state str
    The current state of the runbook.
    type str
    The type of the runbook.
    runbookCollections List<Property Map>
    The list of runbook_collection.
    compartmentId String
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
    filters List<Property Map>
    id String
    The OCID of the resource.
    operation String
    The lifecycle operation performed by the runbook.
    platform String
    The platform of the runbook.
    state String
    The current state of the runbook.
    type String
    The type of the runbook.

    Supporting Types

    GetRunbooksFilter

    Name string
    The name of the task
    Values List<string>
    Regex bool
    Name string
    The name of the task
    Values []string
    Regex bool
    name String
    The name of the task
    values List<String>
    regex Boolean
    name string
    The name of the task
    values string[]
    regex boolean
    name str
    The name of the task
    values Sequence[str]
    regex bool
    name String
    The name of the task
    values List<String>
    regex Boolean

    GetRunbooksRunbookCollection

    GetRunbooksRunbookCollectionItem

    CompartmentId string
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    The description of the argument.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    EstimatedTime string
    Estimated time to successfully complete the runbook execution.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    HasDraftVersion bool
    Does this runbook has draft versions?
    Id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    IsDefault bool
    Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
    IsSudoAccessNeeded bool
    Does this runbook need SUDO access to execute?
    LatestVersion string
    Latest runbook version
    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.
    Operation string
    A filter to return runbooks whose operation matches the given lifecycle operation.
    OsType string
    The OS for the task.
    Platform string
    A filter to return runbooks whose platform matches the given platform.
    ResourceRegion string
    Associated region
    RunbookVersions List<GetRunbooksRunbookCollectionItemRunbookVersion>
    Version for the runbook.
    State string
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    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.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    Type string
    A filter to return runbooks whose type matches the given type.
    CompartmentId string
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    The description of the argument.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    EstimatedTime string
    Estimated time to successfully complete the runbook execution.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    HasDraftVersion bool
    Does this runbook has draft versions?
    Id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    IsDefault bool
    Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
    IsSudoAccessNeeded bool
    Does this runbook need SUDO access to execute?
    LatestVersion string
    Latest runbook version
    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.
    Operation string
    A filter to return runbooks whose operation matches the given lifecycle operation.
    OsType string
    The OS for the task.
    Platform string
    A filter to return runbooks whose platform matches the given platform.
    ResourceRegion string
    Associated region
    RunbookVersions []GetRunbooksRunbookCollectionItemRunbookVersion
    Version for the runbook.
    State string
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    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.
    TimeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    Type string
    A filter to return runbooks whose type matches the given type.
    compartmentId String
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    The description of the argument.
    displayName String
    A filter to return only resources that match the entire display name given.
    estimatedTime String
    Estimated time to successfully complete the runbook execution.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hasDraftVersion Boolean
    Does this runbook has draft versions?
    id String
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    isDefault Boolean
    Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
    isSudoAccessNeeded Boolean
    Does this runbook need SUDO access to execute?
    latestVersion String
    Latest runbook version
    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.
    operation String
    A filter to return runbooks whose operation matches the given lifecycle operation.
    osType String
    The OS for the task.
    platform String
    A filter to return runbooks whose platform matches the given platform.
    resourceRegion String
    Associated region
    runbookVersions List<GetRunbooksRunbookCollectionItemRunbookVersion>
    Version for the runbook.
    state String
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    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.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    type String
    A filter to return runbooks whose type matches the given type.
    compartmentId string
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    The description of the argument.
    displayName string
    A filter to return only resources that match the entire display name given.
    estimatedTime string
    Estimated time to successfully complete the runbook execution.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hasDraftVersion boolean
    Does this runbook has draft versions?
    id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    isDefault boolean
    Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
    isSudoAccessNeeded boolean
    Does this runbook need SUDO access to execute?
    latestVersion string
    Latest runbook version
    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.
    operation string
    A filter to return runbooks whose operation matches the given lifecycle operation.
    osType string
    The OS for the task.
    platform string
    A filter to return runbooks whose platform matches the given platform.
    resourceRegion string
    Associated region
    runbookVersions GetRunbooksRunbookCollectionItemRunbookVersion[]
    Version for the runbook.
    state string
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    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.
    timeUpdated string
    The time this resource was last updated. An RFC3339 formatted datetime string.
    type string
    A filter to return runbooks whose type matches the given type.
    compartment_id str
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    The description of the argument.
    display_name str
    A filter to return only resources that match the entire display name given.
    estimated_time str
    Estimated time to successfully complete the runbook execution.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    has_draft_version bool
    Does this runbook has draft versions?
    id str
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    is_default bool
    Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
    is_sudo_access_needed bool
    Does this runbook need SUDO access to execute?
    latest_version str
    Latest runbook version
    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.
    operation str
    A filter to return runbooks whose operation matches the given lifecycle operation.
    os_type str
    The OS for the task.
    platform str
    A filter to return runbooks whose platform matches the given platform.
    resource_region str
    Associated region
    runbook_versions Sequence[GetRunbooksRunbookCollectionItemRunbookVersion]
    Version for the runbook.
    state str
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    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_updated str
    The time this resource was last updated. An RFC3339 formatted datetime string.
    type str
    A filter to return runbooks whose type matches the given type.
    compartmentId String
    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    The description of the argument.
    displayName String
    A filter to return only resources that match the entire display name given.
    estimatedTime String
    Estimated time to successfully complete the runbook execution.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hasDraftVersion Boolean
    Does this runbook has draft versions?
    id String
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    isDefault Boolean
    Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation.
    isSudoAccessNeeded Boolean
    Does this runbook need SUDO access to execute?
    latestVersion String
    Latest runbook version
    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.
    operation String
    A filter to return runbooks whose operation matches the given lifecycle operation.
    osType String
    The OS for the task.
    platform String
    A filter to return runbooks whose platform matches the given platform.
    resourceRegion String
    Associated region
    runbookVersions List<Property Map>
    Version for the runbook.
    state String
    A filter to return only resources whose lifecycleState matches the given lifecycleState.
    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.
    timeUpdated String
    The time this resource was last updated. An RFC3339 formatted datetime string.
    type String
    A filter to return runbooks whose type matches the given type.

    GetRunbooksRunbookCollectionItemRunbookVersion

    executionWorkflowDetails List<Property Map>
    Execution Workflow details.
    groups List<Property Map>
    The groups of the runbook.
    isLatest Boolean
    Is this version the latest?
    rollbackWorkflowDetails List<Property Map>
    Rollback Workflow details.
    tasks List<Property Map>
    A set of tasks to execute in the runbook.
    version String
    The version of the runbook.

    GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetail

    workflows List<Property Map>
    Rollback Workflow for the runbook.

    GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflow

    GroupName string
    Name of the group.
    Steps List<GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflowStep>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    Type string
    A filter to return runbooks whose type matches the given type.
    GroupName string
    Name of the group.
    Steps []GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflowStep
    Tasks within the Group. Provide the stepName for all applicable tasks.
    Type string
    A filter to return runbooks whose type matches the given type.
    groupName String
    Name of the group.
    steps List<GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflowStep>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type String
    A filter to return runbooks whose type matches the given type.
    groupName string
    Name of the group.
    steps GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflowStep[]
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type string
    A filter to return runbooks whose type matches the given type.
    group_name str
    Name of the group.
    steps Sequence[GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflowStep]
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type str
    A filter to return runbooks whose type matches the given type.
    groupName String
    Name of the group.
    steps List<Property Map>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type String
    A filter to return runbooks whose type matches the given type.

    GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflowStep

    GroupName string
    Name of the group.
    StepName string
    The name of the task step the output variable belongs to.
    Steps List<string>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    Type string
    A filter to return runbooks whose type matches the given type.
    GroupName string
    Name of the group.
    StepName string
    The name of the task step the output variable belongs to.
    Steps []string
    Tasks within the Group. Provide the stepName for all applicable tasks.
    Type string
    A filter to return runbooks whose type matches the given type.
    groupName String
    Name of the group.
    stepName String
    The name of the task step the output variable belongs to.
    steps List<String>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type String
    A filter to return runbooks whose type matches the given type.
    groupName string
    Name of the group.
    stepName string
    The name of the task step the output variable belongs to.
    steps string[]
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type string
    A filter to return runbooks whose type matches the given type.
    group_name str
    Name of the group.
    step_name str
    The name of the task step the output variable belongs to.
    steps Sequence[str]
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type str
    A filter to return runbooks whose type matches the given type.
    groupName String
    Name of the group.
    stepName String
    The name of the task step the output variable belongs to.
    steps List<String>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type String
    A filter to return runbooks whose type matches the given type.

    GetRunbooksRunbookCollectionItemRunbookVersionGroup

    Name string
    The name of the task
    Properties List<GetRunbooksRunbookCollectionItemRunbookVersionGroupProperty>
    The properties of the task.
    Type string
    A filter to return runbooks whose type matches the given type.
    Name string
    The name of the task
    Properties []GetRunbooksRunbookCollectionItemRunbookVersionGroupProperty
    The properties of the task.
    Type string
    A filter to return runbooks whose type matches the given type.
    name String
    The name of the task
    properties List<GetRunbooksRunbookCollectionItemRunbookVersionGroupProperty>
    The properties of the task.
    type String
    A filter to return runbooks whose type matches the given type.
    name string
    The name of the task
    properties GetRunbooksRunbookCollectionItemRunbookVersionGroupProperty[]
    The properties of the task.
    type string
    A filter to return runbooks whose type matches the given type.
    name str
    The name of the task
    properties Sequence[GetRunbooksRunbookCollectionItemRunbookVersionGroupProperty]
    The properties of the task.
    type str
    A filter to return runbooks whose type matches the given type.
    name String
    The name of the task
    properties List<Property Map>
    The properties of the task.
    type String
    A filter to return runbooks whose type matches the given type.

    GetRunbooksRunbookCollectionItemRunbookVersionGroupProperty

    ActionOnFailure string
    The action to be taken in case of a failure.
    NotificationPreferences List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyNotificationPreference>
    Preferences to send notifications on the task activities.
    PauseDetails List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyPauseDetail>
    Pause Details
    PreCondition string
    Build control flow conditions that determine the relevance of the task execution.
    RunOns List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOn>
    The runon conditions
    ActionOnFailure string
    The action to be taken in case of a failure.
    NotificationPreferences []GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyNotificationPreference
    Preferences to send notifications on the task activities.
    PauseDetails []GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyPauseDetail
    Pause Details
    PreCondition string
    Build control flow conditions that determine the relevance of the task execution.
    RunOns []GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOn
    The runon conditions
    actionOnFailure String
    The action to be taken in case of a failure.
    notificationPreferences List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyNotificationPreference>
    Preferences to send notifications on the task activities.
    pauseDetails List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyPauseDetail>
    Pause Details
    preCondition String
    Build control flow conditions that determine the relevance of the task execution.
    runOns List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOn>
    The runon conditions
    actionOnFailure string
    The action to be taken in case of a failure.
    notificationPreferences GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyNotificationPreference[]
    Preferences to send notifications on the task activities.
    pauseDetails GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyPauseDetail[]
    Pause Details
    preCondition string
    Build control flow conditions that determine the relevance of the task execution.
    runOns GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOn[]
    The runon conditions
    action_on_failure str
    The action to be taken in case of a failure.
    notification_preferences Sequence[GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyNotificationPreference]
    Preferences to send notifications on the task activities.
    pause_details Sequence[GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyPauseDetail]
    Pause Details
    pre_condition str
    Build control flow conditions that determine the relevance of the task execution.
    run_ons Sequence[GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOn]
    The runon conditions
    actionOnFailure String
    The action to be taken in case of a failure.
    notificationPreferences List<Property Map>
    Preferences to send notifications on the task activities.
    pauseDetails List<Property Map>
    Pause Details
    preCondition String
    Build control flow conditions that determine the relevance of the task execution.
    runOns List<Property Map>
    The runon conditions

    GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyNotificationPreference

    ShouldNotifyOnPause bool
    Enables notification on pause.
    ShouldNotifyOnTaskFailure bool
    Enables or disables notification on Task Failures.
    ShouldNotifyOnTaskSuccess bool
    Enables or disables notification on Task Success.
    ShouldNotifyOnPause bool
    Enables notification on pause.
    ShouldNotifyOnTaskFailure bool
    Enables or disables notification on Task Failures.
    ShouldNotifyOnTaskSuccess bool
    Enables or disables notification on Task Success.
    shouldNotifyOnPause Boolean
    Enables notification on pause.
    shouldNotifyOnTaskFailure Boolean
    Enables or disables notification on Task Failures.
    shouldNotifyOnTaskSuccess Boolean
    Enables or disables notification on Task Success.
    shouldNotifyOnPause boolean
    Enables notification on pause.
    shouldNotifyOnTaskFailure boolean
    Enables or disables notification on Task Failures.
    shouldNotifyOnTaskSuccess boolean
    Enables or disables notification on Task Success.
    should_notify_on_pause bool
    Enables notification on pause.
    should_notify_on_task_failure bool
    Enables or disables notification on Task Failures.
    should_notify_on_task_success bool
    Enables or disables notification on Task Success.
    shouldNotifyOnPause Boolean
    Enables notification on pause.
    shouldNotifyOnTaskFailure Boolean
    Enables or disables notification on Task Failures.
    shouldNotifyOnTaskSuccess Boolean
    Enables or disables notification on Task Success.

    GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyPauseDetail

    DurationInMinutes int
    Time in minutes to apply Pause.
    Kind string
    Run on based On.
    DurationInMinutes int
    Time in minutes to apply Pause.
    Kind string
    Run on based On.
    durationInMinutes Integer
    Time in minutes to apply Pause.
    kind String
    Run on based On.
    durationInMinutes number
    Time in minutes to apply Pause.
    kind string
    Run on based On.
    duration_in_minutes int
    Time in minutes to apply Pause.
    kind str
    Run on based On.
    durationInMinutes Number
    Time in minutes to apply Pause.
    kind String
    Run on based On.

    GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOn

    Condition string
    Build control flow conditions that determine the relevance of the task execution.
    Host string
    OCID of the self hosted instance.
    Kind string
    Run on based On.
    PreviousTaskInstanceDetails List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail>
    Previous Task Instance Details
    Condition string
    Build control flow conditions that determine the relevance of the task execution.
    Host string
    OCID of the self hosted instance.
    Kind string
    Run on based On.
    PreviousTaskInstanceDetails []GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail
    Previous Task Instance Details
    condition String
    Build control flow conditions that determine the relevance of the task execution.
    host String
    OCID of the self hosted instance.
    kind String
    Run on based On.
    previousTaskInstanceDetails List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail>
    Previous Task Instance Details
    condition string
    Build control flow conditions that determine the relevance of the task execution.
    host string
    OCID of the self hosted instance.
    kind string
    Run on based On.
    previousTaskInstanceDetails GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail[]
    Previous Task Instance Details
    condition str
    Build control flow conditions that determine the relevance of the task execution.
    host str
    OCID of the self hosted instance.
    kind str
    Run on based On.
    previous_task_instance_details Sequence[GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail]
    Previous Task Instance Details
    condition String
    Build control flow conditions that determine the relevance of the task execution.
    host String
    OCID of the self hosted instance.
    kind String
    Run on based On.
    previousTaskInstanceDetails List<Property Map>
    Previous Task Instance Details

    GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail

    OutputVariableDetails List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail>
    The details of the output variable that will be used for mapping.
    ResourceId string
    Resource Ocid.
    ResourceType string
    Resource Type.
    OutputVariableDetails []GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail
    The details of the output variable that will be used for mapping.
    ResourceId string
    Resource Ocid.
    ResourceType string
    Resource Type.
    outputVariableDetails List<GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail>
    The details of the output variable that will be used for mapping.
    resourceId String
    Resource Ocid.
    resourceType String
    Resource Type.
    outputVariableDetails GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]
    The details of the output variable that will be used for mapping.
    resourceId string
    Resource Ocid.
    resourceType string
    Resource Type.
    outputVariableDetails List<Property Map>
    The details of the output variable that will be used for mapping.
    resourceId String
    Resource Ocid.
    resourceType String
    Resource Type.

    GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail

    OutputVariableName string
    The name of the output variable whose value has to be mapped.
    StepName string
    The name of the task step the output variable belongs to.
    OutputVariableName string
    The name of the output variable whose value has to be mapped.
    StepName string
    The name of the task step the output variable belongs to.
    outputVariableName String
    The name of the output variable whose value has to be mapped.
    stepName String
    The name of the task step the output variable belongs to.
    outputVariableName string
    The name of the output variable whose value has to be mapped.
    stepName string
    The name of the task step the output variable belongs to.
    output_variable_name str
    The name of the output variable whose value has to be mapped.
    step_name str
    The name of the task step the output variable belongs to.
    outputVariableName String
    The name of the output variable whose value has to be mapped.
    stepName String
    The name of the task step the output variable belongs to.

    GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetail

    Scope string
    The scope of the task.
    Workflows List<GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflow>
    Rollback Workflow for the runbook.
    Scope string
    The scope of the task.
    Workflows []GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflow
    Rollback Workflow for the runbook.
    scope String
    The scope of the task.
    workflows List<GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflow>
    Rollback Workflow for the runbook.
    scope string
    The scope of the task.
    workflows GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflow[]
    Rollback Workflow for the runbook.
    scope String
    The scope of the task.
    workflows List<Property Map>
    Rollback Workflow for the runbook.

    GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflow

    GroupName string
    Name of the group.
    Steps List<GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflowStep>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    Type string
    A filter to return runbooks whose type matches the given type.
    GroupName string
    Name of the group.
    Steps []GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflowStep
    Tasks within the Group. Provide the stepName for all applicable tasks.
    Type string
    A filter to return runbooks whose type matches the given type.
    groupName String
    Name of the group.
    steps List<GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflowStep>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type String
    A filter to return runbooks whose type matches the given type.
    groupName string
    Name of the group.
    steps GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflowStep[]
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type string
    A filter to return runbooks whose type matches the given type.
    group_name str
    Name of the group.
    steps Sequence[GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflowStep]
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type str
    A filter to return runbooks whose type matches the given type.
    groupName String
    Name of the group.
    steps List<Property Map>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type String
    A filter to return runbooks whose type matches the given type.

    GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflowStep

    GroupName string
    Name of the group.
    StepName string
    The name of the task step the output variable belongs to.
    Steps List<string>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    Type string
    A filter to return runbooks whose type matches the given type.
    GroupName string
    Name of the group.
    StepName string
    The name of the task step the output variable belongs to.
    Steps []string
    Tasks within the Group. Provide the stepName for all applicable tasks.
    Type string
    A filter to return runbooks whose type matches the given type.
    groupName String
    Name of the group.
    stepName String
    The name of the task step the output variable belongs to.
    steps List<String>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type String
    A filter to return runbooks whose type matches the given type.
    groupName string
    Name of the group.
    stepName string
    The name of the task step the output variable belongs to.
    steps string[]
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type string
    A filter to return runbooks whose type matches the given type.
    group_name str
    Name of the group.
    step_name str
    The name of the task step the output variable belongs to.
    steps Sequence[str]
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type str
    A filter to return runbooks whose type matches the given type.
    groupName String
    Name of the group.
    stepName String
    The name of the task step the output variable belongs to.
    steps List<String>
    Tasks within the Group. Provide the stepName for all applicable tasks.
    type String
    A filter to return runbooks whose type matches the given type.

    GetRunbooksRunbookCollectionItemRunbookVersionTask

    OutputVariableMappings List<GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMapping>
    Mapping output variables of previous tasks to the input variables of the current task.
    StepName string
    The name of the task step the output variable belongs to.
    StepProperties List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepProperty>
    The properties of the component.
    TaskRecordDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetail>
    The details of the task.
    OutputVariableMappings []GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMapping
    Mapping output variables of previous tasks to the input variables of the current task.
    StepName string
    The name of the task step the output variable belongs to.
    StepProperties []GetRunbooksRunbookCollectionItemRunbookVersionTaskStepProperty
    The properties of the component.
    TaskRecordDetails []GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetail
    The details of the task.
    outputVariableMappings List<GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMapping>
    Mapping output variables of previous tasks to the input variables of the current task.
    stepName String
    The name of the task step the output variable belongs to.
    stepProperties List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepProperty>
    The properties of the component.
    taskRecordDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetail>
    The details of the task.
    outputVariableMappings GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMapping[]
    Mapping output variables of previous tasks to the input variables of the current task.
    stepName string
    The name of the task step the output variable belongs to.
    stepProperties GetRunbooksRunbookCollectionItemRunbookVersionTaskStepProperty[]
    The properties of the component.
    taskRecordDetails GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetail[]
    The details of the task.
    output_variable_mappings Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMapping]
    Mapping output variables of previous tasks to the input variables of the current task.
    step_name str
    The name of the task step the output variable belongs to.
    step_properties Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskStepProperty]
    The properties of the component.
    task_record_details Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetail]
    The details of the task.
    outputVariableMappings List<Property Map>
    Mapping output variables of previous tasks to the input variables of the current task.
    stepName String
    The name of the task step the output variable belongs to.
    stepProperties List<Property Map>
    The properties of the component.
    taskRecordDetails List<Property Map>
    The details of the task.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMapping

    Name string
    The name of the task
    OutputVariableDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMappingOutputVariableDetail>
    The details of the output variable that will be used for mapping.
    Name string
    The name of the task
    OutputVariableDetails []GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMappingOutputVariableDetail
    The details of the output variable that will be used for mapping.
    name String
    The name of the task
    outputVariableDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMappingOutputVariableDetail>
    The details of the output variable that will be used for mapping.
    name string
    The name of the task
    outputVariableDetails GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMappingOutputVariableDetail[]
    The details of the output variable that will be used for mapping.
    name str
    The name of the task
    output_variable_details Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMappingOutputVariableDetail]
    The details of the output variable that will be used for mapping.
    name String
    The name of the task
    outputVariableDetails List<Property Map>
    The details of the output variable that will be used for mapping.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMappingOutputVariableDetail

    OutputVariableName string
    The name of the output variable whose value has to be mapped.
    StepName string
    The name of the task step the output variable belongs to.
    OutputVariableName string
    The name of the output variable whose value has to be mapped.
    StepName string
    The name of the task step the output variable belongs to.
    outputVariableName String
    The name of the output variable whose value has to be mapped.
    stepName String
    The name of the task step the output variable belongs to.
    outputVariableName string
    The name of the output variable whose value has to be mapped.
    stepName string
    The name of the task step the output variable belongs to.
    output_variable_name str
    The name of the output variable whose value has to be mapped.
    step_name str
    The name of the task step the output variable belongs to.
    outputVariableName String
    The name of the output variable whose value has to be mapped.
    stepName String
    The name of the task step the output variable belongs to.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskStepProperty

    ActionOnFailure string
    The action to be taken in case of a failure.
    NotificationPreferences List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyNotificationPreference>
    Preferences to send notifications on the task activities.
    PauseDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyPauseDetail>
    Pause Details
    PreCondition string
    Build control flow conditions that determine the relevance of the task execution.
    RunOns List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOn>
    The runon conditions
    ActionOnFailure string
    The action to be taken in case of a failure.
    NotificationPreferences []GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyNotificationPreference
    Preferences to send notifications on the task activities.
    PauseDetails []GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyPauseDetail
    Pause Details
    PreCondition string
    Build control flow conditions that determine the relevance of the task execution.
    RunOns []GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOn
    The runon conditions
    actionOnFailure String
    The action to be taken in case of a failure.
    notificationPreferences List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyNotificationPreference>
    Preferences to send notifications on the task activities.
    pauseDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyPauseDetail>
    Pause Details
    preCondition String
    Build control flow conditions that determine the relevance of the task execution.
    runOns List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOn>
    The runon conditions
    actionOnFailure string
    The action to be taken in case of a failure.
    notificationPreferences GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyNotificationPreference[]
    Preferences to send notifications on the task activities.
    pauseDetails GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyPauseDetail[]
    Pause Details
    preCondition string
    Build control flow conditions that determine the relevance of the task execution.
    runOns GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOn[]
    The runon conditions
    action_on_failure str
    The action to be taken in case of a failure.
    notification_preferences Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyNotificationPreference]
    Preferences to send notifications on the task activities.
    pause_details Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyPauseDetail]
    Pause Details
    pre_condition str
    Build control flow conditions that determine the relevance of the task execution.
    run_ons Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOn]
    The runon conditions
    actionOnFailure String
    The action to be taken in case of a failure.
    notificationPreferences List<Property Map>
    Preferences to send notifications on the task activities.
    pauseDetails List<Property Map>
    Pause Details
    preCondition String
    Build control flow conditions that determine the relevance of the task execution.
    runOns List<Property Map>
    The runon conditions

    GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyNotificationPreference

    ShouldNotifyOnPause bool
    Enables notification on pause.
    ShouldNotifyOnTaskFailure bool
    Enables or disables notification on Task Failures.
    ShouldNotifyOnTaskSuccess bool
    Enables or disables notification on Task Success.
    ShouldNotifyOnPause bool
    Enables notification on pause.
    ShouldNotifyOnTaskFailure bool
    Enables or disables notification on Task Failures.
    ShouldNotifyOnTaskSuccess bool
    Enables or disables notification on Task Success.
    shouldNotifyOnPause Boolean
    Enables notification on pause.
    shouldNotifyOnTaskFailure Boolean
    Enables or disables notification on Task Failures.
    shouldNotifyOnTaskSuccess Boolean
    Enables or disables notification on Task Success.
    shouldNotifyOnPause boolean
    Enables notification on pause.
    shouldNotifyOnTaskFailure boolean
    Enables or disables notification on Task Failures.
    shouldNotifyOnTaskSuccess boolean
    Enables or disables notification on Task Success.
    should_notify_on_pause bool
    Enables notification on pause.
    should_notify_on_task_failure bool
    Enables or disables notification on Task Failures.
    should_notify_on_task_success bool
    Enables or disables notification on Task Success.
    shouldNotifyOnPause Boolean
    Enables notification on pause.
    shouldNotifyOnTaskFailure Boolean
    Enables or disables notification on Task Failures.
    shouldNotifyOnTaskSuccess Boolean
    Enables or disables notification on Task Success.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyPauseDetail

    DurationInMinutes int
    Time in minutes to apply Pause.
    Kind string
    Run on based On.
    DurationInMinutes int
    Time in minutes to apply Pause.
    Kind string
    Run on based On.
    durationInMinutes Integer
    Time in minutes to apply Pause.
    kind String
    Run on based On.
    durationInMinutes number
    Time in minutes to apply Pause.
    kind string
    Run on based On.
    duration_in_minutes int
    Time in minutes to apply Pause.
    kind str
    Run on based On.
    durationInMinutes Number
    Time in minutes to apply Pause.
    kind String
    Run on based On.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOn

    Condition string
    Build control flow conditions that determine the relevance of the task execution.
    Host string
    OCID of the self hosted instance.
    Kind string
    Run on based On.
    PreviousTaskInstanceDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail>
    Previous Task Instance Details
    Condition string
    Build control flow conditions that determine the relevance of the task execution.
    Host string
    OCID of the self hosted instance.
    Kind string
    Run on based On.
    PreviousTaskInstanceDetails []GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail
    Previous Task Instance Details
    condition String
    Build control flow conditions that determine the relevance of the task execution.
    host String
    OCID of the self hosted instance.
    kind String
    Run on based On.
    previousTaskInstanceDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail>
    Previous Task Instance Details
    condition string
    Build control flow conditions that determine the relevance of the task execution.
    host string
    OCID of the self hosted instance.
    kind string
    Run on based On.
    previousTaskInstanceDetails GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail[]
    Previous Task Instance Details
    condition str
    Build control flow conditions that determine the relevance of the task execution.
    host str
    OCID of the self hosted instance.
    kind str
    Run on based On.
    previous_task_instance_details Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail]
    Previous Task Instance Details
    condition String
    Build control flow conditions that determine the relevance of the task execution.
    host String
    OCID of the self hosted instance.
    kind String
    Run on based On.
    previousTaskInstanceDetails List<Property Map>
    Previous Task Instance Details

    GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail

    OutputVariableDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail>
    The details of the output variable that will be used for mapping.
    ResourceId string
    Resource Ocid.
    ResourceType string
    Resource Type.
    OutputVariableDetails []GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail
    The details of the output variable that will be used for mapping.
    ResourceId string
    Resource Ocid.
    ResourceType string
    Resource Type.
    outputVariableDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail>
    The details of the output variable that will be used for mapping.
    resourceId String
    Resource Ocid.
    resourceType String
    Resource Type.
    outputVariableDetails GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]
    The details of the output variable that will be used for mapping.
    resourceId string
    Resource Ocid.
    resourceType string
    Resource Type.
    outputVariableDetails List<Property Map>
    The details of the output variable that will be used for mapping.
    resourceId String
    Resource Ocid.
    resourceType String
    Resource Type.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail

    OutputVariableName string
    The name of the output variable whose value has to be mapped.
    StepName string
    The name of the task step the output variable belongs to.
    OutputVariableName string
    The name of the output variable whose value has to be mapped.
    StepName string
    The name of the task step the output variable belongs to.
    outputVariableName String
    The name of the output variable whose value has to be mapped.
    stepName String
    The name of the task step the output variable belongs to.
    outputVariableName string
    The name of the output variable whose value has to be mapped.
    stepName string
    The name of the task step the output variable belongs to.
    output_variable_name str
    The name of the output variable whose value has to be mapped.
    step_name str
    The name of the task step the output variable belongs to.
    outputVariableName String
    The name of the output variable whose value has to be mapped.
    stepName String
    The name of the task step the output variable belongs to.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetail

    Description string
    The description of the argument.
    ExecutionDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetail>
    Execution details.
    IsApplySubjectTask bool
    Is this an Apply Subject Task? Ex. Patch Execution Task
    IsCopyToLibraryEnabled bool
    Make a copy of this task in Library
    IsDiscoveryOutputTask bool
    Is this a discovery output task?
    Name string
    The name of the task
    OsType string
    The OS for the task.
    Platform string
    A filter to return runbooks whose platform matches the given platform.
    Properties List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailProperty>
    The properties of the task.
    Scope string
    The scope of the task.
    TaskRecordId string
    The ID of taskRecord.
    Description string
    The description of the argument.
    ExecutionDetails []GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetail
    Execution details.
    IsApplySubjectTask bool
    Is this an Apply Subject Task? Ex. Patch Execution Task
    IsCopyToLibraryEnabled bool
    Make a copy of this task in Library
    IsDiscoveryOutputTask bool
    Is this a discovery output task?
    Name string
    The name of the task
    OsType string
    The OS for the task.
    Platform string
    A filter to return runbooks whose platform matches the given platform.
    Properties []GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailProperty
    The properties of the task.
    Scope string
    The scope of the task.
    TaskRecordId string
    The ID of taskRecord.
    description String
    The description of the argument.
    executionDetails List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetail>
    Execution details.
    isApplySubjectTask Boolean
    Is this an Apply Subject Task? Ex. Patch Execution Task
    isCopyToLibraryEnabled Boolean
    Make a copy of this task in Library
    isDiscoveryOutputTask Boolean
    Is this a discovery output task?
    name String
    The name of the task
    osType String
    The OS for the task.
    platform String
    A filter to return runbooks whose platform matches the given platform.
    properties List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailProperty>
    The properties of the task.
    scope String
    The scope of the task.
    taskRecordId String
    The ID of taskRecord.
    description string
    The description of the argument.
    executionDetails GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetail[]
    Execution details.
    isApplySubjectTask boolean
    Is this an Apply Subject Task? Ex. Patch Execution Task
    isCopyToLibraryEnabled boolean
    Make a copy of this task in Library
    isDiscoveryOutputTask boolean
    Is this a discovery output task?
    name string
    The name of the task
    osType string
    The OS for the task.
    platform string
    A filter to return runbooks whose platform matches the given platform.
    properties GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailProperty[]
    The properties of the task.
    scope string
    The scope of the task.
    taskRecordId string
    The ID of taskRecord.
    description str
    The description of the argument.
    execution_details Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetail]
    Execution details.
    is_apply_subject_task bool
    Is this an Apply Subject Task? Ex. Patch Execution Task
    is_copy_to_library_enabled bool
    Make a copy of this task in Library
    is_discovery_output_task bool
    Is this a discovery output task?
    name str
    The name of the task
    os_type str
    The OS for the task.
    platform str
    A filter to return runbooks whose platform matches the given platform.
    properties Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailProperty]
    The properties of the task.
    scope str
    The scope of the task.
    task_record_id str
    The ID of taskRecord.
    description String
    The description of the argument.
    executionDetails List<Property Map>
    Execution details.
    isApplySubjectTask Boolean
    Is this an Apply Subject Task? Ex. Patch Execution Task
    isCopyToLibraryEnabled Boolean
    Make a copy of this task in Library
    isDiscoveryOutputTask Boolean
    Is this a discovery output task?
    name String
    The name of the task
    osType String
    The OS for the task.
    platform String
    A filter to return runbooks whose platform matches the given platform.
    properties List<Property Map>
    The properties of the task.
    scope String
    The scope of the task.
    taskRecordId String
    The ID of taskRecord.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetail

    CatalogId string
    Command string
    Optional command to execute the content. You can provide any commands/arguments that can't be part of the script.
    ConfigFile string
    Catalog Id having config file.
    Contents List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailContent>
    Content Source details.
    Credentials List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailCredential>
    Credentials required for executing the task.
    Endpoint string
    Endpoint to be invoked.
    ExecutionType string
    The action type of the task
    IsExecutableContent bool
    Is the Content an executable file?
    IsLocked bool
    Is the script locked to prevent changes directly in Object Storage?
    IsReadOutputVariableEnabled bool
    Is read output variable enabled
    TargetCompartmentId string
    OCID of the compartment to which the resource belongs to.
    Variables List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariable>
    The variable of the task. At least one of the dynamicArguments or output needs to be provided.
    CatalogId string
    Command string
    Optional command to execute the content. You can provide any commands/arguments that can't be part of the script.
    ConfigFile string
    Catalog Id having config file.
    Contents []GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailContent
    Content Source details.
    Credentials []GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailCredential
    Credentials required for executing the task.
    Endpoint string
    Endpoint to be invoked.
    ExecutionType string
    The action type of the task
    IsExecutableContent bool
    Is the Content an executable file?
    IsLocked bool
    Is the script locked to prevent changes directly in Object Storage?
    IsReadOutputVariableEnabled bool
    Is read output variable enabled
    TargetCompartmentId string
    OCID of the compartment to which the resource belongs to.
    Variables []GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariable
    The variable of the task. At least one of the dynamicArguments or output needs to be provided.
    catalogId String
    command String
    Optional command to execute the content. You can provide any commands/arguments that can't be part of the script.
    configFile String
    Catalog Id having config file.
    contents List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailContent>
    Content Source details.
    credentials List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailCredential>
    Credentials required for executing the task.
    endpoint String
    Endpoint to be invoked.
    executionType String
    The action type of the task
    isExecutableContent Boolean
    Is the Content an executable file?
    isLocked Boolean
    Is the script locked to prevent changes directly in Object Storage?
    isReadOutputVariableEnabled Boolean
    Is read output variable enabled
    targetCompartmentId String
    OCID of the compartment to which the resource belongs to.
    variables List<GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariable>
    The variable of the task. At least one of the dynamicArguments or output needs to be provided.
    catalogId string
    command string
    Optional command to execute the content. You can provide any commands/arguments that can't be part of the script.
    configFile string
    Catalog Id having config file.
    contents GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailContent[]
    Content Source details.
    credentials GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailCredential[]
    Credentials required for executing the task.
    endpoint string
    Endpoint to be invoked.
    executionType string
    The action type of the task
    isExecutableContent boolean
    Is the Content an executable file?
    isLocked boolean
    Is the script locked to prevent changes directly in Object Storage?
    isReadOutputVariableEnabled boolean
    Is read output variable enabled
    targetCompartmentId string
    OCID of the compartment to which the resource belongs to.
    variables GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariable[]
    The variable of the task. At least one of the dynamicArguments or output needs to be provided.
    catalog_id str
    command str
    Optional command to execute the content. You can provide any commands/arguments that can't be part of the script.
    config_file str
    Catalog Id having config file.
    contents Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailContent]
    Content Source details.
    credentials Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailCredential]
    Credentials required for executing the task.
    endpoint str
    Endpoint to be invoked.
    execution_type str
    The action type of the task
    is_executable_content bool
    Is the Content an executable file?
    is_locked bool
    Is the script locked to prevent changes directly in Object Storage?
    is_read_output_variable_enabled bool
    Is read output variable enabled
    target_compartment_id str
    OCID of the compartment to which the resource belongs to.
    variables Sequence[GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariable]
    The variable of the task. At least one of the dynamicArguments or output needs to be provided.
    catalogId String
    command String
    Optional command to execute the content. You can provide any commands/arguments that can't be part of the script.
    configFile String
    Catalog Id having config file.
    contents List<Property Map>
    Content Source details.
    credentials List<Property Map>
    Credentials required for executing the task.
    endpoint String
    Endpoint to be invoked.
    executionType String
    The action type of the task
    isExecutableContent Boolean
    Is the Content an executable file?
    isLocked Boolean
    Is the script locked to prevent changes directly in Object Storage?
    isReadOutputVariableEnabled Boolean
    Is read output variable enabled
    targetCompartmentId String
    OCID of the compartment to which the resource belongs to.
    variables List<Property Map>
    The variable of the task. At least one of the dynamicArguments or output needs to be provided.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailContent

    Bucket string
    Bucket Name.
    CatalogId string
    Checksum string
    md5 checksum of the artifact.
    Namespace string
    Namespace.
    Object string
    Object Name.
    SourceType string
    Content Source type details.
    Bucket string
    Bucket Name.
    CatalogId string
    Checksum string
    md5 checksum of the artifact.
    Namespace string
    Namespace.
    Object string
    Object Name.
    SourceType string
    Content Source type details.
    bucket String
    Bucket Name.
    catalogId String
    checksum String
    md5 checksum of the artifact.
    namespace String
    Namespace.
    object String
    Object Name.
    sourceType String
    Content Source type details.
    bucket string
    Bucket Name.
    catalogId string
    checksum string
    md5 checksum of the artifact.
    namespace string
    Namespace.
    object string
    Object Name.
    sourceType string
    Content Source type details.
    bucket str
    Bucket Name.
    catalog_id str
    checksum str
    md5 checksum of the artifact.
    namespace str
    Namespace.
    object str
    Object Name.
    source_type str
    Content Source type details.
    bucket String
    Bucket Name.
    catalogId String
    checksum String
    md5 checksum of the artifact.
    namespace String
    Namespace.
    object String
    Object Name.
    sourceType String
    Content Source type details.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailCredential

    DisplayName string
    A filter to return only resources that match the entire display name given.
    Id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    displayName String
    A filter to return only resources that match the entire display name given.
    id String
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    displayName string
    A filter to return only resources that match the entire display name given.
    id string
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    display_name str
    A filter to return only resources that match the entire display name given.
    id str
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.
    displayName String
    A filter to return only resources that match the entire display name given.
    id String
    Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariable

    inputVariables List<Property Map>
    The input variables for the task.
    outputVariables List<String>
    The list of output variables.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariableInputVariable

    Description string
    The description of the argument.
    Name string
    The name of the task
    Type string
    A filter to return runbooks whose type matches the given type.
    Description string
    The description of the argument.
    Name string
    The name of the task
    Type string
    A filter to return runbooks whose type matches the given type.
    description String
    The description of the argument.
    name String
    The name of the task
    type String
    A filter to return runbooks whose type matches the given type.
    description string
    The description of the argument.
    name string
    The name of the task
    type string
    A filter to return runbooks whose type matches the given type.
    description str
    The description of the argument.
    name str
    The name of the task
    type str
    A filter to return runbooks whose type matches the given type.
    description String
    The description of the argument.
    name String
    The name of the task
    type String
    A filter to return runbooks whose type matches the given type.

    GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailProperty

    NumRetries int
    The number of retries allowed.
    TimeoutInSeconds int
    The timeout in seconds for the task.
    NumRetries int
    The number of retries allowed.
    TimeoutInSeconds int
    The timeout in seconds for the task.
    numRetries Integer
    The number of retries allowed.
    timeoutInSeconds Integer
    The timeout in seconds for the task.
    numRetries number
    The number of retries allowed.
    timeoutInSeconds number
    The timeout in seconds for the task.
    num_retries int
    The number of retries allowed.
    timeout_in_seconds int
    The timeout in seconds for the task.
    numRetries Number
    The number of retries allowed.
    timeoutInSeconds Number
    The timeout in seconds for the task.

    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.3.0 published on Thursday, Jul 17, 2025 by Pulumi
    pulumi/pulumi-oci