oci.StackMonitoring.MaintenanceWindow
Explore with Pulumi AI
This resource provides the Maintenance Window resource in Oracle Cloud Infrastructure Stack Monitoring service.
Creates a new Maintenance Window for the given resources. It will create also the Alarms Suppression for each alarm that the resource migth trigger.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testMaintenanceWindow = new oci.stackmonitoring.MaintenanceWindow("test_maintenance_window", {
    compartmentId: compartmentId,
    name: maintenanceWindowName,
    resources: [{
        resourceId: testResource.id,
        areMembersIncluded: maintenanceWindowResourcesAreMembersIncluded,
    }],
    schedule: {
        scheduleType: maintenanceWindowScheduleScheduleType,
        maintenanceWindowDuration: maintenanceWindowScheduleMaintenanceWindowDuration,
        maintenanceWindowRecurrences: maintenanceWindowScheduleMaintenanceWindowRecurrences,
        timeMaintenanceWindowEnd: maintenanceWindowScheduleTimeMaintenanceWindowEnd,
        timeMaintenanceWindowStart: maintenanceWindowScheduleTimeMaintenanceWindowStart,
    },
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: maintenanceWindowDescription,
    freeformTags: {
        "bar-key": "value",
    },
});
import pulumi
import pulumi_oci as oci
test_maintenance_window = oci.stack_monitoring.MaintenanceWindow("test_maintenance_window",
    compartment_id=compartment_id,
    name=maintenance_window_name,
    resources=[{
        "resource_id": test_resource["id"],
        "are_members_included": maintenance_window_resources_are_members_included,
    }],
    schedule={
        "schedule_type": maintenance_window_schedule_schedule_type,
        "maintenance_window_duration": maintenance_window_schedule_maintenance_window_duration,
        "maintenance_window_recurrences": maintenance_window_schedule_maintenance_window_recurrences,
        "time_maintenance_window_end": maintenance_window_schedule_time_maintenance_window_end,
        "time_maintenance_window_start": maintenance_window_schedule_time_maintenance_window_start,
    },
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=maintenance_window_description,
    freeform_tags={
        "bar-key": "value",
    })
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/stackmonitoring"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stackmonitoring.NewMaintenanceWindow(ctx, "test_maintenance_window", &stackmonitoring.MaintenanceWindowArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Name:          pulumi.Any(maintenanceWindowName),
			Resources: stackmonitoring.MaintenanceWindowResourceArray{
				&stackmonitoring.MaintenanceWindowResourceArgs{
					ResourceId:         pulumi.Any(testResource.Id),
					AreMembersIncluded: pulumi.Any(maintenanceWindowResourcesAreMembersIncluded),
				},
			},
			Schedule: &stackmonitoring.MaintenanceWindowScheduleArgs{
				ScheduleType:                 pulumi.Any(maintenanceWindowScheduleScheduleType),
				MaintenanceWindowDuration:    pulumi.Any(maintenanceWindowScheduleMaintenanceWindowDuration),
				MaintenanceWindowRecurrences: pulumi.Any(maintenanceWindowScheduleMaintenanceWindowRecurrences),
				TimeMaintenanceWindowEnd:     pulumi.Any(maintenanceWindowScheduleTimeMaintenanceWindowEnd),
				TimeMaintenanceWindowStart:   pulumi.Any(maintenanceWindowScheduleTimeMaintenanceWindowStart),
			},
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(maintenanceWindowDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
		})
		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 testMaintenanceWindow = new Oci.StackMonitoring.MaintenanceWindow("test_maintenance_window", new()
    {
        CompartmentId = compartmentId,
        Name = maintenanceWindowName,
        Resources = new[]
        {
            new Oci.StackMonitoring.Inputs.MaintenanceWindowResourceArgs
            {
                ResourceId = testResource.Id,
                AreMembersIncluded = maintenanceWindowResourcesAreMembersIncluded,
            },
        },
        Schedule = new Oci.StackMonitoring.Inputs.MaintenanceWindowScheduleArgs
        {
            ScheduleType = maintenanceWindowScheduleScheduleType,
            MaintenanceWindowDuration = maintenanceWindowScheduleMaintenanceWindowDuration,
            MaintenanceWindowRecurrences = maintenanceWindowScheduleMaintenanceWindowRecurrences,
            TimeMaintenanceWindowEnd = maintenanceWindowScheduleTimeMaintenanceWindowEnd,
            TimeMaintenanceWindowStart = maintenanceWindowScheduleTimeMaintenanceWindowStart,
        },
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = maintenanceWindowDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.StackMonitoring.MaintenanceWindow;
import com.pulumi.oci.StackMonitoring.MaintenanceWindowArgs;
import com.pulumi.oci.StackMonitoring.inputs.MaintenanceWindowResourceArgs;
import com.pulumi.oci.StackMonitoring.inputs.MaintenanceWindowScheduleArgs;
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 testMaintenanceWindow = new MaintenanceWindow("testMaintenanceWindow", MaintenanceWindowArgs.builder()
            .compartmentId(compartmentId)
            .name(maintenanceWindowName)
            .resources(MaintenanceWindowResourceArgs.builder()
                .resourceId(testResource.id())
                .areMembersIncluded(maintenanceWindowResourcesAreMembersIncluded)
                .build())
            .schedule(MaintenanceWindowScheduleArgs.builder()
                .scheduleType(maintenanceWindowScheduleScheduleType)
                .maintenanceWindowDuration(maintenanceWindowScheduleMaintenanceWindowDuration)
                .maintenanceWindowRecurrences(maintenanceWindowScheduleMaintenanceWindowRecurrences)
                .timeMaintenanceWindowEnd(maintenanceWindowScheduleTimeMaintenanceWindowEnd)
                .timeMaintenanceWindowStart(maintenanceWindowScheduleTimeMaintenanceWindowStart)
                .build())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(maintenanceWindowDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .build());
    }
}
resources:
  testMaintenanceWindow:
    type: oci:StackMonitoring:MaintenanceWindow
    name: test_maintenance_window
    properties:
      compartmentId: ${compartmentId}
      name: ${maintenanceWindowName}
      resources:
        - resourceId: ${testResource.id}
          areMembersIncluded: ${maintenanceWindowResourcesAreMembersIncluded}
      schedule:
        scheduleType: ${maintenanceWindowScheduleScheduleType}
        maintenanceWindowDuration: ${maintenanceWindowScheduleMaintenanceWindowDuration}
        maintenanceWindowRecurrences: ${maintenanceWindowScheduleMaintenanceWindowRecurrences}
        timeMaintenanceWindowEnd: ${maintenanceWindowScheduleTimeMaintenanceWindowEnd}
        timeMaintenanceWindowStart: ${maintenanceWindowScheduleTimeMaintenanceWindowStart}
      definedTags:
        foo-namespace.bar-key: value
      description: ${maintenanceWindowDescription}
      freeformTags:
        bar-key: value
Create MaintenanceWindow Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MaintenanceWindow(name: string, args: MaintenanceWindowArgs, opts?: CustomResourceOptions);@overload
def MaintenanceWindow(resource_name: str,
                      args: MaintenanceWindowArgs,
                      opts: Optional[ResourceOptions] = None)
@overload
def MaintenanceWindow(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      compartment_id: Optional[str] = None,
                      resources: Optional[Sequence[MaintenanceWindowResourceArgs]] = None,
                      schedule: Optional[MaintenanceWindowScheduleArgs] = None,
                      defined_tags: Optional[Mapping[str, str]] = None,
                      description: Optional[str] = None,
                      freeform_tags: Optional[Mapping[str, str]] = None,
                      name: Optional[str] = None)func NewMaintenanceWindow(ctx *Context, name string, args MaintenanceWindowArgs, opts ...ResourceOption) (*MaintenanceWindow, error)public MaintenanceWindow(string name, MaintenanceWindowArgs args, CustomResourceOptions? opts = null)
public MaintenanceWindow(String name, MaintenanceWindowArgs args)
public MaintenanceWindow(String name, MaintenanceWindowArgs args, CustomResourceOptions options)
type: oci:StackMonitoring:MaintenanceWindow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args MaintenanceWindowArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args MaintenanceWindowArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args MaintenanceWindowArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MaintenanceWindowArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MaintenanceWindowArgs
- 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 ociMaintenanceWindowResource = new Oci.StackMonitoring.MaintenanceWindow("ociMaintenanceWindowResource", new()
{
    CompartmentId = "string",
    Resources = new[]
    {
        new Oci.StackMonitoring.Inputs.MaintenanceWindowResourceArgs
        {
            ResourceId = "string",
            AreMembersIncluded = false,
        },
    },
    Schedule = new Oci.StackMonitoring.Inputs.MaintenanceWindowScheduleArgs
    {
        ScheduleType = "string",
        MaintenanceWindowDuration = "string",
        MaintenanceWindowRecurrences = "string",
        TimeMaintenanceWindowEnd = "string",
        TimeMaintenanceWindowStart = "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Name = "string",
});
example, err := stackmonitoring.NewMaintenanceWindow(ctx, "ociMaintenanceWindowResource", &stackmonitoring.MaintenanceWindowArgs{
	CompartmentId: pulumi.String("string"),
	Resources: stackmonitoring.MaintenanceWindowResourceArray{
		&stackmonitoring.MaintenanceWindowResourceArgs{
			ResourceId:         pulumi.String("string"),
			AreMembersIncluded: pulumi.Bool(false),
		},
	},
	Schedule: &stackmonitoring.MaintenanceWindowScheduleArgs{
		ScheduleType:                 pulumi.String("string"),
		MaintenanceWindowDuration:    pulumi.String("string"),
		MaintenanceWindowRecurrences: pulumi.String("string"),
		TimeMaintenanceWindowEnd:     pulumi.String("string"),
		TimeMaintenanceWindowStart:   pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
var ociMaintenanceWindowResource = new com.pulumi.oci.StackMonitoring.MaintenanceWindow("ociMaintenanceWindowResource", com.pulumi.oci.StackMonitoring.MaintenanceWindowArgs.builder()
    .compartmentId("string")
    .resources(MaintenanceWindowResourceArgs.builder()
        .resourceId("string")
        .areMembersIncluded(false)
        .build())
    .schedule(MaintenanceWindowScheduleArgs.builder()
        .scheduleType("string")
        .maintenanceWindowDuration("string")
        .maintenanceWindowRecurrences("string")
        .timeMaintenanceWindowEnd("string")
        .timeMaintenanceWindowStart("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .name("string")
    .build());
oci_maintenance_window_resource = oci.stack_monitoring.MaintenanceWindow("ociMaintenanceWindowResource",
    compartment_id="string",
    resources=[{
        "resource_id": "string",
        "are_members_included": False,
    }],
    schedule={
        "schedule_type": "string",
        "maintenance_window_duration": "string",
        "maintenance_window_recurrences": "string",
        "time_maintenance_window_end": "string",
        "time_maintenance_window_start": "string",
    },
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    name="string")
const ociMaintenanceWindowResource = new oci.stackmonitoring.MaintenanceWindow("ociMaintenanceWindowResource", {
    compartmentId: "string",
    resources: [{
        resourceId: "string",
        areMembersIncluded: false,
    }],
    schedule: {
        scheduleType: "string",
        maintenanceWindowDuration: "string",
        maintenanceWindowRecurrences: "string",
        timeMaintenanceWindowEnd: "string",
        timeMaintenanceWindowStart: "string",
    },
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    name: "string",
});
type: oci:StackMonitoring:MaintenanceWindow
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    freeformTags:
        string: string
    name: string
    resources:
        - areMembersIncluded: false
          resourceId: string
    schedule:
        maintenanceWindowDuration: string
        maintenanceWindowRecurrences: string
        scheduleType: string
        timeMaintenanceWindowEnd: string
        timeMaintenanceWindowStart: string
MaintenanceWindow 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 MaintenanceWindow resource accepts the following input properties:
- CompartmentId string
- Compartment Identifier OCID.
- Resources
List<MaintenanceWindow Resource> 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- Schedule
MaintenanceWindow Schedule 
- (Updatable) Schedule information of the Maintenance Window
- 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) Maintenance Window description.
- 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"}
- Name string
- Maintenance Window name.
- CompartmentId string
- Compartment Identifier OCID.
- Resources
[]MaintenanceWindow Resource Args 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- Schedule
MaintenanceWindow Schedule Args 
- (Updatable) Schedule information of the Maintenance Window
- 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) Maintenance Window description.
- 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"}
- Name string
- Maintenance Window name.
- compartmentId String
- Compartment Identifier OCID.
- resources
List<MaintenanceWindow Resource> 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- schedule
MaintenanceWindow Schedule 
- (Updatable) Schedule information of the Maintenance Window
- 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) Maintenance Window description.
- 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"}
- name String
- Maintenance Window name.
- compartmentId string
- Compartment Identifier OCID.
- resources
MaintenanceWindow Resource[] 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- schedule
MaintenanceWindow Schedule 
- (Updatable) Schedule information of the Maintenance Window
- {[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) Maintenance Window description.
- {[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"}
- name string
- Maintenance Window name.
- compartment_id str
- Compartment Identifier OCID.
- resources
Sequence[MaintenanceWindow Resource Args] 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- schedule
MaintenanceWindow Schedule Args 
- (Updatable) Schedule information of the Maintenance Window
- 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) Maintenance Window description.
- 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"}
- name str
- Maintenance Window name.
- compartmentId String
- Compartment Identifier OCID.
- resources List<Property Map>
- (Updatable) List of resource Ids which are part of the Maintenance Window
- schedule Property Map
- (Updatable) Schedule information of the Maintenance Window
- 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) Maintenance Window description.
- 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"}
- name String
- Maintenance Window name.
Outputs
All input properties are implicitly available as output properties. Additionally, the MaintenanceWindow resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- Lifecycle Details of the Maintenance Window.
- ResourcesDetails List<MaintenanceWindow Resources Detail> 
- List of resource details that are part of the Maintenance Window.
- State string
- Lifecycle state of the monitored resource.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- Lifecycle Details of the Maintenance Window.
- ResourcesDetails []MaintenanceWindow Resources Detail 
- List of resource details that are part of the Maintenance Window.
- State string
- Lifecycle state of the monitored resource.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- Lifecycle Details of the Maintenance Window.
- resourcesDetails List<MaintenanceWindow Resources Detail> 
- List of resource details that are part of the Maintenance Window.
- state String
- Lifecycle state of the monitored resource.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- timeUpdated String
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails string
- Lifecycle Details of the Maintenance Window.
- resourcesDetails MaintenanceWindow Resources Detail[] 
- List of resource details that are part of the Maintenance Window.
- state string
- Lifecycle state of the monitored resource.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- timeUpdated string
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_details str
- Lifecycle Details of the Maintenance Window.
- resources_details Sequence[MaintenanceWindow Resources Detail] 
- List of resource details that are part of the Maintenance Window.
- state str
- Lifecycle state of the monitored resource.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- time_updated str
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- Lifecycle Details of the Maintenance Window.
- resourcesDetails List<Property Map>
- List of resource details that are part of the Maintenance Window.
- state String
- Lifecycle state of the monitored resource.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- timeUpdated String
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
Look up Existing MaintenanceWindow Resource
Get an existing MaintenanceWindow 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?: MaintenanceWindowState, opts?: CustomResourceOptions): MaintenanceWindow@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        name: Optional[str] = None,
        resources: Optional[Sequence[MaintenanceWindowResourceArgs]] = None,
        resources_details: Optional[Sequence[MaintenanceWindowResourcesDetailArgs]] = None,
        schedule: Optional[MaintenanceWindowScheduleArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> MaintenanceWindowfunc GetMaintenanceWindow(ctx *Context, name string, id IDInput, state *MaintenanceWindowState, opts ...ResourceOption) (*MaintenanceWindow, error)public static MaintenanceWindow Get(string name, Input<string> id, MaintenanceWindowState? state, CustomResourceOptions? opts = null)public static MaintenanceWindow get(String name, Output<String> id, MaintenanceWindowState state, CustomResourceOptions options)resources:  _:    type: oci:StackMonitoring:MaintenanceWindow    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- CompartmentId string
- Compartment Identifier OCID.
- 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) Maintenance Window description.
- 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
- Lifecycle Details of the Maintenance Window.
- Name string
- Maintenance Window name.
- Resources
List<MaintenanceWindow Resource> 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- ResourcesDetails List<MaintenanceWindow Resources Detail> 
- List of resource details that are part of the Maintenance Window.
- Schedule
MaintenanceWindow Schedule 
- (Updatable) Schedule information of the Maintenance Window
- State string
- Lifecycle state of the monitored resource.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- CompartmentId string
- Compartment Identifier OCID.
- 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) Maintenance Window description.
- 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
- Lifecycle Details of the Maintenance Window.
- Name string
- Maintenance Window name.
- Resources
[]MaintenanceWindow Resource Args 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- ResourcesDetails []MaintenanceWindow Resources Detail Args 
- List of resource details that are part of the Maintenance Window.
- Schedule
MaintenanceWindow Schedule Args 
- (Updatable) Schedule information of the Maintenance Window
- State string
- Lifecycle state of the monitored resource.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- TimeUpdated string
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- compartmentId String
- Compartment Identifier OCID.
- 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) Maintenance Window description.
- 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
- Lifecycle Details of the Maintenance Window.
- name String
- Maintenance Window name.
- resources
List<MaintenanceWindow Resource> 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- resourcesDetails List<MaintenanceWindow Resources Detail> 
- List of resource details that are part of the Maintenance Window.
- schedule
MaintenanceWindow Schedule 
- (Updatable) Schedule information of the Maintenance Window
- state String
- Lifecycle state of the monitored resource.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- timeUpdated String
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- compartmentId string
- Compartment Identifier OCID.
- {[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) Maintenance Window description.
- {[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
- Lifecycle Details of the Maintenance Window.
- name string
- Maintenance Window name.
- resources
MaintenanceWindow Resource[] 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- resourcesDetails MaintenanceWindow Resources Detail[] 
- List of resource details that are part of the Maintenance Window.
- schedule
MaintenanceWindow Schedule 
- (Updatable) Schedule information of the Maintenance Window
- state string
- Lifecycle state of the monitored resource.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- timeUpdated string
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- compartment_id str
- Compartment Identifier OCID.
- 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) Maintenance Window description.
- 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
- Lifecycle Details of the Maintenance Window.
- name str
- Maintenance Window name.
- resources
Sequence[MaintenanceWindow Resource Args] 
- (Updatable) List of resource Ids which are part of the Maintenance Window
- resources_details Sequence[MaintenanceWindow Resources Detail Args] 
- List of resource details that are part of the Maintenance Window.
- schedule
MaintenanceWindow Schedule Args 
- (Updatable) Schedule information of the Maintenance Window
- state str
- Lifecycle state of the monitored resource.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- time_updated str
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
- compartmentId String
- Compartment Identifier OCID.
- 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) Maintenance Window description.
- 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
- Lifecycle Details of the Maintenance Window.
- name String
- Maintenance Window name.
- resources List<Property Map>
- (Updatable) List of resource Ids which are part of the Maintenance Window
- resourcesDetails List<Property Map>
- List of resource details that are part of the Maintenance Window.
- schedule Property Map
- (Updatable) Schedule information of the Maintenance Window
- state String
- Lifecycle state of the monitored resource.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the the maintenance window was created. An RFC3339 formatted datetime string
- timeUpdated String
- The time the the mainteance window was updated. An RFC3339 formatted datetime string
Supporting Types
MaintenanceWindowResource, MaintenanceWindowResourceArgs      
- ResourceId string
- (Updatable) The OCID of monitored resource part of the Maintenance window.
- AreMembers boolIncluded 
- (Updatable) Flag to indicate if the members of the resource has to be include in the Maintenance Window.
- ResourceId string
- (Updatable) The OCID of monitored resource part of the Maintenance window.
- AreMembers boolIncluded 
- (Updatable) Flag to indicate if the members of the resource has to be include in the Maintenance Window.
- resourceId String
- (Updatable) The OCID of monitored resource part of the Maintenance window.
- areMembers BooleanIncluded 
- (Updatable) Flag to indicate if the members of the resource has to be include in the Maintenance Window.
- resourceId string
- (Updatable) The OCID of monitored resource part of the Maintenance window.
- areMembers booleanIncluded 
- (Updatable) Flag to indicate if the members of the resource has to be include in the Maintenance Window.
- resource_id str
- (Updatable) The OCID of monitored resource part of the Maintenance window.
- are_members_ boolincluded 
- (Updatable) Flag to indicate if the members of the resource has to be include in the Maintenance Window.
- resourceId String
- (Updatable) The OCID of monitored resource part of the Maintenance window.
- areMembers BooleanIncluded 
- (Updatable) Flag to indicate if the members of the resource has to be include in the Maintenance Window.
MaintenanceWindowResourcesDetail, MaintenanceWindowResourcesDetailArgs        
- Name string
- Maintenance Window name.
- NumberOf intMembers 
- Number of members of the resource
- ResourceId string
- The OCID of monitored resource part of the Maintenance window.
- Type string
- Type of the monitored resource
- Name string
- Maintenance Window name.
- NumberOf intMembers 
- Number of members of the resource
- ResourceId string
- The OCID of monitored resource part of the Maintenance window.
- Type string
- Type of the monitored resource
- name String
- Maintenance Window name.
- numberOf IntegerMembers 
- Number of members of the resource
- resourceId String
- The OCID of monitored resource part of the Maintenance window.
- type String
- Type of the monitored resource
- name string
- Maintenance Window name.
- numberOf numberMembers 
- Number of members of the resource
- resourceId string
- The OCID of monitored resource part of the Maintenance window.
- type string
- Type of the monitored resource
- name str
- Maintenance Window name.
- number_of_ intmembers 
- Number of members of the resource
- resource_id str
- The OCID of monitored resource part of the Maintenance window.
- type str
- Type of the monitored resource
- name String
- Maintenance Window name.
- numberOf NumberMembers 
- Number of members of the resource
- resourceId String
- The OCID of monitored resource part of the Maintenance window.
- type String
- Type of the monitored resource
MaintenanceWindowSchedule, MaintenanceWindowScheduleArgs      
- ScheduleType string
- (Updatable) Property to identify the type of the Maintenance Window.
- MaintenanceWindow stringDuration 
- (Updatable) Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format.
- MaintenanceWindow stringRecurrences 
- (Updatable) A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after timeMaintenanceWindowStartvalue. BYMINUTE: Specifies the start minute of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 BYSECOND: Specifies the start second of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 Other Rules are not supported.
- TimeMaintenance stringWindow End 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string
- TimeMaintenance stringWindow Start 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string - ** 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 
- ScheduleType string
- (Updatable) Property to identify the type of the Maintenance Window.
- MaintenanceWindow stringDuration 
- (Updatable) Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format.
- MaintenanceWindow stringRecurrences 
- (Updatable) A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after timeMaintenanceWindowStartvalue. BYMINUTE: Specifies the start minute of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 BYSECOND: Specifies the start second of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 Other Rules are not supported.
- TimeMaintenance stringWindow End 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string
- TimeMaintenance stringWindow Start 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string - ** 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 
- scheduleType String
- (Updatable) Property to identify the type of the Maintenance Window.
- maintenanceWindow StringDuration 
- (Updatable) Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format.
- maintenanceWindow StringRecurrences 
- (Updatable) A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after timeMaintenanceWindowStartvalue. BYMINUTE: Specifies the start minute of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 BYSECOND: Specifies the start second of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 Other Rules are not supported.
- timeMaintenance StringWindow End 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string
- timeMaintenance StringWindow Start 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string - ** 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 
- scheduleType string
- (Updatable) Property to identify the type of the Maintenance Window.
- maintenanceWindow stringDuration 
- (Updatable) Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format.
- maintenanceWindow stringRecurrences 
- (Updatable) A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after timeMaintenanceWindowStartvalue. BYMINUTE: Specifies the start minute of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 BYSECOND: Specifies the start second of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 Other Rules are not supported.
- timeMaintenance stringWindow End 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string
- timeMaintenance stringWindow Start 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string - ** 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 
- schedule_type str
- (Updatable) Property to identify the type of the Maintenance Window.
- maintenance_window_ strduration 
- (Updatable) Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format.
- maintenance_window_ strrecurrences 
- (Updatable) A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after timeMaintenanceWindowStartvalue. BYMINUTE: Specifies the start minute of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 BYSECOND: Specifies the start second of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 Other Rules are not supported.
- time_maintenance_ strwindow_ end 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string
- time_maintenance_ strwindow_ start 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string - ** 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 
- scheduleType String
- (Updatable) Property to identify the type of the Maintenance Window.
- maintenanceWindow StringDuration 
- (Updatable) Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format.
- maintenanceWindow StringRecurrences 
- (Updatable) A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after timeMaintenanceWindowStartvalue. BYMINUTE: Specifies the start minute of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 BYSECOND: Specifies the start second of each reccurrence aftertimeMaintenanceWindowStartvalue. The default value is 00 Other Rules are not supported.
- timeMaintenance StringWindow End 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string
- timeMaintenance StringWindow Start 
- (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string - ** 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 
Import
MaintenanceWindows can be imported using the id, e.g.
$ pulumi import oci:StackMonitoring/maintenanceWindow:MaintenanceWindow test_maintenance_window "id"
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 ociTerraform Provider.