1. Packages
  2. Volcengine
  3. API Docs
  4. cr
  5. State
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

volcengine.cr.State

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

    Provides a resource to manage cr registry state

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Cr.State("foo", new()
        {
            Action = "Start",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/cr"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cr.NewState(ctx, "foo", &cr.StateArgs{
    			Action: pulumi.String("Start"),
    		})
    		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.cr.State;
    import com.pulumi.volcengine.cr.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("Start")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.cr.State("foo", action="Start")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.cr.State("foo", {action: "Start"});
    
    resources:
      foo:
        type: volcengine:cr:State
        properties:
          action: Start
    

    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,
              name: 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:cr: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.

    Example

    The following reference example uses placeholder values for all input properties.

    var stateResource = new Volcengine.Cr.State("stateResource", new()
    {
        Action = "string",
        Name = "string",
    });
    
    example, err := cr.NewState(ctx, "stateResource", &cr.StateArgs{
    	Action: pulumi.String("string"),
    	Name:   pulumi.String("string"),
    })
    
    var stateResource = new State("stateResource", StateArgs.builder()        
        .action("string")
        .name("string")
        .build());
    
    state_resource = volcengine.cr.State("stateResource",
        action="string",
        name="string")
    
    const stateResource = new volcengine.cr.State("stateResource", {
        action: "string",
        name: "string",
    });
    
    type: volcengine:cr:State
    properties:
        action: string
        name: 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
    Start cr instance action,the value must be Start.
    Name string
    The cr instance id.
    Action string
    Start cr instance action,the value must be Start.
    Name string
    The cr instance id.
    action String
    Start cr instance action,the value must be Start.
    name String
    The cr instance id.
    action string
    Start cr instance action,the value must be Start.
    name string
    The cr instance id.
    action str
    Start cr instance action,the value must be Start.
    name str
    The cr instance id.
    action String
    Start cr instance action,the value must be Start.
    name String
    The cr instance id.

    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.
    Status Volcengine.Pulumi.Volcengine.Cr.Outputs.StateStatus
    The status of cr instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status StateStatus
    The status of cr instance.
    id String
    The provider-assigned unique ID for this managed resource.
    status StateStatus
    The status of cr instance.
    id string
    The provider-assigned unique ID for this managed resource.
    status StateStatus
    The status of cr instance.
    id str
    The provider-assigned unique ID for this managed resource.
    status StateStatus
    The status of cr instance.
    id String
    The provider-assigned unique ID for this managed resource.
    status Property Map
    The status of cr instance.

    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,
            name: Optional[str] = None,
            status: Optional[StateStatusArgs] = 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.
    The following state arguments are supported:
    Action string
    Start cr instance action,the value must be Start.
    Name string
    The cr instance id.
    Status Volcengine.Pulumi.Volcengine.Cr.Inputs.StateStatus
    The status of cr instance.
    Action string
    Start cr instance action,the value must be Start.
    Name string
    The cr instance id.
    Status StateStatusArgs
    The status of cr instance.
    action String
    Start cr instance action,the value must be Start.
    name String
    The cr instance id.
    status StateStatus
    The status of cr instance.
    action string
    Start cr instance action,the value must be Start.
    name string
    The cr instance id.
    status StateStatus
    The status of cr instance.
    action str
    Start cr instance action,the value must be Start.
    name str
    The cr instance id.
    status StateStatusArgs
    The status of cr instance.
    action String
    Start cr instance action,the value must be Start.
    name String
    The cr instance id.
    status Property Map
    The status of cr instance.

    Supporting Types

    StateStatus, StateStatusArgs

    Conditions List<string>
    The condition of instance.
    Phase string
    The phase status of instance.
    Conditions []string
    The condition of instance.
    Phase string
    The phase status of instance.
    conditions List<String>
    The condition of instance.
    phase String
    The phase status of instance.
    conditions string[]
    The condition of instance.
    phase string
    The phase status of instance.
    conditions Sequence[str]
    The condition of instance.
    phase str
    The phase status of instance.
    conditions List<String>
    The condition of instance.
    phase String
    The phase status of instance.

    Import

    CR registry state can be imported using the state:registry_name, e.g.

     $ pulumi import volcengine:cr/state:State default state:cr-basic
    

    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.23 published on Wednesday, Jan 3, 2024 by Volcengine