Docs
Packagesbuildkite.Cluster.Cluster
Explore with Pulumi AI
# Resource: cluster
This resource allows you to create, manage and import Clusters.
Buildkite documentation: https://buildkite.com/docs/clusters/overview
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Buildkite = Pulumiverse.Buildkite;
return await Deployment.RunAsync(() =>
{
var linux = new Buildkite.Cluster.Cluster("linux");
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/Cluster"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Cluster.NewCluster(ctx, "linux", nil)
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.buildkite.Cluster.Cluster;
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 linux = new Cluster("linux");
}
}
import pulumi
import pulumiverse_buildkite as buildkite
linux = buildkite.cluster.Cluster("linux")
import * as pulumi from "@pulumi/pulumi";
import * as buildkite from "@pulumiverse/buildkite";
const linux = new buildkite.cluster.Cluster("linux", {});
resources:
linux:
type: buildkite:Cluster:Cluster
Create Cluster Resource
new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
color: Optional[str] = None,
description: Optional[str] = None,
emoji: Optional[str] = None,
name: Optional[str] = None)
@overload
def Cluster(resource_name: str,
args: Optional[ClusterArgs] = None,
opts: Optional[ResourceOptions] = 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: buildkite:Cluster:Cluster
properties: # The arguments to resource properties.
options: # 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.
- 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.
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:
- Color string
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- Description string
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- Emoji string
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- Name string
This is the name of the cluster.
- Color string
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- Description string
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- Emoji string
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- Name string
This is the name of the cluster.
- color String
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- description String
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- emoji String
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- name String
This is the name of the cluster.
- color string
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- description string
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- emoji string
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- name string
This is the name of the cluster.
- color str
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- description str
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- emoji str
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- name str
This is the name of the cluster.
- color String
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- description String
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- emoji String
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- name String
This is the name of the cluster.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
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,
color: Optional[str] = None,
description: Optional[str] = None,
emoji: Optional[str] = None,
name: Optional[str] = None,
uuid: Optional[str] = None) -> Clusterfunc 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.
- Color string
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- Description string
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- Emoji string
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- Name string
This is the name of the cluster.
- Uuid string
The UUID created with the Cluster.
- Color string
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- Description string
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- Emoji string
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- Name string
This is the name of the cluster.
- Uuid string
The UUID created with the Cluster.
- color String
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- description String
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- emoji String
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- name String
This is the name of the cluster.
- uuid String
The UUID created with the Cluster.
- color string
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- description string
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- emoji string
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- name string
This is the name of the cluster.
- uuid string
The UUID created with the Cluster.
- color str
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- description str
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- emoji str
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- name str
This is the name of the cluster.
- uuid str
The UUID created with the Cluster.
- color String
A color to associate with the Cluster. Perhaps a team related color, or one related to an environment. This is set using hex value, such as
#BADA55.- description String
This is a description for the cluster, this may describe the usage for it, the region, or something else which would help identify the Cluster's purpose.
- emoji String
An emoji to use with the Cluster, this can either be set using
:buildkite:notation, or with the emoji itself, such as 😎.- name String
This is the name of the cluster.
- uuid String
The UUID created with the Cluster.
Package Details
- Repository
- buildkite pulumiverse/pulumi-buildkite
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
buildkiteTerraform Provider.