Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. InstanceMaintenanceEvent
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Core.InstanceMaintenanceEvent

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Instance Maintenance Event resource in Oracle Cloud Infrastructure Core service.

    Updates the maintenance event for the given instance.

    Create InstanceMaintenanceEvent Resource

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

    Constructor syntax

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

@overload
def InstanceMaintenanceEvent(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             instance_maintenance_event_id: Optional[str] = None,
                             alternative_resolution_action: Optional[str] = None,
                             can_delete_local_storage: Optional[bool] = None,
                             defined_tags: Optional[Mapping[str, str]] = None,
                             display_name: Optional[str] = None,
                             freeform_tags: Optional[Mapping[str, str]] = None,
                             time_window_start: Optional[str] = None)
    func NewInstanceMaintenanceEvent(ctx *Context, name string, args InstanceMaintenanceEventArgs, opts ...ResourceOption) (*InstanceMaintenanceEvent, error)
    public InstanceMaintenanceEvent(string name, InstanceMaintenanceEventArgs args, CustomResourceOptions? opts = null)
    public InstanceMaintenanceEvent(String name, InstanceMaintenanceEventArgs args)
public InstanceMaintenanceEvent(String name, InstanceMaintenanceEventArgs args, CustomResourceOptions options)

    type: oci:Core:InstanceMaintenanceEvent
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 InstanceMaintenanceEventArgs
    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 InstanceMaintenanceEventArgs
    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 InstanceMaintenanceEventArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceMaintenanceEventArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceMaintenanceEventArgs
    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 instanceMaintenanceEventResource = new Oci.Core.InstanceMaintenanceEvent("instanceMaintenanceEventResource", new()
{
    InstanceMaintenanceEventId = "string",
    AlternativeResolutionAction = "string",
    CanDeleteLocalStorage = false,
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    TimeWindowStart = "string",
});

    example, err := Core.NewInstanceMaintenanceEvent(ctx, "instanceMaintenanceEventResource", &Core.InstanceMaintenanceEventArgs{
	InstanceMaintenanceEventId:  pulumi.String("string"),
	AlternativeResolutionAction: pulumi.String("string"),
	CanDeleteLocalStorage:       pulumi.Bool(false),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TimeWindowStart: pulumi.String("string"),
})

    var instanceMaintenanceEventResource = new InstanceMaintenanceEvent("instanceMaintenanceEventResource", InstanceMaintenanceEventArgs.builder()
    .instanceMaintenanceEventId("string")
    .alternativeResolutionAction("string")
    .canDeleteLocalStorage(false)
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .timeWindowStart("string")
    .build());

    instance_maintenance_event_resource = oci.core.InstanceMaintenanceEvent("instanceMaintenanceEventResource",
    instance_maintenance_event_id="string",
    alternative_resolution_action="string",
    can_delete_local_storage=False,
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    time_window_start="string")

    const instanceMaintenanceEventResource = new oci.core.InstanceMaintenanceEvent("instanceMaintenanceEventResource", {
    instanceMaintenanceEventId: "string",
    alternativeResolutionAction: "string",
    canDeleteLocalStorage: false,
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    timeWindowStart: "string",
});

    type: oci:Core:InstanceMaintenanceEvent
