1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getInstanceMaintenanceEvent
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Core.getInstanceMaintenanceEvent

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This data source provides details about a specific Instance Maintenance Event resource in Oracle Cloud Infrastructure Core service.

    Gets the maintenance event for the given instance.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testInstanceMaintenanceEvent = oci.Core.getInstanceMaintenanceEvent({
        instanceMaintenanceEventId: testInstanceMaintenanceEventOciCoreInstanceMaintenanceEvent.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_instance_maintenance_event = oci.Core.get_instance_maintenance_event(instance_maintenance_event_id=test_instance_maintenance_event_oci_core_instance_maintenance_event["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.GetInstanceMaintenanceEvent(ctx, &core.GetInstanceMaintenanceEventArgs{
    			InstanceMaintenanceEventId: testInstanceMaintenanceEventOciCoreInstanceMaintenanceEvent.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testInstanceMaintenanceEvent = Oci.Core.GetInstanceMaintenanceEvent.Invoke(new()
        {
            InstanceMaintenanceEventId = testInstanceMaintenanceEventOciCoreInstanceMaintenanceEvent.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.CoreFunctions;
    import com.pulumi.oci.Core.inputs.GetInstanceMaintenanceEventArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testInstanceMaintenanceEvent = CoreFunctions.getInstanceMaintenanceEvent(GetInstanceMaintenanceEventArgs.builder()
                .instanceMaintenanceEventId(testInstanceMaintenanceEventOciCoreInstanceMaintenanceEvent.id())
                .build());
    
        }
    }
    
    variables:
      testInstanceMaintenanceEvent:
        fn::invoke:
          Function: oci:Core:getInstanceMaintenanceEvent
          Arguments:
            instanceMaintenanceEventId: ${testInstanceMaintenanceEventOciCoreInstanceMaintenanceEvent.id}
    

    Using getInstanceMaintenanceEvent

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

    function getInstanceMaintenanceEvent(args: GetInstanceMaintenanceEventArgs, opts?: InvokeOptions): Promise<GetInstanceMaintenanceEventResult>
    function getInstanceMaintenanceEventOutput(args: GetInstanceMaintenanceEventOutputArgs, opts?: InvokeOptions): Output<GetInstanceMaintenanceEventResult>
    def get_instance_maintenance_event(instance_maintenance_event_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetInstanceMaintenanceEventResult
    def get_instance_maintenance_event_output(instance_maintenance_event_id: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetInstanceMaintenanceEventResult]
    func GetInstanceMaintenanceEvent(ctx *Context, args *GetInstanceMaintenanceEventArgs, opts ...InvokeOption) (*GetInstanceMaintenanceEventResult, error)
    func GetInstanceMaintenanceEventOutput(ctx *Context, args *GetInstanceMaintenanceEventOutputArgs, opts ...InvokeOption) GetInstanceMaintenanceEventResultOutput

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

    public static class GetInstanceMaintenanceEvent 
    {
        public static Task<GetInstanceMaintenanceEventResult> InvokeAsync(GetInstanceMaintenanceEventArgs args, InvokeOptions? opts = null)
        public static Output<GetInstanceMaintenanceEventResult> Invoke(GetInstanceMaintenanceEventInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInstanceMaintenanceEventResult> getInstanceMaintenanceEvent(GetInstanceMaintenanceEventArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Core/getInstanceMaintenanceEvent:getInstanceMaintenanceEvent
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    InstanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    instanceMaintenanceEventId String
    The OCID of the instance maintenance event.
    instanceMaintenanceEventId string
    The OCID of the instance maintenance event.
    instance_maintenance_event_id str
    The OCID of the instance maintenance event.
    instanceMaintenanceEventId String
    The OCID of the instance maintenance event.

    getInstanceMaintenanceEvent Result

    The following output properties are available:

    AdditionalDetails Dictionary<string, string>
    Additional details of the maintenance in the form of json.
    AlternativeResolutionAction string
    AlternativeResolutionActions List<string>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    CanDeleteLocalStorage bool
    For Instances that have local storage, this field is set to true when local storage will be deleted as a result of 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.
    DefinedTags Dictionary<string, string>
    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
    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>
    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"}
    Id string
    The OCID of the maintenance event.
    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
    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
    The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.
    AdditionalDetails map[string]string
    Additional details of the maintenance in the form of json.
    AlternativeResolutionAction string
    AlternativeResolutionActions []string
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    CanDeleteLocalStorage bool
    For Instances that have local storage, this field is set to true when local storage will be deleted as a result of 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.
    DefinedTags map[string]string
    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
    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
    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"}
    Id string
    The OCID of the maintenance event.
    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
    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
    The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.
    additionalDetails Map<String,String>
    Additional details of the maintenance in the form of json.
    alternativeResolutionAction String
    alternativeResolutionActions List<String>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canDeleteLocalStorage Boolean
    For Instances that have local storage, this field is set to true when local storage will be deleted as a result of 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.
    definedTags Map<String,String>
    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
    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>
    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"}
    id String
    The OCID of the maintenance event.
    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
    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
    The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.
    additionalDetails {[key: string]: string}
    Additional details of the maintenance in the form of json.
    alternativeResolutionAction string
    alternativeResolutionActions string[]
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canDeleteLocalStorage boolean
    For Instances that have local storage, this field is set to true when local storage will be deleted as a result of 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.
    definedTags {[key: string]: string}
    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
    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}
    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"}
    id string
    The OCID of the maintenance event.
    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
    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
    The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.
    additional_details Mapping[str, str]
    Additional details of the maintenance in the form of json.
    alternative_resolution_action str
    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
    For Instances that have local storage, this field is set to true when local storage will be deleted as a result of 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.
    defined_tags Mapping[str, str]
    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
    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]
    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"}
    id str
    The OCID of the maintenance event.
    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
    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
    The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.
    additionalDetails Map<String>
    Additional details of the maintenance in the form of json.
    alternativeResolutionAction String
    alternativeResolutionActions List<String>
    These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
    canDeleteLocalStorage Boolean
    For Instances that have local storage, this field is set to true when local storage will be deleted as a result of 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.
    definedTags Map<String>
    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
    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>
    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"}
    id String
    The OCID of the maintenance event.
    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
    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
    The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

    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.17.0 published on Friday, Nov 15, 2024 by Pulumi