1. Packages
  2. Volcengine
  3. API Docs
  4. rds_postgresql
  5. State
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.rds_postgresql.State

volcengine logo
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Provides a resource to manage rds postgresql instance state

    Example Usage

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

const example = new volcengine.rds_postgresql.State("example", {
    action: "Restart",
    instanceId: "postgres-72715e0d9f58",
});

    import pulumi
import pulumi_volcengine as volcengine

example = volcengine.rds_postgresql.State("example",
    action="Restart",
    instance_id="postgres-72715e0d9f58")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_postgresql.NewState(ctx, "example", &rds_postgresql.StateArgs{
			Action:     pulumi.String("Restart"),
			InstanceId: pulumi.String("postgres-72715e0d9f58"),
		})
		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 example = new Volcengine.Rds_postgresql.State("example", new()
    {
        Action = "Restart",
        InstanceId = "postgres-72715e0d9f58",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_postgresql.State;
import com.pulumi.volcengine.rds_postgresql.StateArgs;
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) {
        var example = new State("example", StateArgs.builder()        
            .action("Restart")
            .instanceId("postgres-72715e0d9f58")
            .build());

    }
}

    resources:
  example:
    type: volcengine:rds_postgresql:State
    properties:
      action: Restart
      instanceId: postgres-72715e0d9f58

    Create State Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new State(name: string, args: StateArgs, opts?: CustomResourceOptions);
    @overload
def State(resource_name: str,
          args: StateArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def State(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          action: Optional[str] = None,
          instance_id: Optional[str] = None,
          apply_scope: Optional[str] = None,
          custom_node_ids: Optional[Sequence[str]] = None)
    func NewState(ctx *Context, name string, args StateArgs, opts ...ResourceOption) (*State, error)
    public State(string name, StateArgs args, CustomResourceOptions? opts = null)
    public State(String name, StateArgs args)
public State(String name, StateArgs args, CustomResourceOptions options)

    type: volcengine:rds_postgresql:State
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 StateArgs
    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 StateArgs
    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 StateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StateArgs
    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 examplestateResourceResourceFromRds_postgresqlstate = new Volcengine.Rds_postgresql.State("examplestateResourceResourceFromRds_postgresqlstate", new()
{
    Action = "string",
    InstanceId = "string",
    ApplyScope = "string",
    CustomNodeIds = new[]
    {
        "string",
    },
});

    example, err := rds_postgresql.NewState(ctx, "examplestateResourceResourceFromRds_postgresqlstate", &rds_postgresql.StateArgs{
	Action:     pulumi.String("string"),
	InstanceId: pulumi.String("string"),
	ApplyScope: pulumi.String("string"),
	CustomNodeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var examplestateResourceResourceFromRds_postgresqlstate = new com.pulumi.volcengine.rds_postgresql.State("examplestateResourceResourceFromRds_postgresqlstate", com.pulumi.volcengine.rds_postgresql.StateArgs.builder()
    .action("string")
    .instanceId("string")
    .applyScope("string")
    .customNodeIds("string")
    .build());

    examplestate_resource_resource_from_rds_postgresqlstate = volcengine.rds_postgresql.State("examplestateResourceResourceFromRds_postgresqlstate",
    action="string",
    instance_id="string",
    apply_scope="string",
    custom_node_ids=["string"])

    const examplestateResourceResourceFromRds_postgresqlstate = new volcengine.rds_postgresql.State("examplestateResourceResourceFromRds_postgresqlstate", {
    action: "string",
    instanceId: "string",
    applyScope: "string",
    customNodeIds: ["string"],
});

    type: volcengine:rds_postgresql:State
properties:
    action: string
    applyScope: string
    customNodeIds:
        - string
    instanceId: string

    State 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 State resource accepts the following input properties:

    Action string
    The action to perform on the instance. Valid value: Restart.
    InstanceId string
    The ID of the RDS PostgreSQL instance to perform the action on.
    ApplyScope string
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    CustomNodeIds List<string>
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    Action string
    The action to perform on the instance. Valid value: Restart.
    InstanceId string
    The ID of the RDS PostgreSQL instance to perform the action on.
    ApplyScope string
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    CustomNodeIds []string
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    action String
    The action to perform on the instance. Valid value: Restart.
    instanceId String
    The ID of the RDS PostgreSQL instance to perform the action on.
    applyScope String
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    customNodeIds List<String>
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    action string
    The action to perform on the instance. Valid value: Restart.
    instanceId string
    The ID of the RDS PostgreSQL instance to perform the action on.
    applyScope string
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    customNodeIds string[]
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    action str
    The action to perform on the instance. Valid value: Restart.
    instance_id str
    The ID of the RDS PostgreSQL instance to perform the action on.
    apply_scope str
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    custom_node_ids Sequence[str]
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    action String
    The action to perform on the instance. Valid value: Restart.
    instanceId String
    The ID of the RDS PostgreSQL instance to perform the action on.
    applyScope String
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    customNodeIds List<String>
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the State resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing State Resource

    Get an existing State 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?: StateState, opts?: CustomResourceOptions): State
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        apply_scope: Optional[str] = None,
        custom_node_ids: Optional[Sequence[str]] = None,
        instance_id: Optional[str] = None) -> State
    func GetState(ctx *Context, name string, id IDInput, state *StateState, opts ...ResourceOption) (*State, error)
    public static State Get(string name, Input<string> id, StateState? state, CustomResourceOptions? opts = null)
    public static State get(String name, Output<String> id, StateState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:rds_postgresql:State    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.
    The following state arguments are supported:
    Action string
    The action to perform on the instance. Valid value: Restart.
    ApplyScope string
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    CustomNodeIds List<string>
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    InstanceId string
    The ID of the RDS PostgreSQL instance to perform the action on.
    Action string
    The action to perform on the instance. Valid value: Restart.
    ApplyScope string
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    CustomNodeIds []string
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    InstanceId string
    The ID of the RDS PostgreSQL instance to perform the action on.
    action String
    The action to perform on the instance. Valid value: Restart.
    applyScope String
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    customNodeIds List<String>
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    instanceId String
    The ID of the RDS PostgreSQL instance to perform the action on.
    action string
    The action to perform on the instance. Valid value: Restart.
    applyScope string
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    customNodeIds string[]
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    instanceId string
    The ID of the RDS PostgreSQL instance to perform the action on.
    action str
    The action to perform on the instance. Valid value: Restart.
    apply_scope str
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    custom_node_ids Sequence[str]
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    instance_id str
    The ID of the RDS PostgreSQL instance to perform the action on.
    action String
    The action to perform on the instance. Valid value: Restart.
    applyScope String
    The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
    customNodeIds List<String>
    The ID of the read-only node(s) to restart. Required if apply_scope is CustomNode.
    instanceId String
    The ID of the RDS PostgreSQL instance to perform the action on.

    Import

    RdsPostgresqlInstanceState can be imported using the id, e.g.

    $ pulumi import volcengine:rds_postgresql/state:State default resource_id

    To learn more about importing existing cloud resources, see Importing resources.

    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.43 published on Friday, Jan 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate