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

volcengine.redis.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 redis planned events

    Example Usage

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

const fooZones = volcengine.ecs.getZones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooInstance = new volcengine.redis.Instance("fooInstance", {
    zoneIds: [fooZones.then(fooZones => fooZones.zones?.[0]?.id)],
    instanceName: "acc-test-tf-redis",
    shardedCluster: 1,
    password: "1qaz!QAZ12",
    nodeNumber: 2,
    shardCapacity: 1024,
    shardNumber: 2,
    engineVersion: "5.0",
    subnetId: fooSubnet.id,
    deletionProtection: "disabled",
    vpcAuthMode: "close",
    chargeType: "PostPaid",
    port: 6381,
    projectName: "default",
});
const fooPlannedEvents = volcengine.redis.getPlannedEventsOutput({
    instanceId: fooInstance.id,
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.get_zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_instance = volcengine.redis.Instance("fooInstance",
    zone_ids=[foo_zones.zones[0].id],
    instance_name="acc-test-tf-redis",
    sharded_cluster=1,
    password="1qaz!QAZ12",
    node_number=2,
    shard_capacity=1024,
    shard_number=2,
    engine_version="5.0",
    subnet_id=foo_subnet.id,
    deletion_protection="disabled",
    vpc_auth_mode="close",
    charge_type="PostPaid",
    port=6381,
    project_name="default")
foo_planned_events = volcengine.redis.get_planned_events_output(instance_id=foo_instance.id)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/redis"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooInstance, err := redis.NewInstance(ctx, "fooInstance", &redis.InstanceArgs{
			ZoneIds: pulumi.StringArray{
				pulumi.String(fooZones.Zones[0].Id),
			},
			InstanceName:       pulumi.String("acc-test-tf-redis"),
			ShardedCluster:     pulumi.Int(1),
			Password:           pulumi.String("1qaz!QAZ12"),
			NodeNumber:         pulumi.Int(2),
			ShardCapacity:      pulumi.Int(1024),
			ShardNumber:        pulumi.Int(2),
			EngineVersion:      pulumi.String("5.0"),
			SubnetId:           fooSubnet.ID(),
			DeletionProtection: pulumi.String("disabled"),
			VpcAuthMode:        pulumi.String("close"),
			ChargeType:         pulumi.String("PostPaid"),
			Port:               pulumi.Int(6381),
			ProjectName:        pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_ = redis.GetPlannedEventsOutput(ctx, redis.GetPlannedEventsOutputArgs{
			InstanceId: fooInstance.ID(),
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.GetZones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooInstance = new Volcengine.Redis.Instance("fooInstance", new()
    {
        ZoneIds = new[]
        {
            fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        },
        InstanceName = "acc-test-tf-redis",
        ShardedCluster = 1,
        Password = "1qaz!QAZ12",
        NodeNumber = 2,
        ShardCapacity = 1024,
        ShardNumber = 2,
        EngineVersion = "5.0",
        SubnetId = fooSubnet.Id,
        DeletionProtection = "disabled",
        VpcAuthMode = "close",
        ChargeType = "PostPaid",
        Port = 6381,
        ProjectName = "default",
    });

    var fooPlannedEvents = Volcengine.Redis.GetPlannedEvents.Invoke(new()
    {
        InstanceId = fooInstance.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.redis.Instance;
import com.pulumi.volcengine.redis.InstanceArgs;
import com.pulumi.volcengine.redis.RedisFunctions;
import com.pulumi.volcengine.redis.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 fooZones = EcsFunctions.getZones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .zoneIds(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .instanceName("acc-test-tf-redis")
            .shardedCluster(1)
            .password("1qaz!QAZ12")
            .nodeNumber(2)
            .shardCapacity(1024)
            .shardNumber(2)
            .engineVersion("5.0")
            .subnetId(fooSubnet.id())
            .deletionProtection("disabled")
            .vpcAuthMode("close")
            .chargeType("PostPaid")
            .port(6381)
            .projectName("default")
            .build());

        final var fooPlannedEvents = RedisFunctions.getPlannedEvents(GetPlannedEventsArgs.builder()
            .instanceId(fooInstance.id())
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooInstance:
    type: volcengine:redis:Instance
    properties:
      zoneIds:
        - ${fooZones.zones[0].id}
      instanceName: acc-test-tf-redis
      shardedCluster: 1
      password: 1qaz!QAZ12
      nodeNumber: 2
      shardCapacity: 1024
      shardNumber: 2
      engineVersion: '5.0'
      subnetId: ${fooSubnet.id}
      deletionProtection: disabled
      vpcAuthMode: close
      chargeType: PostPaid
      port: 6381
      projectName: default
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:getZones
      Arguments: {}
  fooPlannedEvents:
    fn::invoke:
      Function: volcengine:redis:getPlannedEvents
      Arguments:
        instanceId: ${fooInstance.id}

    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(instance_id: Optional[str] = None,
                       max_start_time: Optional[str] = None,
                       min_start_time: Optional[str] = None,
                       name_regex: Optional[str] = None,
                       output_file: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPlannedEventsResult
def get_planned_events_output(instance_id: Optional[pulumi.Input[str]] = None,
                       max_start_time: Optional[pulumi.Input[str]] = None,
                       min_start_time: Optional[pulumi.Input[str]] = None,
                       name_regex: Optional[pulumi.Input[str]] = None,
                       output_file: Optional[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:redis/getPlannedEvents:getPlannedEvents
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The ID of instance.
    MaxStartTime string
    The latest execution time of the planned events that need to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    MinStartTime string
    The earliest execution time of the planned event that needs to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    InstanceId string
    The ID of instance.
    MaxStartTime string
    The latest execution time of the planned events that need to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    MinStartTime string
    The earliest execution time of the planned event that needs to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    instanceId String
    The ID of instance.
    maxStartTime String
    The latest execution time of the planned events that need to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    minStartTime String
    The earliest execution time of the planned event that needs to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    instanceId string
    The ID of instance.
    maxStartTime string
    The latest execution time of the planned events that need to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    minStartTime string
    The earliest execution time of the planned event that needs to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    instance_id str
    The ID of instance.
    max_start_time str
    The latest execution time of the planned events that need to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    min_start_time str
    The earliest execution time of the planned event that needs to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    instanceId String
    The ID of instance.
    maxStartTime String
    The latest execution time of the planned events that need to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    minStartTime String
    The earliest execution time of the planned event that needs to be queried. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.

    getPlannedEvents Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    PlannedEvents List<GetPlannedEventsPlannedEvent>
    The List of planned event information.
    TotalCount int
    The total count of query.
    InstanceId string
    The ID of instance.
    MaxStartTime string
    MinStartTime string
    NameRegex string
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    PlannedEvents []GetPlannedEventsPlannedEvent
    The List of planned event information.
    TotalCount int
    The total count of query.
    InstanceId string
    The ID of instance.
    MaxStartTime string
    MinStartTime string
    NameRegex string
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    plannedEvents List<GetPlannedEventsPlannedEvent>
    The List of planned event information.
    totalCount Integer
    The total count of query.
    instanceId String
    The ID of instance.
    maxStartTime String
    minStartTime String
    nameRegex String
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    plannedEvents GetPlannedEventsPlannedEvent[]
    The List of planned event information.
    totalCount number
    The total count of query.
    instanceId string
    The ID of instance.
    maxStartTime string
    minStartTime string
    nameRegex string
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    planned_events Sequence[GetPlannedEventsPlannedEvent]
    The List of planned event information.
    total_count int
    The total count of query.
    instance_id str
    The ID of instance.
    max_start_time str
    min_start_time str
    name_regex str
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    plannedEvents List<Property Map>
    The List of planned event information.
    totalCount Number
    The total count of query.
    instanceId String
    The ID of instance.
    maxStartTime String
    minStartTime String
    nameRegex String
    outputFile String

    Supporting Types

    GetPlannedEventsPlannedEvent

    ActionName string
    Event operation name.
    CanCancel bool
    Whether the current event is allowed to be cancelled for execution.
    CanModifyTime bool
    Whether the execution time of the current event can be changed.
    EventId string
    The ID of Event.
    InstanceId string
    The ID of instance.
    InstanceName string
    The name of instance.
    MaxEndTime string
    The latest execution time at which changes are allowed for the current event.
    PlanEndTime string
    The latest execution time of the event plan. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    PlanStartTime string
    The earliest planned execution time of the event. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    Status string
    The status of event.
    Type string
    The type of event.
    ActionName string
    Event operation name.
    CanCancel bool
    Whether the current event is allowed to be cancelled for execution.
    CanModifyTime bool
    Whether the execution time of the current event can be changed.
    EventId string
    The ID of Event.
    InstanceId string
    The ID of instance.
    InstanceName string
    The name of instance.
    MaxEndTime string
    The latest execution time at which changes are allowed for the current event.
    PlanEndTime string
    The latest execution time of the event plan. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    PlanStartTime string
    The earliest planned execution time of the event. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    Status string
    The status of event.
    Type string
    The type of event.
    actionName String
    Event operation name.
    canCancel Boolean
    Whether the current event is allowed to be cancelled for execution.
    canModifyTime Boolean
    Whether the execution time of the current event can be changed.
    eventId String
    The ID of Event.
    instanceId String
    The ID of instance.
    instanceName String
    The name of instance.
    maxEndTime String
    The latest execution time at which changes are allowed for the current event.
    planEndTime String
    The latest execution time of the event plan. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    planStartTime String
    The earliest planned execution time of the event. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    status String
    The status of event.
    type String
    The type of event.
    actionName string
    Event operation name.
    canCancel boolean
    Whether the current event is allowed to be cancelled for execution.
    canModifyTime boolean
    Whether the execution time of the current event can be changed.
    eventId string
    The ID of Event.
    instanceId string
    The ID of instance.
    instanceName string
    The name of instance.
    maxEndTime string
    The latest execution time at which changes are allowed for the current event.
    planEndTime string
    The latest execution time of the event plan. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    planStartTime string
    The earliest planned execution time of the event. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    status string
    The status of event.
    type string
    The type of event.
    action_name str
    Event operation name.
    can_cancel bool
    Whether the current event is allowed to be cancelled for execution.
    can_modify_time bool
    Whether the execution time of the current event can be changed.
    event_id str
    The ID of Event.
    instance_id str
    The ID of instance.
    instance_name str
    The name of instance.
    max_end_time str
    The latest execution time at which changes are allowed for the current event.
    plan_end_time str
    The latest execution time of the event plan. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    plan_start_time str
    The earliest planned execution time of the event. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    status str
    The status of event.
    type str
    The type of event.
    actionName String
    Event operation name.
    canCancel Boolean
    Whether the current event is allowed to be cancelled for execution.
    canModifyTime Boolean
    Whether the execution time of the current event can be changed.
    eventId String
    The ID of Event.
    instanceId String
    The ID of instance.
    instanceName String
    The name of instance.
    maxEndTime String
    The latest execution time at which changes are allowed for the current event.
    planEndTime String
    The latest execution time of the event plan. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    planStartTime String
    The earliest planned execution time of the event. The format is yyyy-MM-ddTHH:mm:ssZ (UTC).
    status String
    The status of event.
    type String
    The type of 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