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

volcengine.bioos.Cluster

Explore with Pulumi AI

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

    Provides a resource to manage bioos cluster

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Bioos.Cluster("foo", new()
        {
            Description = "test-description",
            SharedConfig = new Volcengine.Bioos.Inputs.ClusterSharedConfigArgs
            {
                Enable = true,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/bioos"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := bioos.NewCluster(ctx, "foo", &bioos.ClusterArgs{
    			Description: pulumi.String("test-description"),
    			SharedConfig: &bioos.ClusterSharedConfigArgs{
    				Enable: pulumi.Bool(true),
    			},
    		})
    		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.bioos.Cluster;
    import com.pulumi.volcengine.bioos.ClusterArgs;
    import com.pulumi.volcengine.bioos.inputs.ClusterSharedConfigArgs;
    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 Cluster("foo", ClusterArgs.builder()        
                .description("test-description")
                .sharedConfig(ClusterSharedConfigArgs.builder()
                    .enable(true)
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.bioos.Cluster("foo",
        description="test-description",
        shared_config=volcengine.bioos.ClusterSharedConfigArgs(
            enable=True,
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.bioos.Cluster("foo", {
        description: "test-description",
        sharedConfig: {
            enable: true,
        },
    });
    
    resources:
      foo:
        type: volcengine:bioos:Cluster
        properties:
          description: test-description
          # 必填
          #     //  vke_config { //选填,和shared_config二者中必填一个
          #     //    cluster_id = "ccerdh8fqtofh16uf6q60" //也可替换成volcengine_vke_cluster.example.id
          #     //    storage_class = "ebs-ssd"
          #     //  }
          sharedConfig:
            enable: true
    

    Create Cluster Resource

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

    Constructor syntax

    new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: Optional[ClusterArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                shared_config: Optional[ClusterSharedConfigArgs] = None,
                vke_config: Optional[ClusterVkeConfigArgs] = None)
    func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: volcengine:bioos:Cluster
    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 ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    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 clusterResource = new Volcengine.Bioos.Cluster("clusterResource", new()
    {
        Description = "string",
        Name = "string",
        SharedConfig = new Volcengine.Bioos.Inputs.ClusterSharedConfigArgs
        {
            Enable = false,
        },
        VkeConfig = new Volcengine.Bioos.Inputs.ClusterVkeConfigArgs
        {
            ClusterId = "string",
            StorageClass = "string",
        },
    });
    
    example, err := bioos.NewCluster(ctx, "clusterResource", &bioos.ClusterArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	SharedConfig: &bioos.ClusterSharedConfigArgs{
    		Enable: pulumi.Bool(false),
    	},
    	VkeConfig: &bioos.ClusterVkeConfigArgs{
    		ClusterId:    pulumi.String("string"),
    		StorageClass: pulumi.String("string"),
    	},
    })
    
    var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
        .description("string")
        .name("string")
        .sharedConfig(ClusterSharedConfigArgs.builder()
            .enable(false)
            .build())
        .vkeConfig(ClusterVkeConfigArgs.builder()
            .clusterId("string")
            .storageClass("string")
            .build())
        .build());
    
    cluster_resource = volcengine.bioos.Cluster("clusterResource",
        description="string",
        name="string",
        shared_config=volcengine.bioos.ClusterSharedConfigArgs(
            enable=False,
        ),
        vke_config=volcengine.bioos.ClusterVkeConfigArgs(
            cluster_id="string",
            storage_class="string",
        ))
    
    const clusterResource = new volcengine.bioos.Cluster("clusterResource", {
        description: "string",
        name: "string",
        sharedConfig: {
            enable: false,
        },
        vkeConfig: {
            clusterId: "string",
            storageClass: "string",
        },
    });
    
    type: volcengine:bioos:Cluster
    properties:
        description: string
        name: string
        sharedConfig:
            enable: false
        vkeConfig:
            clusterId: string
            storageClass: string
    

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

    Description string
    The description of the cluster.
    Name string
    The name of the cluster.
    SharedConfig Volcengine.ClusterSharedConfig
    The configuration of the shared cluster.
    VkeConfig Volcengine.ClusterVkeConfig
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    Description string
    The description of the cluster.
    Name string
    The name of the cluster.
    SharedConfig ClusterSharedConfigArgs
    The configuration of the shared cluster.
    VkeConfig ClusterVkeConfigArgs
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    description String
    The description of the cluster.
    name String
    The name of the cluster.
    sharedConfig ClusterSharedConfig
    The configuration of the shared cluster.
    vkeConfig ClusterVkeConfig
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    description string
    The description of the cluster.
    name string
    The name of the cluster.
    sharedConfig ClusterSharedConfig
    The configuration of the shared cluster.
    vkeConfig ClusterVkeConfig
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    description str
    The description of the cluster.
    name str
    The name of the cluster.
    shared_config ClusterSharedConfigArgs
    The configuration of the shared cluster.
    vke_config ClusterVkeConfigArgs
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    description String
    The description of the cluster.
    name String
    The name of the cluster.
    sharedConfig Property Map
    The configuration of the shared cluster.
    vkeConfig Property Map
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.

    Outputs

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

    ClusterId string
    The id of the vke cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    ClusterId string
    The id of the vke cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    clusterId String
    The id of the vke cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    clusterId string
    The id of the vke cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    cluster_id str
    The id of the vke cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    clusterId String
    The id of the vke cluster.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Cluster Resource

    Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cluster_id: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            shared_config: Optional[ClusterSharedConfigArgs] = None,
            vke_config: Optional[ClusterVkeConfigArgs] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState 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:
    ClusterId string
    The id of the vke cluster.
    Description string
    The description of the cluster.
    Name string
    The name of the cluster.
    SharedConfig Volcengine.ClusterSharedConfig
    The configuration of the shared cluster.
    VkeConfig Volcengine.ClusterVkeConfig
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    ClusterId string
    The id of the vke cluster.
    Description string
    The description of the cluster.
    Name string
    The name of the cluster.
    SharedConfig ClusterSharedConfigArgs
    The configuration of the shared cluster.
    VkeConfig ClusterVkeConfigArgs
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    clusterId String
    The id of the vke cluster.
    description String
    The description of the cluster.
    name String
    The name of the cluster.
    sharedConfig ClusterSharedConfig
    The configuration of the shared cluster.
    vkeConfig ClusterVkeConfig
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    clusterId string
    The id of the vke cluster.
    description string
    The description of the cluster.
    name string
    The name of the cluster.
    sharedConfig ClusterSharedConfig
    The configuration of the shared cluster.
    vkeConfig ClusterVkeConfig
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    cluster_id str
    The id of the vke cluster.
    description str
    The description of the cluster.
    name str
    The name of the cluster.
    shared_config ClusterSharedConfigArgs
    The configuration of the shared cluster.
    vke_config ClusterVkeConfigArgs
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.
    clusterId String
    The id of the vke cluster.
    description String
    The description of the cluster.
    name String
    The name of the cluster.
    sharedConfig Property Map
    The configuration of the shared cluster.
    vkeConfig Property Map
    The configuration of the vke cluster. This cluster type is not recommended. It is recommended to use a shared cluster.

    Supporting Types

    ClusterSharedConfig, ClusterSharedConfigArgs

    Enable bool
    Whether to enable a shared cluster. This value must be true.
    Enable bool
    Whether to enable a shared cluster. This value must be true.
    enable Boolean
    Whether to enable a shared cluster. This value must be true.
    enable boolean
    Whether to enable a shared cluster. This value must be true.
    enable bool
    Whether to enable a shared cluster. This value must be true.
    enable Boolean
    Whether to enable a shared cluster. This value must be true.

    ClusterVkeConfig, ClusterVkeConfigArgs

    ClusterId string
    The id of the vke cluster.
    StorageClass string
    The name of the StorageClass that the vke cluster has installed.
    ClusterId string
    The id of the vke cluster.
    StorageClass string
    The name of the StorageClass that the vke cluster has installed.
    clusterId String
    The id of the vke cluster.
    storageClass String
    The name of the StorageClass that the vke cluster has installed.
    clusterId string
    The id of the vke cluster.
    storageClass string
    The name of the StorageClass that the vke cluster has installed.
    cluster_id str
    The id of the vke cluster.
    storage_class str
    The name of the StorageClass that the vke cluster has installed.
    clusterId String
    The id of the vke cluster.
    storageClass String
    The name of the StorageClass that the vke cluster has installed.

    Import

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

     $ pulumi import volcengine:bioos/cluster:Cluster default *****
    

    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