properties:
    alternativeResolutionAction: string
    canDeleteLocalStorage: false
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    instanceMaintenanceEventId: string
    timeWindowStart: string

    InstanceMaintenanceEvent Resource Properties

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

    Inputs

    The InstanceMaintenanceEvent resource accepts the following input properties:

    InstanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    AlternativeResolutionAction string
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    CanDeleteLocalStorage bool

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    TimeWindowStart string

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    InstanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    AlternativeResolutionAction string
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    CanDeleteLocalStorage bool

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    TimeWindowStart string

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    instanceMaintenanceEventId String
    The OCID of the instance maintenance event.
    alternativeResolutionAction String
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    canDeleteLocalStorage Boolean

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    timeWindowStart String

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    instanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    alternativeResolutionAction string
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    canDeleteLocalStorage boolean

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    timeWindowStart string

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    instance_maintenance_event_id str
    The OCID of the instance maintenance event.
    alternative_resolution_action str
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    can_delete_local_storage bool

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    time_window_start str

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    instanceMaintenanceEventId String
    The OCID of the instance maintenance event.
    alternativeResolutionAction String
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    canDeleteLocalStorage Boolean

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    timeWindowStart String

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    Outputs

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

    AdditionalDetails Dictionary<string, string>
    Additional details of the maintenance in the form of json.
    AlternativeResolutionActions List<string>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    CanReschedule bool
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    CompartmentId string
    The OCID of the compartment that contains the instance.
    CorrelationToken string
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    CreatedBy string
    The creator of the maintenance event.
    Description string
    It is the descriptive information about the maintenance taking place on the customer instance.
    EstimatedDuration string
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceAction string
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    InstanceId string
    The OCID of the instance.
    MaintenanceCategory string
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    MaintenanceReason string
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    StartWindowDuration string
    The duration of the time window Maintenance is scheduled to begin within.
    State string
    The current state of the maintenance event.
    TimeCreated string
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeFinished string
    The time at which the Maintenance actually finished.
    TimeHardDueDate string
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    TimeStarted string
    The time at which the Maintenance actually started.
    AdditionalDetails map[string]string
    Additional details of the maintenance in the form of json.
    AlternativeResolutionActions []string
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    CanReschedule bool
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    CompartmentId string
    The OCID of the compartment that contains the instance.
    CorrelationToken string
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    CreatedBy string
    The creator of the maintenance event.
    Description string
    It is the descriptive information about the maintenance taking place on the customer instance.
    EstimatedDuration string
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceAction string
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    InstanceId string
    The OCID of the instance.
    MaintenanceCategory string
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    MaintenanceReason string
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    StartWindowDuration string
    The duration of the time window Maintenance is scheduled to begin within.
    State string
    The current state of the maintenance event.
    TimeCreated string
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeFinished string
    The time at which the Maintenance actually finished.
    TimeHardDueDate string
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    TimeStarted string
    The time at which the Maintenance actually started.
    additionalDetails Map<String,String>
    Additional details of the maintenance in the form of json.
    alternativeResolutionActions List<String>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canReschedule Boolean
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    compartmentId String
    The OCID of the compartment that contains the instance.
    correlationToken String
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    createdBy String
    The creator of the maintenance event.
    description String
    It is the descriptive information about the maintenance taking place on the customer instance.
    estimatedDuration String
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceAction String
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    instanceId String
    The OCID of the instance.
    maintenanceCategory String
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    maintenanceReason String
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    startWindowDuration String
    The duration of the time window Maintenance is scheduled to begin within.
    state String
    The current state of the maintenance event.
    timeCreated String
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeFinished String
    The time at which the Maintenance actually finished.
    timeHardDueDate String
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    timeStarted String
    The time at which the Maintenance actually started.
    additionalDetails {[key: string]: string}
    Additional details of the maintenance in the form of json.
    alternativeResolutionActions string[]
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canReschedule boolean
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    compartmentId string
    The OCID of the compartment that contains the instance.
    correlationToken string
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    createdBy string
    The creator of the maintenance event.
    description string
    It is the descriptive information about the maintenance taking place on the customer instance.
    estimatedDuration string
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceAction string
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    instanceId string
    The OCID of the instance.
    maintenanceCategory string
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    maintenanceReason string
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    startWindowDuration string
    The duration of the time window Maintenance is scheduled to begin within.
    state string
    The current state of the maintenance event.
    timeCreated string
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeFinished string
    The time at which the Maintenance actually finished.
    timeHardDueDate string
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    timeStarted string
    The time at which the Maintenance actually started.
    additional_details Mapping[str, str]
    Additional details of the maintenance in the form of json.
    alternative_resolution_actions Sequence[str]
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    can_reschedule bool
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    compartment_id str
    The OCID of the compartment that contains the instance.
    correlation_token str
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    created_by str
    The creator of the maintenance event.
    description str
    It is the descriptive information about the maintenance taking place on the customer instance.
    estimated_duration str
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_action str
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    instance_id str
    The OCID of the instance.
    maintenance_category str
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    maintenance_reason str
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    start_window_duration str
    The duration of the time window Maintenance is scheduled to begin within.
    state str
    The current state of the maintenance event.
    time_created str
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_finished str
    The time at which the Maintenance actually finished.
    time_hard_due_date str
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    time_started str
    The time at which the Maintenance actually started.
    additionalDetails Map<String>
    Additional details of the maintenance in the form of json.
    alternativeResolutionActions List<String>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canReschedule Boolean
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    compartmentId String
    The OCID of the compartment that contains the instance.
    correlationToken String
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    createdBy String
    The creator of the maintenance event.
    description String
    It is the descriptive information about the maintenance taking place on the customer instance.
    estimatedDuration String
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceAction String
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    instanceId String
    The OCID of the instance.
    maintenanceCategory String
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    maintenanceReason String
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    startWindowDuration String
    The duration of the time window Maintenance is scheduled to begin within.
    state String
    The current state of the maintenance event.
    timeCreated String
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeFinished String
    The time at which the Maintenance actually finished.
    timeHardDueDate String
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    timeStarted String
    The time at which the Maintenance actually started.

    Look up Existing InstanceMaintenanceEvent Resource

    Get an existing InstanceMaintenanceEvent 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?: InstanceMaintenanceEventState, opts?: CustomResourceOptions): InstanceMaintenanceEvent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_details: Optional[Mapping[str, str]] = None,
        alternative_resolution_action: Optional[str] = None,
        alternative_resolution_actions: Optional[Sequence[str]] = None,
        can_delete_local_storage: Optional[bool] = None,
        can_reschedule: Optional[bool] = None,
        compartment_id: Optional[str] = None,
        correlation_token: Optional[str] = None,
        created_by: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        estimated_duration: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        instance_action: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_maintenance_event_id: Optional[str] = None,
        maintenance_category: Optional[str] = None,
        maintenance_reason: Optional[str] = None,
        start_window_duration: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_finished: Optional[str] = None,
        time_hard_due_date: Optional[str] = None,
        time_started: Optional[str] = None,
        time_window_start: Optional[str] = None) -> InstanceMaintenanceEvent
    func GetInstanceMaintenanceEvent(ctx *Context, name string, id IDInput, state *InstanceMaintenanceEventState, opts ...ResourceOption) (*InstanceMaintenanceEvent, error)
    public static InstanceMaintenanceEvent Get(string name, Input<string> id, InstanceMaintenanceEventState? state, CustomResourceOptions? opts = null)
    public static InstanceMaintenanceEvent get(String name, Output<String> id, InstanceMaintenanceEventState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalDetails Dictionary<string, string>
    Additional details of the maintenance in the form of json.
    AlternativeResolutionAction string
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    AlternativeResolutionActions List<string>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    CanDeleteLocalStorage bool

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    CanReschedule bool
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    CompartmentId string
    The OCID of the compartment that contains the instance.
    CorrelationToken string
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    CreatedBy string
    The creator of the maintenance event.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    It is the descriptive information about the maintenance taking place on the customer instance.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EstimatedDuration string
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    InstanceAction string
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    InstanceId string
    The OCID of the instance.
    InstanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    MaintenanceCategory string
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    MaintenanceReason string
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    StartWindowDuration string
    The duration of the time window Maintenance is scheduled to begin within.
    State string
    The current state of the maintenance event.
    TimeCreated string
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeFinished string
    The time at which the Maintenance actually finished.
    TimeHardDueDate string
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    TimeStarted string
    The time at which the Maintenance actually started.
    TimeWindowStart string

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    AdditionalDetails map[string]string
    Additional details of the maintenance in the form of json.
    AlternativeResolutionAction string
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    AlternativeResolutionActions []string
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    CanDeleteLocalStorage bool

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    CanReschedule bool
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    CompartmentId string
    The OCID of the compartment that contains the instance.
    CorrelationToken string
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    CreatedBy string
    The creator of the maintenance event.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    It is the descriptive information about the maintenance taking place on the customer instance.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EstimatedDuration string
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    InstanceAction string
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    InstanceId string
    The OCID of the instance.
    InstanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    MaintenanceCategory string
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    MaintenanceReason string
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    StartWindowDuration string
    The duration of the time window Maintenance is scheduled to begin within.
    State string
    The current state of the maintenance event.
    TimeCreated string
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeFinished string
    The time at which the Maintenance actually finished.
    TimeHardDueDate string
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    TimeStarted string
    The time at which the Maintenance actually started.
    TimeWindowStart string

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    additionalDetails Map<String,String>
    Additional details of the maintenance in the form of json.
    alternativeResolutionAction String
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    alternativeResolutionActions List<String>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canDeleteLocalStorage Boolean

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    canReschedule Boolean
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    compartmentId String
    The OCID of the compartment that contains the instance.
    correlationToken String
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    createdBy String
    The creator of the maintenance event.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    It is the descriptive information about the maintenance taking place on the customer instance.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    estimatedDuration String
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    instanceAction String
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    instanceId String
    The OCID of the instance.
    instanceMaintenanceEventId String
    The OCID of the instance maintenance event.
    maintenanceCategory String
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    maintenanceReason String
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    startWindowDuration String
    The duration of the time window Maintenance is scheduled to begin within.
    state String
    The current state of the maintenance event.
    timeCreated String
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeFinished String
    The time at which the Maintenance actually finished.
    timeHardDueDate String
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    timeStarted String
    The time at which the Maintenance actually started.
    timeWindowStart String

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    additionalDetails {[key: string]: string}
    Additional details of the maintenance in the form of json.
    alternativeResolutionAction string
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    alternativeResolutionActions string[]
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canDeleteLocalStorage boolean

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    canReschedule boolean
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    compartmentId string
    The OCID of the compartment that contains the instance.
    correlationToken string
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    createdBy string
    The creator of the maintenance event.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    It is the descriptive information about the maintenance taking place on the customer instance.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    estimatedDuration string
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    instanceAction string
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    instanceId string
    The OCID of the instance.
    instanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    maintenanceCategory string
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    maintenanceReason string
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    startWindowDuration string
    The duration of the time window Maintenance is scheduled to begin within.
    state string
    The current state of the maintenance event.
    timeCreated string
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeFinished string
    The time at which the Maintenance actually finished.
    timeHardDueDate string
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    timeStarted string
    The time at which the Maintenance actually started.
    timeWindowStart string

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    additional_details Mapping[str, str]
    Additional details of the maintenance in the form of json.
    alternative_resolution_action str
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    alternative_resolution_actions Sequence[str]
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    can_delete_local_storage bool

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    can_reschedule bool
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    compartment_id str
    The OCID of the compartment that contains the instance.
    correlation_token str
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    created_by str
    The creator of the maintenance event.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    It is the descriptive information about the maintenance taking place on the customer instance.
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    estimated_duration str
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    instance_action str
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    instance_id str
    The OCID of the instance.
    instance_maintenance_event_id str
    The OCID of the instance maintenance event.
    maintenance_category str
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    maintenance_reason str
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    start_window_duration str
    The duration of the time window Maintenance is scheduled to begin within.
    state str
    The current state of the maintenance event.
    time_created str
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_finished str
    The time at which the Maintenance actually finished.
    time_hard_due_date str
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    time_started str
    The time at which the Maintenance actually started.
    time_window_start str

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

    additionalDetails Map<String>
    Additional details of the maintenance in the form of json.
    alternativeResolutionAction String
    (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
    alternativeResolutionActions List<String>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canDeleteLocalStorage Boolean

    (Updatable) This field is only applicable when setting the alternativeResolutionAction.

    For Instances that have local storage, this must be set to true to verify that the local storage will be deleted during the migration. For instances without, this parameter has no effect.

    In cases where the local storage will be lost, this parameter must be set or the request will fail.

    canReschedule Boolean
    Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
    compartmentId String
    The OCID of the compartment that contains the instance.
    correlationToken String
    A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.
    createdBy String
    The creator of the maintenance event.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    It is the descriptive information about the maintenance taking place on the customer instance.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    estimatedDuration String
    This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    instanceAction String
    This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
    instanceId String
    The OCID of the instance.
    instanceMaintenanceEventId String
    The OCID of the instance maintenance event.
    maintenanceCategory String
    This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.
    maintenanceReason String
    This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
    startWindowDuration String
    The duration of the time window Maintenance is scheduled to begin within.
    state String
    The current state of the maintenance event.
    timeCreated String
    The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeFinished String
    The time at which the Maintenance actually finished.
    timeHardDueDate String
    It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.
    timeStarted String
    The time at which the Maintenance actually started.
    timeWindowStart String

    (Updatable) The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.

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

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

    $ pulumi import oci:Core/instanceMaintenanceEvent:InstanceMaintenanceEvent test_instance_maintenance_event "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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
    pulumi/pulumi-oci