volcengine.redis.State
Explore with Pulumi AI
Provides a resource to manage redis instance state
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var foo = new Volcengine.Redis.State("foo", new()
{
Action = "Restart",
InstanceId = "redis-cnlficlt4974swtbz",
});
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/redis"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := redis.NewState(ctx, "foo", &redis.StateArgs{
Action: pulumi.String("Restart"),
InstanceId: pulumi.String("redis-cnlficlt4974swtbz"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.redis.State;
import com.pulumi.volcengine.redis.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 foo = new State("foo", StateArgs.builder()
.action("Restart")
.instanceId("redis-cnlficlt4974swtbz")
.build());
}
}
import pulumi
import pulumi_volcengine as volcengine
foo = volcengine.redis.State("foo",
action="Restart",
instance_id="redis-cnlficlt4974swtbz")
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";
const foo = new volcengine.redis.State("foo", {
action: "Restart",
instanceId: "redis-cnlficlt4974swtbz",
});
resources:
foo:
type: volcengine:redis:State
properties:
action: Restart
instanceId: redis-cnlficlt4974swtbz
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)
func NewState(ctx *Context, name string, args StateArgs, opts ...ResourceOption) (*State, error)
public State(string name, StateArgs args, CustomResourceOptions? opts = null)
type: volcengine:redis: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 examplestateResourceResourceFromRedisstate = new Volcengine.Redis.State("examplestateResourceResourceFromRedisstate", new()
{
Action = "string",
InstanceId = "string",
});
example, err := redis.NewState(ctx, "examplestateResourceResourceFromRedisstate", &redis.StateArgs{
Action: pulumi.String("string"),
InstanceId: pulumi.String("string"),
})
var examplestateResourceResourceFromRedisstate = new State("examplestateResourceResourceFromRedisstate", StateArgs.builder()
.action("string")
.instanceId("string")
.build());
examplestate_resource_resource_from_redisstate = volcengine.redis.State("examplestateResourceResourceFromRedisstate",
action="string",
instance_id="string")
const examplestateResourceResourceFromRedisstate = new volcengine.redis.State("examplestateResourceResourceFromRedisstate", {
action: "string",
instanceId: "string",
});
type: volcengine:redis:State
properties:
action: 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
The State resource accepts the following input properties:
- Action string
- Instance Action, the value can be
Restart
. - Instance
Id string - Id of Instance.
- Action string
- Instance Action, the value can be
Restart
. - Instance
Id string - Id of Instance.
- action String
- Instance Action, the value can be
Restart
. - instance
Id String - Id of Instance.
- action string
- Instance Action, the value can be
Restart
. - instance
Id string - Id of Instance.
- action str
- Instance Action, the value can be
Restart
. - instance_
id str - Id of Instance.
- action String
- Instance Action, the value can be
Restart
. - instance
Id String - Id of Instance.
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,
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)
Resource lookup is not supported in YAML
- 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.
- Action string
- Instance Action, the value can be
Restart
. - Instance
Id string - Id of Instance.
- Action string
- Instance Action, the value can be
Restart
. - Instance
Id string - Id of Instance.
- action String
- Instance Action, the value can be
Restart
. - instance
Id String - Id of Instance.
- action string
- Instance Action, the value can be
Restart
. - instance
Id string - Id of Instance.
- action str
- Instance Action, the value can be
Restart
. - instance_
id str - Id of Instance.
- action String
- Instance Action, the value can be
Restart
. - instance
Id String - Id of Instance.
Import
Redis State Instance can be imported using the id, e.g.
$ pulumi import volcengine:redis/state:State default state:redis-mizl7m1kqccg5smt1bdpijuj
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.