@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
107 lines (106 loc) • 3.77 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage rds postgresql instance state
* ## Example Usage
*
* ```typescript
* 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
*
* RdsPostgresqlInstanceState can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:rds_postgresql/state:State default resource_id
* ```
*/
export declare class State extends pulumi.CustomResource {
/**
* Get an existing State resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StateState, opts?: pulumi.CustomResourceOptions): State;
/**
* Returns true if the given object is an instance of State. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is State;
/**
* The action to perform on the instance. Valid value: Restart.
*/
readonly action: pulumi.Output<string>;
/**
* The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
*/
readonly applyScope: pulumi.Output<string | undefined>;
/**
* The ID of the read-only node(s) to restart. Required if applyScope is CustomNode.
*/
readonly customNodeIds: pulumi.Output<string[] | undefined>;
/**
* The ID of the RDS PostgreSQL instance to perform the action on.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Create a State resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: StateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering State resources.
*/
export interface StateState {
/**
* The action to perform on the instance. Valid value: Restart.
*/
action?: pulumi.Input<string>;
/**
* The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
*/
applyScope?: pulumi.Input<string>;
/**
* The ID of the read-only node(s) to restart. Required if applyScope is CustomNode.
*/
customNodeIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the RDS PostgreSQL instance to perform the action on.
*/
instanceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a State resource.
*/
export interface StateArgs {
/**
* The action to perform on the instance. Valid value: Restart.
*/
action: pulumi.Input<string>;
/**
* The scope of the action. Valid values: AllNode, CustomNode. Default value: AllNode.
*/
applyScope?: pulumi.Input<string>;
/**
* The ID of the read-only node(s) to restart. Required if applyScope is CustomNode.
*/
customNodeIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the RDS PostgreSQL instance to perform the action on.
*/
instanceId: pulumi.Input<string>;
}