Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. State
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.redis.State

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

Provides a resource to manage redis instance state

Example Usage

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

const foo = new volcengine.redis.State("foo", {
    action: "Restart",
    instanceId: "redis-cnlficlt4974swtbz",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.redis.State("foo",
    action="Restart",
    instance_id="redis-cnlficlt4974swtbz")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
resources:
  foo:
    type: volcengine:redis:State
    properties:
      action: Restart
      instanceId: redis-cnlficlt4974swtbz
Copy

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)
public State(String name, StateArgs args)
public State(String name, StateArgs args, CustomResourceOptions options)

type: volcengine:redis:State
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. StateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
example, err := redis.NewState(ctx, "examplestateResourceResourceFromRedisstate", &redis.StateArgs{
	Action:     pulumi.String("string"),
	InstanceId: pulumi.String("string"),
})
Copy
var examplestateResourceResourceFromRedisstate = new State("examplestateResourceResourceFromRedisstate", StateArgs.builder()
    .action("string")
    .instanceId("string")
    .build());
Copy
examplestate_resource_resource_from_redisstate = volcengine.redis.State("examplestateResourceResourceFromRedisstate",
    action="string",
    instance_id="string")
Copy
const examplestateResourceResourceFromRedisstate = new volcengine.redis.State("examplestateResourceResourceFromRedisstate", {
    action: "string",
    instanceId: "string",
});
Copy
type: volcengine:redis:State
properties:
    action: string
    instanceId: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
Instance Action, the value can be Restart.
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
Id of Instance.
Action
This property is required.
Changes to this property will trigger replacement.
string
Instance Action, the value can be Restart.
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
Id of Instance.
action
This property is required.
Changes to this property will trigger replacement.
String
Instance Action, the value can be Restart.
instanceId
This property is required.
Changes to this property will trigger replacement.
String
Id of Instance.
action
This property is required.
Changes to this property will trigger replacement.
string
Instance Action, the value can be Restart.
instanceId
This property is required.
Changes to this property will trigger replacement.
string
Id of Instance.
action
This property is required.
Changes to this property will trigger replacement.
str
Instance Action, the value can be Restart.
instance_id
This property is required.
Changes to this property will trigger replacement.
str
Id of Instance.
action
This property is required.
Changes to this property will trigger replacement.
String
Instance Action, the value can be Restart.
instanceId
This property is required.
Changes to this property will trigger replacement.
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)
resources:  _:    type: volcengine:redis:State    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
Instance Action, the value can be Restart.
InstanceId Changes to this property will trigger replacement. string
Id of Instance.
Action Changes to this property will trigger replacement. string
Instance Action, the value can be Restart.
InstanceId Changes to this property will trigger replacement. string
Id of Instance.
action Changes to this property will trigger replacement. String
Instance Action, the value can be Restart.
instanceId Changes to this property will trigger replacement. String
Id of Instance.
action Changes to this property will trigger replacement. string
Instance Action, the value can be Restart.
instanceId Changes to this property will trigger replacement. string
Id of Instance.
action Changes to this property will trigger replacement. str
Instance Action, the value can be Restart.
instance_id Changes to this property will trigger replacement. str
Id of Instance.
action Changes to this property will trigger replacement. String
Instance Action, the value can be Restart.
instanceId Changes to this property will trigger replacement. 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
Copy

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 v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine