Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
oci.Core.InstanceMaintenanceEvent
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The InstanceMaintenanceEvent resource accepts the following input properties:
- Instance
Maintenance stringEvent Id - The OCID of the instance maintenance event.
- Alternative
Resolution stringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- Can
Delete boolLocal Storage (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.
- 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"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"} - Time
Window stringStart (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 stringEvent Id - The OCID of the instance maintenance event.
- Alternative
Resolution stringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- Can
Delete boolLocal Storage (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.
- 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"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"} - Time
Window stringStart (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 StringEvent Id - The OCID of the instance maintenance event.
- alternative
Resolution StringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- can
Delete BooleanLocal Storage (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.
- 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"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"} - time
Window StringStart (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 stringEvent Id - The OCID of the instance maintenance event.
- alternative
Resolution stringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- can
Delete booleanLocal Storage (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.
- {[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"} - display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[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"} - time
Window stringStart (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_ strevent_ id - The OCID of the instance maintenance event.
- alternative_
resolution_ straction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- can_
delete_ boollocal_ storage (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.
- 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.
- 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_ strstart (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 StringEvent Id - The OCID of the instance maintenance event.
- alternative
Resolution StringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- can
Delete BooleanLocal Storage (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.
- 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"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"} - time
Window StringStart (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:
- Additional
Details Dictionary<string, string> - Additional details of the maintenance in the form of json.
- Alternative
Resolution List<string>Actions - 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 string - The OCID of the compartment that contains the instance.
- Correlation
Token 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.
- Created
By string - The creator of the maintenance event.
- Description string
- It is the descriptive information about the maintenance taking place on the customer instance.
- Estimated
Duration 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.
- Instance
Action string - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- Instance
Id string - The OCID of the instance.
- Maintenance
Category 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.
- Maintenance
Reason string - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- Start
Window stringDuration - The duration of the time window Maintenance is scheduled to begin within.
- State string
- The current state of the maintenance event.
- Time
Created string - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Time
Finished string - The time at which the Maintenance actually finished.
- Time
Hard stringDue Date - 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 string - The time at which the Maintenance actually started.
- Additional
Details map[string]string - Additional details of the maintenance in the form of json.
- Alternative
Resolution []stringActions - 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 string - The OCID of the compartment that contains the instance.
- Correlation
Token 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.
- Created
By string - The creator of the maintenance event.
- Description string
- It is the descriptive information about the maintenance taking place on the customer instance.
- Estimated
Duration 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.
- Instance
Action string - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- Instance
Id string - The OCID of the instance.
- Maintenance
Category 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.
- Maintenance
Reason string - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- Start
Window stringDuration - The duration of the time window Maintenance is scheduled to begin within.
- State string
- The current state of the maintenance event.
- Time
Created string - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Time
Finished string - The time at which the Maintenance actually finished.
- Time
Hard stringDue Date - 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 string - The time at which the Maintenance actually started.
- additional
Details Map<String,String> - Additional details of the maintenance in the form of json.
- alternative
Resolution List<String>Actions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- can
Reschedule Boolean - Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
- compartment
Id String - The OCID of the compartment that contains the instance.
- correlation
Token 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.
- created
By String - The creator of the maintenance event.
- description String
- It is the descriptive information about the maintenance taking place on the customer instance.
- estimated
Duration 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.
- instance
Action String - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- instance
Id String - The OCID of the instance.
- maintenance
Category 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.
- maintenance
Reason String - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- start
Window StringDuration - The duration of the time window Maintenance is scheduled to begin within.
- state String
- The current state of the maintenance event.
- time
Created String - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Finished String - The time at which the Maintenance actually finished.
- time
Hard StringDue Date - 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 String - The time at which the Maintenance actually started.
- additional
Details {[key: string]: string} - Additional details of the maintenance in the form of json.
- alternative
Resolution string[]Actions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- can
Reschedule boolean - Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
- compartment
Id string - The OCID of the compartment that contains the instance.
- correlation
Token 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.
- created
By string - The creator of the maintenance event.
- description string
- It is the descriptive information about the maintenance taking place on the customer instance.
- estimated
Duration 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.
- instance
Action string - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- instance
Id string - The OCID of the instance.
- maintenance
Category 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.
- maintenance
Reason string - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- start
Window stringDuration - The duration of the time window Maintenance is scheduled to begin within.
- state string
- The current state of the maintenance event.
- time
Created string - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Finished string - The time at which the Maintenance actually finished.
- time
Hard stringDue Date - 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 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_ Sequence[str]actions - 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_ strduration - 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_ strdue_ date - 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.
- additional
Details Map<String> - Additional details of the maintenance in the form of json.
- alternative
Resolution List<String>Actions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- can
Reschedule Boolean - Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
- compartment
Id String - The OCID of the compartment that contains the instance.
- correlation
Token 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.
- created
By String - The creator of the maintenance event.
- description String
- It is the descriptive information about the maintenance taking place on the customer instance.
- estimated
Duration 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.
- instance
Action String - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- instance
Id String - The OCID of the instance.
- maintenance
Category 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.
- maintenance
Reason String - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- start
Window StringDuration - The duration of the time window Maintenance is scheduled to begin within.
- state String
- The current state of the maintenance event.
- time
Created String - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Finished String - The time at which the Maintenance actually finished.
- time
Hard StringDue Date - 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 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) -> InstanceMaintenanceEventfunc 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)resources: _: type: oci:Core:InstanceMaintenanceEvent 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.
- Additional
Details Dictionary<string, string> - Additional details of the maintenance in the form of json.
- Alternative
Resolution stringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- Alternative
Resolution List<string>Actions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- Can
Delete boolLocal Storage (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 string - The OCID of the compartment that contains the instance.
- Correlation
Token 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.
- Created
By string - The creator of the maintenance event.
- 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.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Estimated
Duration string - This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
- 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"} - Instance
Action string - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- Instance
Id string - The OCID of the instance.
- Instance
Maintenance stringEvent Id - The OCID of the instance maintenance event.
- Maintenance
Category 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.
- Maintenance
Reason string - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- Start
Window stringDuration - The duration of the time window Maintenance is scheduled to begin within.
- State string
- The current state of the maintenance event.
- Time
Created string - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Time
Finished string - The time at which the Maintenance actually finished.
- Time
Hard stringDue Date - 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 string - The time at which the Maintenance actually started.
- Time
Window stringStart (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 map[string]string - Additional details of the maintenance in the form of json.
- Alternative
Resolution stringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- Alternative
Resolution []stringActions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- Can
Delete boolLocal Storage (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 string - The OCID of the compartment that contains the instance.
- Correlation
Token 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.
- Created
By string - The creator of the maintenance event.
- 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.
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Estimated
Duration string - This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
- 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"} - Instance
Action string - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- Instance
Id string - The OCID of the instance.
- Instance
Maintenance stringEvent Id - The OCID of the instance maintenance event.
- Maintenance
Category 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.
- Maintenance
Reason string - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- Start
Window stringDuration - The duration of the time window Maintenance is scheduled to begin within.
- State string
- The current state of the maintenance event.
- Time
Created string - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Time
Finished string - The time at which the Maintenance actually finished.
- Time
Hard stringDue Date - 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 string - The time at which the Maintenance actually started.
- Time
Window stringStart (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 Map<String,String> - Additional details of the maintenance in the form of json.
- alternative
Resolution StringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- alternative
Resolution List<String>Actions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- can
Delete BooleanLocal Storage (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 Boolean - Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
- compartment
Id String - The OCID of the compartment that contains the instance.
- correlation
Token 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.
- created
By String - The creator of the maintenance event.
- 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.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- estimated
Duration String - This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
- 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"} - instance
Action String - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- instance
Id String - The OCID of the instance.
- instance
Maintenance StringEvent Id - The OCID of the instance maintenance event.
- maintenance
Category 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.
- maintenance
Reason String - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- start
Window StringDuration - The duration of the time window Maintenance is scheduled to begin within.
- state String
- The current state of the maintenance event.
- time
Created String - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Finished String - The time at which the Maintenance actually finished.
- time
Hard StringDue Date - 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 String - The time at which the Maintenance actually started.
- time
Window StringStart (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 {[key: string]: string} - Additional details of the maintenance in the form of json.
- alternative
Resolution stringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- alternative
Resolution string[]Actions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- can
Delete booleanLocal Storage (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 boolean - Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
- compartment
Id string - The OCID of the compartment that contains the instance.
- correlation
Token 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.
- created
By string - The creator of the maintenance event.
- {[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.
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- estimated
Duration string - This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
- {[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"} - instance
Action string - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- instance
Id string - The OCID of the instance.
- instance
Maintenance stringEvent Id - The OCID of the instance maintenance event.
- maintenance
Category 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.
- maintenance
Reason string - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- start
Window stringDuration - The duration of the time window Maintenance is scheduled to begin within.
- state string
- The current state of the maintenance event.
- time
Created string - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Finished string - The time at which the Maintenance actually finished.
- time
Hard stringDue Date - 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 string - The time at which the Maintenance actually started.
- time
Window stringStart (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_ straction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- alternative_
resolution_ Sequence[str]actions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- can_
delete_ boollocal_ storage (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.
- 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.
- 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_ strevent_ id - 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_ strduration - 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_ strdue_ date - 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_ strstart (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 Map<String> - Additional details of the maintenance in the form of json.
- alternative
Resolution StringAction - (Updatable) One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
- alternative
Resolution List<String>Actions - These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
- can
Delete BooleanLocal Storage (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 Boolean - Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
- compartment
Id String - The OCID of the compartment that contains the instance.
- correlation
Token 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.
- created
By String - The creator of the maintenance event.
- 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.
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- estimated
Duration String - This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
- 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"} - instance
Action String - This is the action that will be performed on the Instance by Oracle Cloud Infrastructure when the Maintenance begins.
- instance
Id String - The OCID of the instance.
- instance
Maintenance StringEvent Id - The OCID of the instance maintenance event.
- maintenance
Category 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.
- maintenance
Reason String - This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.
- start
Window StringDuration - The duration of the time window Maintenance is scheduled to begin within.
- state String
- The current state of the maintenance event.
- time
Created String - The date and time the maintenance event was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Finished String - The time at which the Maintenance actually finished.
- time
Hard StringDue Date - 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 String - The time at which the Maintenance actually started.
- time
Window StringStart (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
ociTerraform Provider.
