cockroach.Cluster
Explore with Pulumi AI
Cluster Resource
Create Cluster Resource
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
cloud_provider: Optional[str] = None,
cockroach_version: Optional[str] = None,
dedicated: Optional[ClusterDedicatedArgs] = None,
name: Optional[str] = None,
regions: Optional[Sequence[ClusterRegionArgs]] = None,
serverless: Optional[ClusterServerlessArgs] = None)
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = 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.
- 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:
- Cloud
Provider string - Name string
Name of cluster
- Regions
[]Cluster
Region Args - Cockroach
Version string - Dedicated
Cluster
Dedicated Args - Serverless
Cluster
Serverless Args
- cloud
Provider String - name String
Name of cluster
- regions
List<Cluster
Region> - cockroach
Version String - dedicated
Cluster
Dedicated - serverless
Cluster
Serverless
- cloud
Provider string - name string
Name of cluster
- regions
Cluster
Region[] - cockroach
Version string - dedicated
Cluster
Dedicated - serverless
Cluster
Serverless
- cloud
Provider String - name String
Name of cluster
- regions List<Property Map>
- cockroach
Version String - dedicated Property Map
- serverless Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Account
Id string - Cluster
Id string The ID of this resource.
- Creator
Id string - Id string
The provider-assigned unique ID for this managed resource.
- Operation
Status string - Plan string
- State string
- Upgrade
Status string
- Account
Id string - Cluster
Id string The ID of this resource.
- Creator
Id string - Id string
The provider-assigned unique ID for this managed resource.
- Operation
Status string - Plan string
- State string
- Upgrade
Status string
- account
Id String - cluster
Id String The ID of this resource.
- creator
Id String - id String
The provider-assigned unique ID for this managed resource.
- operation
Status String - plan String
- state String
- upgrade
Status String
- account
Id string - cluster
Id string The ID of this resource.
- creator
Id string - id string
The provider-assigned unique ID for this managed resource.
- operation
Status string - plan string
- state string
- upgrade
Status string
- account_
id str - cluster_
id str The ID of this resource.
- creator_
id str - id str
The provider-assigned unique ID for this managed resource.
- operation_
status str - plan str
- state str
- upgrade_
status str
- account
Id String - cluster
Id String The ID of this resource.
- creator
Id String - id String
The provider-assigned unique ID for this managed resource.
- operation
Status String - plan String
- state String
- upgrade
Status 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,
account_id: Optional[str] = None,
cloud_provider: Optional[str] = None,
cluster_id: Optional[str] = None,
cockroach_version: Optional[str] = None,
creator_id: Optional[str] = None,
dedicated: Optional[ClusterDedicatedArgs] = None,
name: Optional[str] = None,
operation_status: 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.
- Account
Id string - Cloud
Provider string - Cluster
Id string The ID of this resource.
- Cockroach
Version string - Creator
Id string - Dedicated
Lbrlabs.
Pulumi Package. Cockroach. Inputs. Cluster Dedicated - Name string
Name of cluster
- Operation
Status string - Plan string
- Regions
List<Lbrlabs.
Pulumi Package. Cockroach. Inputs. Cluster Region> - Serverless
Lbrlabs.
Pulumi Package. Cockroach. Inputs. Cluster Serverless - State string
- Upgrade
Status string
- Account
Id string - Cloud
Provider string - Cluster
Id string The ID of this resource.
- Cockroach
Version string - Creator
Id string - Dedicated
Cluster
Dedicated Args - Name string
Name of cluster
- Operation
Status string - Plan string
- Regions
[]Cluster
Region Args - Serverless
Cluster
Serverless Args - State string
- Upgrade
Status string
- account
Id String - cloud
Provider String - cluster
Id String The ID of this resource.
- cockroach
Version String - creator
Id String - dedicated
Cluster
Dedicated - name String
Name of cluster
- operation
Status String - plan String
- regions
List<Cluster
Region> - serverless
Cluster
Serverless - state String
- upgrade
Status String
- account
Id string - cloud
Provider string - cluster
Id string The ID of this resource.
- cockroach
Version string - creator
Id string - dedicated
Cluster
Dedicated - name string
Name of cluster
- operation
Status string - plan string
- regions
Cluster
Region[] - serverless
Cluster
Serverless - state string
- upgrade
Status string
- account_
id str - cloud_
provider str - cluster_
id str The ID of this resource.
- cockroach_
version str - creator_
id str - dedicated
Cluster
Dedicated Args - name str
Name of cluster
- operation_
status str - plan str
- regions
Sequence[Cluster
Region Args] - serverless
Cluster
Serverless Args - state str
- upgrade_
status str
- account
Id String - cloud
Provider String - cluster
Id String The ID of this resource.
- cockroach
Version String - creator
Id String - dedicated Property Map
- name String
Name of cluster
- operation
Status String - plan String
- regions List<Property Map>
- serverless Property Map
- state String
- upgrade
Status String
Supporting Types
ClusterDedicated, ClusterDedicatedArgs
- Disk
Iops int - Machine
Type string - Memory
Gib double - Num
Virtual intCpus - Private
Network boolVisibility Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- Storage
Gib int
- Disk
Iops int - Machine
Type string - Memory
Gib float64 - Num
Virtual intCpus - Private
Network boolVisibility Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- Storage
Gib int
- disk
Iops Integer - machine
Type String - memory
Gib Double - num
Virtual IntegerCpus - private
Network BooleanVisibility Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- storage
Gib Integer
- disk
Iops number - machine
Type string - memory
Gib number - num
Virtual numberCpus - private
Network booleanVisibility Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- storage
Gib number
- disk_
iops int - machine_
type str - memory_
gib float - num_
virtual_ intcpus - private_
network_ boolvisibility Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- storage_
gib int
- disk
Iops Number - machine
Type String - memory
Gib Number - num
Virtual NumberCpus - private
Network BooleanVisibility Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- storage
Gib Number
ClusterRegion, ClusterRegionArgs
- name str
Name of cluster
- node_
count int - 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 - ui_
dns str
ClusterServerless, ClusterServerlessArgs
- Routing
Id string - Spend
Limit int Spend limit in US cents.
- Usage
Limits Lbrlabs.Pulumi Package. Cockroach. Inputs. Cluster Serverless Usage Limits
- Routing
Id string - Spend
Limit int Spend limit in US cents.
- Usage
Limits ClusterServerless Usage Limits
- routing
Id String - spend
Limit Integer Spend limit in US cents.
- usage
Limits ClusterServerless Usage Limits
- routing
Id string - spend
Limit number Spend limit in US cents.
- usage
Limits ClusterServerless Usage Limits
- routing_
id str - spend_
limit int Spend limit in US cents.
- usage_
limits ClusterServerless Usage Limits
- routing
Id String - spend
Limit Number Spend limit in US cents.
- usage
Limits Property Map
ClusterServerlessUsageLimits, ClusterServerlessUsageLimitsArgs
- Request
Unit intLimit - Storage
Mib intLimit
- Request
Unit intLimit - Storage
Mib intLimit
- request
Unit IntegerLimit - storage
Mib IntegerLimit
- request
Unit numberLimit - storage
Mib numberLimit
- request
Unit NumberLimit - storage
Mib NumberLimit
Package Details
- Repository
- cockroach lbrlabs/pulumi-cockroach
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
cockroach
Terraform Provider.