Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. Cluster
CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.Cluster

Explore with Pulumi AI

cockroach logo
CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    CockroachDB Cloud cluster.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cockroach.Cluster;
import com.pulumi.cockroach.ClusterArgs;
import com.pulumi.cockroach.inputs.ClusterDedicatedArgs;
import com.pulumi.cockroach.inputs.ClusterRegionArgs;
import com.pulumi.cockroach.inputs.ClusterServerlessArgs;
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 advanced = new Cluster("advanced", ClusterArgs.builder()
            .name("cockroach-advanced")
            .cloudProvider("GCP")
            .plan("ADVANCED")
            .dedicated(ClusterDedicatedArgs.builder()
                .storage_gib(15)
                .machine_type("n2-standard-4")
                .build())
            .regions(ClusterRegionArgs.builder()
                .name("us-central1")
                .node_count(1)
                .build())
            .deleteProtection(true)
            .build());

        var standard = new Cluster("standard", ClusterArgs.builder()
            .name("cockroach-standard")
            .cloudProvider("GCP")
            .plan("STANDARD")
            .serverless(ClusterServerlessArgs.builder()
                .usage_limits(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .upgrade_type("AUTOMATIC")
                .build())
            .regions(ClusterRegionArgs.builder()
                .name("us-east1")
                .build())
            .deleteProtection(false)
            .build());

        var basic = new Cluster("basic", ClusterArgs.builder()
            .name("cockroach-basic")
            .cloudProvider("GCP")
            .plan("BASIC")
            .serverless()
            .regions(ClusterRegionArgs.builder()
                .name("us-east1")
                .build())
            .deleteProtection(false)
            .build());

    }
}

    resources:
  advanced:
    type: cockroach:Cluster
    properties:
      name: cockroach-advanced
      cloudProvider: GCP
      plan: ADVANCED
      dedicated:
        storage_gib: 15
        machine_type: n2-standard-4
      regions:
        - name: us-central1
          node_count: 1
      deleteProtection: true
  standard:
    type: cockroach:Cluster
    properties:
      name: cockroach-standard
      cloudProvider: GCP
      plan: STANDARD
      serverless:
        usage_limits:
          provisionedVirtualCpus: 2
        upgrade_type: AUTOMATIC
      regions:
        - name: us-east1
      deleteProtection: false
  basic:
    type: cockroach:Cluster
    properties:
      name: cockroach-basic
      cloudProvider: GCP
      plan: BASIC
      serverless: {}
      regions:
        - name: us-east1
      deleteProtection: false

    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,
            cloud_provider: Optional[str] = None,
            name: Optional[str] = None,
            regions: Optional[Sequence[ClusterRegionArgs]] = None,
            cockroach_version: Optional[str] = None,
            dedicated: Optional[ClusterDedicatedArgs] = None,
            delete_protection: Optional[bool] = None,
            parent_id: Optional[str] = None,
            plan: Optional[str] = None,
            serverless: Optional[ClusterServerlessArgs] = 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: cockroach: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 Cockroach.Cluster("clusterResource", new()
{
    CloudProvider = "string",
    Name = "string",
    Regions = new[]
    {
        new Cockroach.Inputs.ClusterRegionArgs
        {
            Name = "string",
            InternalDns = "string",
            NodeCount = 0,
            Primary = false,
            SqlDns = "string",
            UiDns = "string",
        },
    },
    CockroachVersion = "string",
    Dedicated = new Cockroach.Inputs.ClusterDedicatedArgs
    {
        DiskIops = 0,
        MachineType = "string",
        MemoryGib = 0,
        NumVirtualCpus = 0,
        PrivateNetworkVisibility = false,
        StorageGib = 0,
    },
    DeleteProtection = false,
    ParentId = "string",
    Plan = "string",
    Serverless = new Cockroach.Inputs.ClusterServerlessArgs
    {
        RoutingId = "string",
        UpgradeType = "string",
        UsageLimits = new Cockroach.Inputs.ClusterServerlessUsageLimitsArgs
        {
            ProvisionedVirtualCpus = 0,
            RequestUnitLimit = 0,
            StorageMibLimit = 0,
        },
    },
});

    example, err := cockroach.NewCluster(ctx, "clusterResource", &cockroach.ClusterArgs{
	CloudProvider: pulumi.String("string"),
	Name:          pulumi.String("string"),
	Regions: cockroach.ClusterRegionArray{
		&cockroach.ClusterRegionArgs{
			Name:        pulumi.String("string"),
			InternalDns: pulumi.String("string"),
			NodeCount:   pulumi.Int(0),
			Primary:     pulumi.Bool(false),
			SqlDns:      pulumi.String("string"),
			UiDns:       pulumi.String("string"),
		},
	},
	CockroachVersion: pulumi.String("string"),
	Dedicated: &cockroach.ClusterDedicatedArgs{
		DiskIops:                 pulumi.Int(0),
		MachineType:              pulumi.String("string"),
		MemoryGib:                pulumi.Float64(0),
		NumVirtualCpus:           pulumi.Int(0),
		PrivateNetworkVisibility: pulumi.Bool(false),
		StorageGib:               pulumi.Int(0),
	},
	DeleteProtection: pulumi.Bool(false),
	ParentId:         pulumi.String("string"),
	Plan:             pulumi.String("string"),
	Serverless: &cockroach.ClusterServerlessArgs{
		RoutingId:   pulumi.String("string"),
		UpgradeType: pulumi.String("string"),
		UsageLimits: &cockroach.ClusterServerlessUsageLimitsArgs{
			ProvisionedVirtualCpus: pulumi.Int(0),
			RequestUnitLimit:       pulumi.Int(0),
			StorageMibLimit:        pulumi.Int(0),
		},
	},
})

    var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
    .cloudProvider("string")
    .name("string")
    .regions(ClusterRegionArgs.builder()
        .name("string")
        .internalDns("string")
        .nodeCount(0)
        .primary(false)
        .sqlDns("string")
        .uiDns("string")
        .build())
    .cockroachVersion("string")
    .dedicated(ClusterDedicatedArgs.builder()
        .diskIops(0)
        .machineType("string")
        .memoryGib(0)
        .numVirtualCpus(0)
        .privateNetworkVisibility(false)
        .storageGib(0)
        .build())
    .deleteProtection(false)
    .parentId("string")
    .plan("string")
    .serverless(ClusterServerlessArgs.builder()
        .routingId("string")
        .upgradeType("string")
        .usageLimits(ClusterServerlessUsageLimitsArgs.builder()
            .provisionedVirtualCpus(0)
            .requestUnitLimit(0)
            .storageMibLimit(0)
            .build())
        .build())
    .build());

    cluster_resource = cockroach.Cluster("clusterResource",
    cloud_provider="string",
    name="string",
    regions=[{
        "name": "string",
        "internal_dns": "string",
        "node_count": 0,
        "primary": False,
        "sql_dns": "string",
        "ui_dns": "string",
    }],
    cockroach_version="string",
    dedicated={
        "disk_iops": 0,
        "machine_type": "string",
        "memory_gib": 0,
        "num_virtual_cpus": 0,
        "private_network_visibility": False,
        "storage_gib": 0,
    },
    delete_protection=False,
    parent_id="string",
    plan="string",
    serverless={
        "routing_id": "string",
        "upgrade_type": "string",
        "usage_limits": {
            "provisioned_virtual_cpus": 0,
            "request_unit_limit": 0,
            "storage_mib_limit": 0,
        },
    })

    const clusterResource = new cockroach.Cluster("clusterResource", {
    cloudProvider: "string",
    name: "string",
    regions: [{
        name: "string",
        internalDns: "string",
        nodeCount: 0,
        primary: false,
        sqlDns: "string",
        uiDns: "string",
    }],
    cockroachVersion: "string",
    dedicated: {
        diskIops: 0,
        machineType: "string",
        memoryGib: 0,
        numVirtualCpus: 0,
        privateNetworkVisibility: false,
        storageGib: 0,
    },
    deleteProtection: false,
    parentId: "string",
    plan: "string",
    serverless: {
        routingId: "string",
        upgradeType: "string",
        usageLimits: {
            provisionedVirtualCpus: 0,
            requestUnitLimit: 0,
            storageMibLimit: 0,
        },
    },
});

    type: cockroach:Cluster
properties:
    cloudProvider: string
    cockroachVersion: string
    dedicated:
        diskIops: 0
        machineType: string
        memoryGib: 0
        numVirtualCpus: 0
        privateNetworkVisibility: false
        storageGib: 0
    deleteProtection: false
    name: string
    parentId: string
    plan: string
    regions:
        - internalDns: string
          name: string
          nodeCount: 0
          primary: false
          sqlDns: string
          uiDns: string
    serverless:
        routingId: string
        upgradeType: string
        usageLimits:
            provisionedVirtualCpus: 0
            requestUnitLimit: 0
            storageMibLimit: 0

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Cluster resource accepts the following input properties:

    CloudProvider string
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    Name string
    Name of the cluster.
    Regions List<Pulumiverse.Cockroach.Inputs.ClusterRegion>
    CockroachVersion string
    Major version of CockroachDB running on the cluster.
    Dedicated Pulumiverse.Cockroach.Inputs.ClusterDedicated
    DeleteProtection bool
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    ParentId string
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    Plan string
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    Serverless Pulumiverse.Cockroach.Inputs.ClusterServerless
    CloudProvider string
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    Name string
    Name of the cluster.
    Regions []ClusterRegionArgs
    CockroachVersion string
    Major version of CockroachDB running on the cluster.
    Dedicated ClusterDedicatedArgs
    DeleteProtection bool
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    ParentId string
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    Plan string
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    Serverless ClusterServerlessArgs
    cloudProvider String
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    name String
    Name of the cluster.
    regions List<ClusterRegion>
    cockroachVersion String
    Major version of CockroachDB running on the cluster.
    dedicated ClusterDedicated
    deleteProtection Boolean
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    parentId String
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    plan String
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    serverless ClusterServerless
    cloudProvider string
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    name string
    Name of the cluster.
    regions ClusterRegion[]
    cockroachVersion string
    Major version of CockroachDB running on the cluster.
    dedicated ClusterDedicated
    deleteProtection boolean
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    parentId string
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    plan string
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    serverless ClusterServerless
    cloud_provider str
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    name str
    Name of the cluster.
    regions Sequence[ClusterRegionArgs]
    cockroach_version str
    Major version of CockroachDB running on the cluster.
    dedicated ClusterDedicatedArgs
    delete_protection bool
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    parent_id str
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    plan str
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    serverless ClusterServerlessArgs
    cloudProvider String
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    name String
    Name of the cluster.
    regions List<Property Map>
    cockroachVersion String
    Major version of CockroachDB running on the cluster.
    dedicated Property Map
    deleteProtection Boolean
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    parentId String
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    plan String
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    serverless Property Map

    Outputs

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

    AccountId string
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    CreatorId string
    ID of the user who created the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    OperationStatus string
    Describes the current long-running operation, if any.
    State string
    Describes whether the cluster is being created, updated, deleted, etc.
    UpgradeStatus string
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    AccountId string
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    CreatorId string
    ID of the user who created the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    OperationStatus string
    Describes the current long-running operation, if any.
    State string
    Describes whether the cluster is being created, updated, deleted, etc.
    UpgradeStatus string
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    accountId String
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    creatorId String
    ID of the user who created the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    operationStatus String
    Describes the current long-running operation, if any.
    state String
    Describes whether the cluster is being created, updated, deleted, etc.
    upgradeStatus String
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    accountId string
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    creatorId string
    ID of the user who created the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    operationStatus string
    Describes the current long-running operation, if any.
    state string
    Describes whether the cluster is being created, updated, deleted, etc.
    upgradeStatus string
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    account_id str
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    creator_id str
    ID of the user who created the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    operation_status str
    Describes the current long-running operation, if any.
    state str
    Describes whether the cluster is being created, updated, deleted, etc.
    upgrade_status str
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    accountId String
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    creatorId String
    ID of the user who created the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    operationStatus String
    Describes the current long-running operation, if any.
    state String
    Describes whether the cluster is being created, updated, deleted, etc.
    upgradeStatus String
    Describes the status of any in-progress CockroachDB upgrade or rollback.

    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,
        account_id: Optional[str] = None,
        cloud_provider: Optional[str] = None,
        cockroach_version: Optional[str] = None,
        creator_id: Optional[str] = None,
        dedicated: Optional[ClusterDedicatedArgs] = None,
        delete_protection: Optional[bool] = None,
        name: Optional[str] = None,
        operation_status: Optional[str] = None,
        parent_id: Optional[str] = None,
        plan: Optional[str] = None,
        regions: Optional[Sequence[ClusterRegionArgs]] = None,
        serverless: Optional[ClusterServerlessArgs] = None,
        state: Optional[str] = None,
        upgrade_status: 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:
    AccountId string
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    CloudProvider string
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    CockroachVersion string
    Major version of CockroachDB running on the cluster.
    CreatorId string
    ID of the user who created the cluster.
    Dedicated Pulumiverse.Cockroach.Inputs.ClusterDedicated
    DeleteProtection bool
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    Name string
    Name of the cluster.
    OperationStatus string
    Describes the current long-running operation, if any.
    ParentId string
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    Plan string
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    Regions List<Pulumiverse.Cockroach.Inputs.ClusterRegion>
    Serverless Pulumiverse.Cockroach.Inputs.ClusterServerless
    State string
    Describes whether the cluster is being created, updated, deleted, etc.
    UpgradeStatus string
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    AccountId string
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    CloudProvider string
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    CockroachVersion string
    Major version of CockroachDB running on the cluster.
    CreatorId string
    ID of the user who created the cluster.
    Dedicated ClusterDedicatedArgs
    DeleteProtection bool
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    Name string
    Name of the cluster.
    OperationStatus string
    Describes the current long-running operation, if any.
    ParentId string
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    Plan string
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    Regions []ClusterRegionArgs
    Serverless ClusterServerlessArgs
    State string
    Describes whether the cluster is being created, updated, deleted, etc.
    UpgradeStatus string
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    accountId String
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    cloudProvider String
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    cockroachVersion String
    Major version of CockroachDB running on the cluster.
    creatorId String
    ID of the user who created the cluster.
    dedicated ClusterDedicated
    deleteProtection Boolean
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    name String
    Name of the cluster.
    operationStatus String
    Describes the current long-running operation, if any.
    parentId String
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    plan String
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    regions List<ClusterRegion>
    serverless ClusterServerless
    state String
    Describes whether the cluster is being created, updated, deleted, etc.
    upgradeStatus String
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    accountId string
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    cloudProvider string
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    cockroachVersion string
    Major version of CockroachDB running on the cluster.
    creatorId string
    ID of the user who created the cluster.
    dedicated ClusterDedicated
    deleteProtection boolean
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    name string
    Name of the cluster.
    operationStatus string
    Describes the current long-running operation, if any.
    parentId string
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    plan string
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    regions ClusterRegion[]
    serverless ClusterServerless
    state string
    Describes whether the cluster is being created, updated, deleted, etc.
    upgradeStatus string
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    account_id str
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    cloud_provider str
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    cockroach_version str
    Major version of CockroachDB running on the cluster.
    creator_id str
    ID of the user who created the cluster.
    dedicated ClusterDedicatedArgs
    delete_protection bool
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    name str
    Name of the cluster.
    operation_status str
    Describes the current long-running operation, if any.
    parent_id str
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    plan str
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    regions Sequence[ClusterRegionArgs]
    serverless ClusterServerlessArgs
    state str
    Describes whether the cluster is being created, updated, deleted, etc.
    upgrade_status str
    Describes the status of any in-progress CockroachDB upgrade or rollback.
    accountId String
    The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
    cloudProvider String
    Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
    cockroachVersion String
    Major version of CockroachDB running on the cluster.
    creatorId String
    ID of the user who created the cluster.
    dedicated Property Map
    deleteProtection Boolean
    Set to true to enable delete protection on the cluster. If unset, the server chooses the value on cluster creation, and preserves the value on cluster update.
    name String
    Name of the cluster.
    operationStatus String
    Describes the current long-running operation, if any.
    parentId String
    The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
    plan String
    Denotes cluster plan type: 'BASIC' or 'STANDARD' or 'ADVANCED'.
    regions List<Property Map>
    serverless Property Map
    state String
    Describes whether the cluster is being created, updated, deleted, etc.
    upgradeStatus String
    Describes the status of any in-progress CockroachDB upgrade or rollback.

    Supporting Types

    ClusterDedicated, ClusterDedicatedArgs

    DiskIops int
    Number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default.
    MachineType string
    Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
    MemoryGib double
    Memory per node in GiB.
    NumVirtualCpus int
    Number of virtual CPUs per node in the cluster.
    PrivateNetworkVisibility bool
    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
    StorageGib int
    Storage amount per node in GiB.
    DiskIops int
    Number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default.
    MachineType string
    Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
    MemoryGib float64
    Memory per node in GiB.
    NumVirtualCpus int
    Number of virtual CPUs per node in the cluster.
    PrivateNetworkVisibility bool
    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
    StorageGib int
    Storage amount per node in GiB.
    diskIops Integer
    Number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default.
    machineType String
    Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
    memoryGib Double
    Memory per node in GiB.
    numVirtualCpus Integer
    Number of virtual CPUs per node in the cluster.
    privateNetworkVisibility Boolean
    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
    storageGib Integer
    Storage amount per node in GiB.
    diskIops number
    Number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default.
    machineType string
    Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
    memoryGib number
    Memory per node in GiB.
    numVirtualCpus number
    Number of virtual CPUs per node in the cluster.
    privateNetworkVisibility boolean
    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
    storageGib number
    Storage amount per node in GiB.
    disk_iops int
    Number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default.
    machine_type str
    Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
    memory_gib float
    Memory per node in GiB.
    num_virtual_cpus int
    Number of virtual CPUs per node in the cluster.
    private_network_visibility bool
    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
    storage_gib int
    Storage amount per node in GiB.
    diskIops Number
    Number of disk I/O operations per second that are permitted on each node in the cluster. Zero indicates the cloud provider-specific default.
    machineType String
    Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
    memoryGib Number
    Memory per node in GiB.
    numVirtualCpus Number
    Number of virtual CPUs per node in the cluster.
    privateNetworkVisibility Boolean
    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
    storageGib Number
    Storage amount per node in GiB.

    ClusterRegion, ClusterRegionArgs

    Name string
    Name of the region. Should match the region code used by the cluster's cloud provider.
    InternalDns string
    Internal DNS name of the cluster within the cloud provider's network. Used to connect to the cluster with PrivateLink or VPC peering.
    NodeCount int
    Number of nodes in the region. Will always be 0 for serverless clusters.
    Primary bool
    Set to true to mark this region as the primary for a serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
    SqlDns string
    DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
    UiDns string
    DNS name used when connecting to the DB Console for the cluster.
    Name string
    Name of the region. Should match the region code used by the cluster's cloud provider.
    InternalDns string
    Internal DNS name of the cluster within the cloud provider's network. Used to connect to the cluster with PrivateLink or VPC peering.
    NodeCount int
    Number of nodes in the region. Will always be 0 for serverless clusters.
    Primary bool
    Set to true to mark this region as the primary for a serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
    SqlDns string
    DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
    UiDns string
    DNS name used when connecting to the DB Console for the cluster.
    name String
    Name of the region. Should match the region code used by the cluster's cloud provider.
    internalDns String
    Internal DNS name of the cluster within the cloud provider's network. Used to connect to the cluster with PrivateLink or VPC peering.
    nodeCount Integer
    Number of nodes in the region. Will always be 0 for serverless clusters.
    primary Boolean
    Set to true to mark this region as the primary for a serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
    sqlDns String
    DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
    uiDns String
    DNS name used when connecting to the DB Console for the cluster.
    name string
    Name of the region. Should match the region code used by the cluster's cloud provider.
    internalDns string
    Internal DNS name of the cluster within the cloud provider's network. Used to connect to the cluster with PrivateLink or VPC peering.
    nodeCount number
    Number of nodes in the region. Will always be 0 for serverless clusters.
    primary boolean
    Set to true to mark this region as the primary for a serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
    sqlDns string
    DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
    uiDns string
    DNS name used when connecting to the DB Console for the cluster.
    name str
    Name of the region. Should match the region code used by the cluster's cloud provider.
    internal_dns str
    Internal DNS name of the cluster within the cloud provider's network. Used to connect to the cluster with PrivateLink or VPC peering.
    node_count int
    Number of nodes in the region. Will always be 0 for serverless clusters.
    primary bool
    Set to true to mark this region as the primary for a serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
    sql_dns str
    DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
    ui_dns str
    DNS name used when connecting to the DB Console for the cluster.
    name String
    Name of the region. Should match the region code used by the cluster's cloud provider.
    internalDns String
    Internal DNS name of the cluster within the cloud provider's network. Used to connect to the cluster with PrivateLink or VPC peering.
    nodeCount Number
    Number of nodes in the region. Will always be 0 for serverless clusters.
    primary Boolean
    Set to true to mark this region as the primary for a serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
    sqlDns String
    DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
    uiDns String
    DNS name used when connecting to the DB Console for the cluster.

    ClusterServerless, ClusterServerlessArgs

    RoutingId string
    Cluster identifier in a connection string.
    SpendLimit int
    Spend limit in US cents.

    Deprecated: The spend_limit attribute is deprecated and will be removed in a future release of the provider. Configure 'usage_limits' instead.

    UpgradeType string
    Dictates the behavior of cockroach major version upgrades. If plan type is 'BASIC', this attribute must be left empty or set to 'AUTOMATIC'. Allowed values are:

    • MANUAL
    • AUTOMATIC
    UsageLimits Pulumiverse.Cockroach.Inputs.ClusterServerlessUsageLimits
    RoutingId string
    Cluster identifier in a connection string.
    SpendLimit int
    Spend limit in US cents.

    Deprecated: The spend_limit attribute is deprecated and will be removed in a future release of the provider. Configure 'usage_limits' instead.

    UpgradeType string
    Dictates the behavior of cockroach major version upgrades. If plan type is 'BASIC', this attribute must be left empty or set to 'AUTOMATIC'. Allowed values are:

    • MANUAL
    • AUTOMATIC
    UsageLimits ClusterServerlessUsageLimits
    routingId String
    Cluster identifier in a connection string.
    spendLimit Integer
    Spend limit in US cents.

    Deprecated: The spend_limit attribute is deprecated and will be removed in a future release of the provider. Configure 'usage_limits' instead.

    upgradeType String
    Dictates the behavior of cockroach major version upgrades. If plan type is 'BASIC', this attribute must be left empty or set to 'AUTOMATIC'. Allowed values are:

    • MANUAL
    • AUTOMATIC
    usageLimits ClusterServerlessUsageLimits
    routingId string
    Cluster identifier in a connection string.
    spendLimit number
    Spend limit in US cents.

    Deprecated: The spend_limit attribute is deprecated and will be removed in a future release of the provider. Configure 'usage_limits' instead.

    upgradeType string
    Dictates the behavior of cockroach major version upgrades. If plan type is 'BASIC', this attribute must be left empty or set to 'AUTOMATIC'. Allowed values are:

    • MANUAL
    • AUTOMATIC
    usageLimits ClusterServerlessUsageLimits
    routing_id str
    Cluster identifier in a connection string.
    spend_limit int
    Spend limit in US cents.

    Deprecated: The spend_limit attribute is deprecated and will be removed in a future release of the provider. Configure 'usage_limits' instead.

    upgrade_type str
    Dictates the behavior of cockroach major version upgrades. If plan type is 'BASIC', this attribute must be left empty or set to 'AUTOMATIC'. Allowed values are:

    • MANUAL
    • AUTOMATIC
    usage_limits ClusterServerlessUsageLimits
    routingId String
    Cluster identifier in a connection string.
    spendLimit Number
    Spend limit in US cents.

    Deprecated: The spend_limit attribute is deprecated and will be removed in a future release of the provider. Configure 'usage_limits' instead.

    upgradeType String
    Dictates the behavior of cockroach major version upgrades. If plan type is 'BASIC', this attribute must be left empty or set to 'AUTOMATIC'. Allowed values are:

    • MANUAL
    • AUTOMATIC
    usageLimits Property Map

    ClusterServerlessUsageLimits, ClusterServerlessUsageLimitsArgs

    ProvisionedVirtualCpus int
    Maximum number of vCPUs that the cluster can use.
    RequestUnitLimit int
    Maximum number of Request Units that the cluster can consume during the month.
    StorageMibLimit int
    Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
    ProvisionedVirtualCpus int
    Maximum number of vCPUs that the cluster can use.
    RequestUnitLimit int
    Maximum number of Request Units that the cluster can consume during the month.
    StorageMibLimit int
    Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
    provisionedVirtualCpus Integer
    Maximum number of vCPUs that the cluster can use.
    requestUnitLimit Integer
    Maximum number of Request Units that the cluster can consume during the month.
    storageMibLimit Integer
    Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
    provisionedVirtualCpus number
    Maximum number of vCPUs that the cluster can use.
    requestUnitLimit number
    Maximum number of Request Units that the cluster can consume during the month.
    storageMibLimit number
    Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
    provisioned_virtual_cpus int
    Maximum number of vCPUs that the cluster can use.
    request_unit_limit int
    Maximum number of Request Units that the cluster can consume during the month.
    storage_mib_limit int
    Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
    provisionedVirtualCpus Number
    Maximum number of vCPUs that the cluster can use.
    requestUnitLimit Number
    Maximum number of Request Units that the cluster can consume during the month.
    storageMibLimit Number
    Maximum amount of storage (in MiB) that the cluster can have at any time during the month.

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach