1. Packages
  2. Volcengine
  3. API Docs
  4. rds_mysql
  5. getPlannedEvents
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.rds_mysql.getPlannedEvents

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of rds mysql planned events

    Example Usage

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

const foo = volcengine.rds_mysql.getPlannedEvents({
    instanceId: "mysql-b51d37110dd1",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rds_mysql.get_planned_events(instance_id="mysql-b51d37110dd1")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_mysql"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_mysql.GetPlannedEvents(ctx, &rds_mysql.GetPlannedEventsArgs{
			InstanceId: pulumi.StringRef("mysql-b51d37110dd1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Rds_mysql.GetPlannedEvents.Invoke(new()
    {
        InstanceId = "mysql-b51d37110dd1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_mysql.Rds_mysqlFunctions;
import com.pulumi.volcengine.rds_mysql.inputs.GetPlannedEventsArgs;
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 foo = Rds_mysqlFunctions.getPlannedEvents(GetPlannedEventsArgs.builder()
            .instanceId("mysql-b51d37110dd1")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:rds_mysql:getPlannedEvents
      Arguments:
        instanceId: mysql-b51d37110dd1

    Using getPlannedEvents

    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 getPlannedEvents(args: GetPlannedEventsArgs, opts?: InvokeOptions): Promise<GetPlannedEventsResult>
function getPlannedEventsOutput(args: GetPlannedEventsOutputArgs, opts?: InvokeOptions): Output<GetPlannedEventsResult>
    def get_planned_events(begin_time: Optional[str] = None,
                       end_time: Optional[str] = None,
                       event_id: Optional[str] = None,
                       event_types: Optional[Sequence[str]] = None,
                       instance_id: Optional[str] = None,
                       output_file: Optional[str] = None,
                       statuses: Optional[Sequence[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPlannedEventsResult
def get_planned_events_output(begin_time: Optional[pulumi.Input[str]] = None,
                       end_time: Optional[pulumi.Input[str]] = None,
                       event_id: Optional[pulumi.Input[str]] = None,
                       event_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       instance_id: Optional[pulumi.Input[str]] = None,
                       output_file: Optional[pulumi.Input[str]] = None,
                       statuses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPlannedEventsResult]
    func GetPlannedEvents(ctx *Context, args *GetPlannedEventsArgs, opts ...InvokeOption) (*GetPlannedEventsResult, error)
func GetPlannedEventsOutput(ctx *Context, args *GetPlannedEventsOutputArgs, opts ...InvokeOption) GetPlannedEventsResultOutput

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

    public static class GetPlannedEvents 
{
    public static Task<GetPlannedEventsResult> InvokeAsync(GetPlannedEventsArgs args, InvokeOptions? opts = null)
    public static Output<GetPlannedEventsResult> Invoke(GetPlannedEventsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPlannedEventsResult> getPlannedEvents(GetPlannedEventsArgs args, InvokeOptions options)
public static Output<GetPlannedEventsResult> getPlannedEvents(GetPlannedEventsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:rds_mysql/getPlannedEvents:getPlannedEvents
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BeginTime string
    The start time of the planned event.
    EndTime string
    The end time of the planned event.
    EventId string
    The id of the planned event.
    EventTypes List<string>
    The type of the planned event.
    InstanceId string
    The id of the instance.
    OutputFile string
    File name where to save data source results.
    Statuses List<string>
    The status of the planned event.
    BeginTime string
    The start time of the planned event.
    EndTime string
    The end time of the planned event.
    EventId string
    The id of the planned event.
    EventTypes []string
    The type of the planned event.
    InstanceId string
    The id of the instance.
    OutputFile string
    File name where to save data source results.
    Statuses []string
    The status of the planned event.
    beginTime String
    The start time of the planned event.
    endTime String
    The end time of the planned event.
    eventId String
    The id of the planned event.
    eventTypes List<String>
    The type of the planned event.
    instanceId String
    The id of the instance.
    outputFile String
    File name where to save data source results.
    statuses List<String>
    The status of the planned event.
    beginTime string
    The start time of the planned event.
    endTime string
    The end time of the planned event.
    eventId string
    The id of the planned event.
    eventTypes string[]
    The type of the planned event.
    instanceId string
    The id of the instance.
    outputFile string
    File name where to save data source results.
    statuses string[]
    The status of the planned event.
    begin_time str
    The start time of the planned event.
    end_time str
    The end time of the planned event.
    event_id str
    The id of the planned event.
    event_types Sequence[str]
    The type of the planned event.
    instance_id str
    The id of the instance.
    output_file str
    File name where to save data source results.
    statuses Sequence[str]
    The status of the planned event.
    beginTime String
    The start time of the planned event.
    endTime String
    The end time of the planned event.
    eventId String
    The id of the planned event.
    eventTypes List<String>
    The type of the planned event.
    instanceId String
    The id of the instance.
    outputFile String
    File name where to save data source results.
    statuses List<String>
    The status of the planned event.

    getPlannedEvents Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    PlannedEvents List<GetPlannedEventsPlannedEvent>
    The collection of query.
    TotalCount int
    The total count of query.
    BeginTime string
    EndTime string
    EventId string
    The id of the planned event.
    EventTypes List<string>
    The type of the planned event.
    InstanceId string
    The id of the instance.
    OutputFile string
    Statuses List<string>
    Event status.
    Id string
    The provider-assigned unique ID for this managed resource.
    PlannedEvents []GetPlannedEventsPlannedEvent
    The collection of query.
    TotalCount int
    The total count of query.
    BeginTime string
    EndTime string
    EventId string
    The id of the planned event.
    EventTypes []string
    The type of the planned event.
    InstanceId string
    The id of the instance.
    OutputFile string
    Statuses []string
    Event status.
    id String
    The provider-assigned unique ID for this managed resource.
    plannedEvents List<GetPlannedEventsPlannedEvent>
    The collection of query.
    totalCount Integer
    The total count of query.
    beginTime String
    endTime String
    eventId String
    The id of the planned event.
    eventTypes List<String>
    The type of the planned event.
    instanceId String
    The id of the instance.
    outputFile String
    statuses List<String>
    Event status.
    id string
    The provider-assigned unique ID for this managed resource.
    plannedEvents GetPlannedEventsPlannedEvent[]
    The collection of query.
    totalCount number
    The total count of query.
    beginTime string
    endTime string
    eventId string
    The id of the planned event.
    eventTypes string[]
    The type of the planned event.
    instanceId string
    The id of the instance.
    outputFile string
    statuses string[]
    Event status.
    id str
    The provider-assigned unique ID for this managed resource.
    planned_events Sequence[GetPlannedEventsPlannedEvent]
    The collection of query.
    total_count int
    The total count of query.
    begin_time str
    end_time str
    event_id str
    The id of the planned event.
    event_types Sequence[str]
    The type of the planned event.
    instance_id str
    The id of the instance.
    output_file str
    statuses Sequence[str]
    Event status.
    id String
    The provider-assigned unique ID for this managed resource.
    plannedEvents List<Property Map>
    The collection of query.
    totalCount Number
    The total count of query.
    beginTime String
    endTime String
    eventId String
    The id of the planned event.
    eventTypes List<String>
    The type of the planned event.
    instanceId String
    The id of the instance.
    outputFile String
    statuses List<String>
    Event status.

    Supporting Types

    GetPlannedEventsPlannedEvent

    BusinessImpact string
    The business impact of the planned event.
    DbEngine string
    The database engine of the planned event.
    EventAction string
    The action of the planned event.
    EventId string
    The id of the planned event.
    EventName string
    The name of the planned event.
    EventType string
    The type of the planned event.
    InstanceId string
    The id of the instance.
    InstanceName string
    The name of the instance.
    MaxDelayTime string
    The latest postponable time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    OriginBeginTime string
    The initially set start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    PlannedBeginTime string
    The start time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    PlannedEndTime string
    The end time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    PlannedEventDescription string
    Description information of the operation and maintenance event.
    PlannedEventReason string
    The reasons for the occurrence of the event, which are provided to help you understand the reasons for the occurrence of unexpected events.
    PlannedSwitchBeginTime string
    The start time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    PlannedSwitchEndTime string
    The end time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    Region string
    The region.
    Status string
    The status of the planned event.
    BusinessImpact string
    The business impact of the planned event.
    DbEngine string
    The database engine of the planned event.
    EventAction string
    The action of the planned event.
    EventId string
    The id of the planned event.
    EventName string
    The name of the planned event.
    EventType string
    The type of the planned event.
    InstanceId string
    The id of the instance.
    InstanceName string
    The name of the instance.
    MaxDelayTime string
    The latest postponable time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    OriginBeginTime string
    The initially set start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    PlannedBeginTime string
    The start time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    PlannedEndTime string
    The end time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    PlannedEventDescription string
    Description information of the operation and maintenance event.
    PlannedEventReason string
    The reasons for the occurrence of the event, which are provided to help you understand the reasons for the occurrence of unexpected events.
    PlannedSwitchBeginTime string
    The start time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    PlannedSwitchEndTime string
    The end time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    Region string
    The region.
    Status string
    The status of the planned event.
    businessImpact String
    The business impact of the planned event.
    dbEngine String
    The database engine of the planned event.
    eventAction String
    The action of the planned event.
    eventId String
    The id of the planned event.
    eventName String
    The name of the planned event.
    eventType String
    The type of the planned event.
    instanceId String
    The id of the instance.
    instanceName String
    The name of the instance.
    maxDelayTime String
    The latest postponable time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    originBeginTime String
    The initially set start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedBeginTime String
    The start time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedEndTime String
    The end time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedEventDescription String
    Description information of the operation and maintenance event.
    plannedEventReason String
    The reasons for the occurrence of the event, which are provided to help you understand the reasons for the occurrence of unexpected events.
    plannedSwitchBeginTime String
    The start time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedSwitchEndTime String
    The end time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    region String
    The region.
    status String
    The status of the planned event.
    businessImpact string
    The business impact of the planned event.
    dbEngine string
    The database engine of the planned event.
    eventAction string
    The action of the planned event.
    eventId string
    The id of the planned event.
    eventName string
    The name of the planned event.
    eventType string
    The type of the planned event.
    instanceId string
    The id of the instance.
    instanceName string
    The name of the instance.
    maxDelayTime string
    The latest postponable time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    originBeginTime string
    The initially set start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedBeginTime string
    The start time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedEndTime string
    The end time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedEventDescription string
    Description information of the operation and maintenance event.
    plannedEventReason string
    The reasons for the occurrence of the event, which are provided to help you understand the reasons for the occurrence of unexpected events.
    plannedSwitchBeginTime string
    The start time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedSwitchEndTime string
    The end time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    region string
    The region.
    status string
    The status of the planned event.
    business_impact str
    The business impact of the planned event.
    db_engine str
    The database engine of the planned event.
    event_action str
    The action of the planned event.
    event_id str
    The id of the planned event.
    event_name str
    The name of the planned event.
    event_type str
    The type of the planned event.
    instance_id str
    The id of the instance.
    instance_name str
    The name of the instance.
    max_delay_time str
    The latest postponable time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    origin_begin_time str
    The initially set start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    planned_begin_time str
    The start time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    planned_end_time str
    The end time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    planned_event_description str
    Description information of the operation and maintenance event.
    planned_event_reason str
    The reasons for the occurrence of the event, which are provided to help you understand the reasons for the occurrence of unexpected events.
    planned_switch_begin_time str
    The start time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    planned_switch_end_time str
    The end time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    region str
    The region.
    status str
    The status of the planned event.
    businessImpact String
    The business impact of the planned event.
    dbEngine String
    The database engine of the planned event.
    eventAction String
    The action of the planned event.
    eventId String
    The id of the planned event.
    eventName String
    The name of the planned event.
    eventType String
    The type of the planned event.
    instanceId String
    The id of the instance.
    instanceName String
    The name of the instance.
    maxDelayTime String
    The latest postponable time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    originBeginTime String
    The initially set start time. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedBeginTime String
    The start time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedEndTime String
    The end time of the planned execution. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedEventDescription String
    Description information of the operation and maintenance event.
    plannedEventReason String
    The reasons for the occurrence of the event, which are provided to help you understand the reasons for the occurrence of unexpected events.
    plannedSwitchBeginTime String
    The start time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    plannedSwitchEndTime String
    The end time of the planned switch. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time).
    region String
    The region.
    status String
    The status of the planned event.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate