1. Packages
  2. Volcengine
  3. API Docs
  4. bioos
  5. Clusters
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

volcengine.bioos.Clusters

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

Use this data source to query detailed information of bioos clusters

Example Usage

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

const default = volcengine.bioos.Clusters({});
Copy
import pulumi
import pulumi_volcengine as volcengine

default = volcengine.bioos.clusters()
Copy
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.Clusters(ctx, nil, nil)
		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 @default = Volcengine.Bioos.Clusters.Invoke();

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.bioos.BioosFunctions;
import com.pulumi.volcengine.bioos.inputs.ClustersArgs;
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) {
        final var default = BioosFunctions.Clusters();

    }
}
Copy
variables:
  default:
    fn::invoke:
      Function: volcengine:bioos:Clusters
      Arguments: {}
Copy

Using Clusters

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function clusters(args: ClustersArgs, opts?: InvokeOptions): Promise<ClustersResult>
function clustersOutput(args: ClustersOutputArgs, opts?: InvokeOptions): Output<ClustersResult>
Copy
def clusters(ids: Optional[Sequence[str]] = None,
             output_file: Optional[str] = None,
             public: Optional[bool] = None,
             statuses: Optional[Sequence[str]] = None,
             types: Optional[Sequence[str]] = None,
             opts: Optional[InvokeOptions] = None) -> ClustersResult
def clusters_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             output_file: Optional[pulumi.Input[str]] = None,
             public: Optional[pulumi.Input[bool]] = None,
             statuses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[ClustersResult]
Copy
func Clusters(ctx *Context, args *ClustersArgs, opts ...InvokeOption) (*ClustersResult, error)
func ClustersOutput(ctx *Context, args *ClustersOutputArgs, opts ...InvokeOption) ClustersResultOutput
Copy
public static class Clusters 
{
    public static Task<ClustersResult> InvokeAsync(ClustersArgs args, InvokeOptions? opts = null)
    public static Output<ClustersResult> Invoke(ClustersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ClustersResult> clusters(ClustersArgs args, InvokeOptions options)
public static Output<ClustersResult> clusters(ClustersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: volcengine:bioos:Clusters
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Ids List<string>
A list of cluster ids.
OutputFile string
File name where to save data source results.
Public bool
whether it is a public cluster.
Statuses List<string>
The status of the clusters.
Types List<string>
The type of the clusters.
Ids []string
A list of cluster ids.
OutputFile string
File name where to save data source results.
Public bool
whether it is a public cluster.
Statuses []string
The status of the clusters.
Types []string
The type of the clusters.
ids List<String>
A list of cluster ids.
outputFile String
File name where to save data source results.
public_ Boolean
whether it is a public cluster.
statuses List<String>
The status of the clusters.
types List<String>
The type of the clusters.
ids string[]
A list of cluster ids.
outputFile string
File name where to save data source results.
public boolean
whether it is a public cluster.
statuses string[]
The status of the clusters.
types string[]
The type of the clusters.
ids Sequence[str]
A list of cluster ids.
output_file str
File name where to save data source results.
public bool
whether it is a public cluster.
statuses Sequence[str]
The status of the clusters.
types Sequence[str]
The type of the clusters.
ids List<String>
A list of cluster ids.
outputFile String
File name where to save data source results.
public Boolean
whether it is a public cluster.
statuses List<String>
The status of the clusters.
types List<String>
The type of the clusters.

Clusters Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Items List<ClustersItem>
The list of clusters.
TotalCount int
The total count of Cluster query.
Ids List<string>
OutputFile string
Public bool
whether it is a public cluster.
Statuses List<string>
The status of the cluster.
Types List<string>
Id string
The provider-assigned unique ID for this managed resource.
Items []ClustersItem
The list of clusters.
TotalCount int
The total count of Cluster query.
Ids []string
OutputFile string
Public bool
whether it is a public cluster.
Statuses []string
The status of the cluster.
Types []string
id String
The provider-assigned unique ID for this managed resource.
items List<ClustersItem>
The list of clusters.
totalCount Integer
The total count of Cluster query.
ids List<String>
outputFile String
public_ Boolean
whether it is a public cluster.
statuses List<String>
The status of the cluster.
types List<String>
id string
The provider-assigned unique ID for this managed resource.
items ClustersItem[]
The list of clusters.
totalCount number
The total count of Cluster query.
ids string[]
outputFile string
public boolean
whether it is a public cluster.
statuses string[]
The status of the cluster.
types string[]
id str
The provider-assigned unique ID for this managed resource.
items Sequence[ClustersItem]
The list of clusters.
total_count int
The total count of Cluster query.
ids Sequence[str]
output_file str
public bool
whether it is a public cluster.
statuses Sequence[str]
The status of the cluster.
types Sequence[str]
id String
The provider-assigned unique ID for this managed resource.
items List<Property Map>
The list of clusters.
totalCount Number
The total count of Cluster query.
ids List<String>
outputFile String
public Boolean
whether it is a public cluster.
statuses List<String>
The status of the cluster.
types List<String>

Supporting Types

ClustersItem

Bound This property is required. bool
Whether there is a bound workspace.
Description This property is required. string
The description of the cluster.
Id This property is required. string
The id of the bioos cluster.
Name This property is required. string
The name of the cluster.
Public This property is required. bool
whether it is a public cluster.
SharedConfigs This property is required. List<ClustersItemSharedConfig>
The configuration of the shared cluster.
StartTime This property is required. int
The start time of the cluster.
Status This property is required. string
The status of the clusters.
StoppedTime This property is required. int
The end time of the cluster.
VkeConfigId This property is required. string
The id of the vke cluster.
VkeConfigStorageClass This property is required. string
The name of the StorageClass that the vke cluster has installed.
Bound This property is required. bool
Whether there is a bound workspace.
Description This property is required. string
The description of the cluster.
Id This property is required. string
The id of the bioos cluster.
Name This property is required. string
The name of the cluster.
Public This property is required. bool
whether it is a public cluster.
SharedConfigs This property is required. []ClustersItemSharedConfig
The configuration of the shared cluster.
StartTime This property is required. int
The start time of the cluster.
Status This property is required. string
The status of the clusters.
StoppedTime This property is required. int
The end time of the cluster.
VkeConfigId This property is required. string
The id of the vke cluster.
VkeConfigStorageClass This property is required. string
The name of the StorageClass that the vke cluster has installed.
bound This property is required. Boolean
Whether there is a bound workspace.
description This property is required. String
The description of the cluster.
id This property is required. String
The id of the bioos cluster.
name This property is required. String
The name of the cluster.
public_ This property is required. Boolean
whether it is a public cluster.
sharedConfigs This property is required. List<ClustersItemSharedConfig>
The configuration of the shared cluster.
startTime This property is required. Integer
The start time of the cluster.
status This property is required. String
The status of the clusters.
stoppedTime This property is required. Integer
The end time of the cluster.
vkeConfigId This property is required. String
The id of the vke cluster.
vkeConfigStorageClass This property is required. String
The name of the StorageClass that the vke cluster has installed.
bound This property is required. boolean
Whether there is a bound workspace.
description This property is required. string
The description of the cluster.
id This property is required. string
The id of the bioos cluster.
name This property is required. string
The name of the cluster.
public This property is required. boolean
whether it is a public cluster.
sharedConfigs This property is required. ClustersItemSharedConfig[]
The configuration of the shared cluster.
startTime This property is required. number
The start time of the cluster.
status This property is required. string
The status of the clusters.
stoppedTime This property is required. number
The end time of the cluster.
vkeConfigId This property is required. string
The id of the vke cluster.
vkeConfigStorageClass This property is required. string
The name of the StorageClass that the vke cluster has installed.
bound This property is required. bool
Whether there is a bound workspace.
description This property is required. str
The description of the cluster.
id This property is required. str
The id of the bioos cluster.
name This property is required. str
The name of the cluster.
public This property is required. bool
whether it is a public cluster.
shared_configs This property is required. Sequence[ClustersItemSharedConfig]
The configuration of the shared cluster.
start_time This property is required. int
The start time of the cluster.
status This property is required. str
The status of the clusters.
stopped_time This property is required. int
The end time of the cluster.
vke_config_id This property is required. str
The id of the vke cluster.
vke_config_storage_class This property is required. str
The name of the StorageClass that the vke cluster has installed.
bound This property is required. Boolean
Whether there is a bound workspace.
description This property is required. String
The description of the cluster.
id This property is required. String
The id of the bioos cluster.
name This property is required. String
The name of the cluster.
public This property is required. Boolean
whether it is a public cluster.
sharedConfigs This property is required. List<Property Map>
The configuration of the shared cluster.
startTime This property is required. Number
The start time of the cluster.
status This property is required. String
The status of the clusters.
stoppedTime This property is required. Number
The end time of the cluster.
vkeConfigId This property is required. String
The id of the vke cluster.
vkeConfigStorageClass This property is required. String
The name of the StorageClass that the vke cluster has installed.

ClustersItemSharedConfig

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

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