Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Symbiosis
  3. API Docs
  4. Cluster
Symbiosis v1.0.4 published on Thursday, Mar 16, 2023 by Symbiosis
symbiosis-cloud/pulumi-symbiosis

symbiosis.Cluster

Explore with Pulumi AI

symbiosis logo
Symbiosis v1.0.4 published on Thursday, Mar 16, 2023 by Symbiosis
symbiosis-cloud/pulumi-symbiosis

    Manages Kubernetes clusters.

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Symbiosis = Symbiosis.Pulumi.Symbiosis;

return await Deployment.RunAsync(() => 
{
    var example = new Symbiosis.Cluster("example", new()
    {
        Region = "germany-1",
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/symbiosis-cloud/pulumi-symbiosis/sdk/go/symbiosis"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := symbiosis.NewCluster(ctx, "example", &symbiosis.ClusterArgs{
			Region: pulumi.String("germany-1"),
		})
		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.symbiosis.Cluster;
import com.pulumi.symbiosis.ClusterArgs;
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 example = new Cluster("example", ClusterArgs.builder()        
            .region("germany-1")
            .build());

    }
}

    import pulumi
import symbiosis_pulumi as symbiosis

example = symbiosis.Cluster("example", region="germany-1")

    import * as pulumi from "@pulumi/pulumi";
import * as symbiosis from "@symbiosis-cloud/symbiosis-pulumi";

const example = new symbiosis.Cluster("example", {region: "germany-1"});

    resources:
  example:
    type: symbiosis:Cluster
    properties:
      region: germany-1

    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: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            region: Optional[str] = None,
            is_highly_available: Optional[bool] = None,
            kube_version: Optional[str] = None,
            name: Optional[str] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: symbiosis: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.

    Constructor example

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

    var clusterResource = new Symbiosis.Cluster("clusterResource", new()
{
    Region = "string",
    IsHighlyAvailable = false,
    KubeVersion = "string",
    Name = "string",
});

    example, err := symbiosis.NewCluster(ctx, "clusterResource", &symbiosis.ClusterArgs{
	Region:            pulumi.String("string"),
	IsHighlyAvailable: pulumi.Bool(false),
	KubeVersion:       pulumi.String("string"),
	Name:              pulumi.String("string"),
})

    var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
    .region("string")
    .isHighlyAvailable(false)
    .kubeVersion("string")
    .name("string")
    .build());

    cluster_resource = symbiosis.Cluster("clusterResource",
    region="string",
    is_highly_available=False,
    kube_version="string",
    name="string")

    const clusterResource = new symbiosis.Cluster("clusterResource", {
    region: "string",
    isHighlyAvailable: false,
    kubeVersion: "string",
    name: "string",
});

    type: symbiosis:Cluster
properties:
    isHighlyAvailable: false
    kubeVersion: string
    name: string
    region: 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:

    Region string
    IsHighlyAvailable bool
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    KubeVersion string
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    Name string
    Cluster name. Changing the name forces re-creation.
    Region string
    IsHighlyAvailable bool
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    KubeVersion string
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    Name string
    Cluster name. Changing the name forces re-creation.
    region String
    isHighlyAvailable Boolean
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    kubeVersion String
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    name String
    Cluster name. Changing the name forces re-creation.
    region string
    isHighlyAvailable boolean
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    kubeVersion string
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    name string
    Cluster name. Changing the name forces re-creation.
    region str
    is_highly_available bool
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    kube_version str
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    name str
    Cluster name. Changing the name forces re-creation.
    region String
    isHighlyAvailable Boolean
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    kubeVersion String
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    name String
    Cluster name. Changing the name forces re-creation.

    Outputs

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

    CaCertificate string
    Certificate string
    Endpoint string
    Cluster API server endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    Kubeconfig string
    The raw kubeconfig file.
    PrivateKey string
    CaCertificate string
    Certificate string
    Endpoint string
    Cluster API server endpoint
    Id string
    The provider-assigned unique ID for this managed resource.
    Kubeconfig string
    The raw kubeconfig file.
    PrivateKey string
    caCertificate String
    certificate String
    endpoint String
    Cluster API server endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfig String
    The raw kubeconfig file.
    privateKey String
    caCertificate string
    certificate string
    endpoint string
    Cluster API server endpoint
    id string
    The provider-assigned unique ID for this managed resource.
    kubeconfig string
    The raw kubeconfig file.
    privateKey string
    ca_certificate str
    certificate str
    endpoint str
    Cluster API server endpoint
    id str
    The provider-assigned unique ID for this managed resource.
    kubeconfig str
    The raw kubeconfig file.
    private_key str
    caCertificate String
    certificate String
    endpoint String
    Cluster API server endpoint
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfig String
    The raw kubeconfig file.
    privateKey String

    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,
        ca_certificate: Optional[str] = None,
        certificate: Optional[str] = None,
        endpoint: Optional[str] = None,
        is_highly_available: Optional[bool] = None,
        kube_version: Optional[str] = None,
        kubeconfig: Optional[str] = None,
        name: Optional[str] = None,
        private_key: Optional[str] = None,
        region: Optional[str] = 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:
    CaCertificate string
    Certificate string
    Endpoint string
    Cluster API server endpoint
    IsHighlyAvailable bool
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    KubeVersion string
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    Kubeconfig string
    The raw kubeconfig file.
    Name string
    Cluster name. Changing the name forces re-creation.
    PrivateKey string
    Region string
    CaCertificate string
    Certificate string
    Endpoint string
    Cluster API server endpoint
    IsHighlyAvailable bool
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    KubeVersion string
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    Kubeconfig string
    The raw kubeconfig file.
    Name string
    Cluster name. Changing the name forces re-creation.
    PrivateKey string
    Region string
    caCertificate String
    certificate String
    endpoint String
    Cluster API server endpoint
    isHighlyAvailable Boolean
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    kubeVersion String
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    kubeconfig String
    The raw kubeconfig file.
    name String
    Cluster name. Changing the name forces re-creation.
    privateKey String
    region String
    caCertificate string
    certificate string
    endpoint string
    Cluster API server endpoint
    isHighlyAvailable boolean
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    kubeVersion string
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    kubeconfig string
    The raw kubeconfig file.
    name string
    Cluster name. Changing the name forces re-creation.
    privateKey string
    region string
    ca_certificate str
    certificate str
    endpoint str
    Cluster API server endpoint
    is_highly_available bool
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    kube_version str
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    kubeconfig str
    The raw kubeconfig file.
    name str
    Cluster name. Changing the name forces re-creation.
    private_key str
    region str
    caCertificate String
    certificate String
    endpoint String
    Cluster API server endpoint
    isHighlyAvailable Boolean
    When set to true it will deploy a highly available control plane with multiple replicas for redundancy.
    kubeVersion String
    Kubernetes version, see symbiosis.host for valid values or "latest" for the most recent supported version.
    kubeconfig String
    The raw kubeconfig file.
    name String
    Cluster name. Changing the name forces re-creation.
    privateKey String
    region String

    Package Details

    Repository
    symbiosis symbiosis-cloud/pulumi-symbiosis
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the symbiosis Terraform Provider.
    symbiosis logo
    Symbiosis v1.0.4 published on Thursday, Mar 16, 2023 by Symbiosis
    symbiosis-cloud/pulumi-symbiosis