@volcengine/pulumi/rds_postgresql/plannedEvents.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to query detailed information of rds postgresql planned events
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const example = volcengine.rds_postgresql.getPlannedEvents({
 *     eventTypes: ["VersionUpgrade"],
 *     instanceId: "postgres-72715e0d9f58",
 *     instanceName: "test-01",
 *     plannedSwitchTimeSearchRangeEnd: "2025-12-15T17:40:53.000Z",
 *     plannedSwitchTimeSearchRangeStart: "2025-12-01T02:06:53.000Z",
 *     statuses: [
 *         "WaitStart",
 *         "Running",
 *     ],
 * });
 * ```
 */
/** @deprecated volcengine.rds_postgresql.PlannedEvents has been deprecated in favor of volcengine.rds_postgresql.getPlannedEvents */
export declare function plannedEvents(args?: PlannedEventsArgs, opts?: pulumi.InvokeOptions): Promise<PlannedEventsResult>;
/**
 * A collection of arguments for invoking PlannedEvents.
 */
export interface PlannedEventsArgs {
    /**
     * Event ID.
     */
    eventId?: string;
    /**
     * Event type. Values: VersionUpgrade, HostOffline.
     */
    eventTypes?: string[];
    /**
     * The id of the PostgreSQL instance.
     */
    instanceId?: string;
    /**
     * The name of PostgreSQL instance.
     */
    instanceName?: string;
    /**
     * File name where to save data source results.
     */
    outputFile?: string;
    /**
     * Time window end for planned execution time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC).
     */
    plannedBeginTimeSearchRangeEnd?: string;
    /**
     * Time window start for planned execution time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC).
     */
    plannedBeginTimeSearchRangeStart?: string;
    /**
     * Time window end for planned switch time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC).
     */
    plannedSwitchTimeSearchRangeEnd?: string;
    /**
     * Time window start for planned switch time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC).
     */
    plannedSwitchTimeSearchRangeStart?: string;
    /**
     * Operation event status. Values: Canceled, WaitStart, WaitSwitch, Running, Running_BeforeSwitch, Running_Switching, Running_AfterSwitch, Success, Failed, Timeout, Rollbacking, RollbackFailed.
     */
    statuses?: string[];
}
/**
 * A collection of values returned by PlannedEvents.
 */
export interface PlannedEventsResult {
    /**
     * Event ID.
     */
    readonly eventId?: string;
    /**
     * Event type.
     */
    readonly eventTypes?: string[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Instance ID.
     */
    readonly instanceId?: string;
    /**
     * Instance name.
     */
    readonly instanceName?: string;
    readonly outputFile?: string;
    readonly plannedBeginTimeSearchRangeEnd?: string;
    readonly plannedBeginTimeSearchRangeStart?: string;
    /**
     * Planned events list.
     */
    readonly plannedEvents: outputs.rds_postgresql.PlannedEventsPlannedEvent[];
    readonly plannedSwitchTimeSearchRangeEnd?: string;
    readonly plannedSwitchTimeSearchRangeStart?: string;
    /**
     * Operation event status.
     */
    readonly statuses?: string[];
    /**
     * The total count of query.
     */
    readonly totalCount: number;
}
/**
 * Use this data source to query detailed information of rds postgresql planned events
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const example = volcengine.rds_postgresql.getPlannedEvents({
 *     eventTypes: ["VersionUpgrade"],
 *     instanceId: "postgres-72715e0d9f58",
 *     instanceName: "test-01",
 *     plannedSwitchTimeSearchRangeEnd: "2025-12-15T17:40:53.000Z",
 *     plannedSwitchTimeSearchRangeStart: "2025-12-01T02:06:53.000Z",
 *     statuses: [
 *         "WaitStart",
 *         "Running",
 *     ],
 * });
 * ```
 */
/** @deprecated volcengine.rds_postgresql.PlannedEvents has been deprecated in favor of volcengine.rds_postgresql.getPlannedEvents */
export declare function plannedEventsOutput(args?: PlannedEventsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<PlannedEventsResult>;
/**
 * A collection of arguments for invoking PlannedEvents.
 */
export interface PlannedEventsOutputArgs {
    /**
     * Event ID.
     */
    eventId?: pulumi.Input<string>;
    /**
     * Event type. Values: VersionUpgrade, HostOffline.
     */
    eventTypes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The id of the PostgreSQL instance.
     */
    instanceId?: pulumi.Input<string>;
    /**
     * The name of PostgreSQL instance.
     */
    instanceName?: pulumi.Input<string>;
    /**
     * File name where to save data source results.
     */
    outputFile?: pulumi.Input<string>;
    /**
     * Time window end for planned execution time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC).
     */
    plannedBeginTimeSearchRangeEnd?: pulumi.Input<string>;
    /**
     * Time window start for planned execution time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC).
     */
    plannedBeginTimeSearchRangeStart?: pulumi.Input<string>;
    /**
     * Time window end for planned switch time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC).
     */
    plannedSwitchTimeSearchRangeEnd?: pulumi.Input<string>;
    /**
     * Time window start for planned switch time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC).
     */
    plannedSwitchTimeSearchRangeStart?: pulumi.Input<string>;
    /**
     * Operation event status. Values: Canceled, WaitStart, WaitSwitch, Running, Running_BeforeSwitch, Running_Switching, Running_AfterSwitch, Success, Failed, Timeout, Rollbacking, RollbackFailed.
     */
    statuses?: pulumi.Input<pulumi.Input<string>[]>;
}