CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
cockroach.Cluster
Explore with Pulumi AI
CockroachDB Cloud cluster. Can be Dedicated or Serverless.
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,
parent_id: 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,
},
ParentId = "string",
Serverless = new Cockroach.Inputs.ClusterServerlessArgs
{
RoutingId = "string",
SpendLimit = 0,
UsageLimits = new Cockroach.Inputs.ClusterServerlessUsageLimitsArgs
{
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),
},
ParentId: pulumi.String("string"),
Serverless: &cockroach.ClusterServerlessArgs{
RoutingId: pulumi.String("string"),
SpendLimit: pulumi.Int(0),
UsageLimits: &cockroach.ClusterServerlessUsageLimitsArgs{
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())
.parentId("string")
.serverless(ClusterServerlessArgs.builder()
.routingId("string")
.spendLimit(0)
.usageLimits(ClusterServerlessUsageLimitsArgs.builder()
.requestUnitLimit(0)
.storageMibLimit(0)
.build())
.build())
.build());
cluster_resource = cockroach.Cluster("clusterResource",
cloud_provider="string",
name="string",
regions=[cockroach.ClusterRegionArgs(
name="string",
internal_dns="string",
node_count=0,
primary=False,
sql_dns="string",
ui_dns="string",
)],
cockroach_version="string",
dedicated=cockroach.ClusterDedicatedArgs(
disk_iops=0,
machine_type="string",
memory_gib=0,
num_virtual_cpus=0,
private_network_visibility=False,
storage_gib=0,
),
parent_id="string",
serverless=cockroach.ClusterServerlessArgs(
routing_id="string",
spend_limit=0,
usage_limits=cockroach.ClusterServerlessUsageLimitsArgs(
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,
},
parentId: "string",
serverless: {
routingId: "string",
spendLimit: 0,
usageLimits: {
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
name: string
parentId: string
regions:
- internalDns: string
name: string
nodeCount: 0
primary: false
sqlDns: string
uiDns: string
serverless:
routingId: string
spendLimit: 0
usageLimits:
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
The Cluster resource accepts the following input properties:
- Cloud
Provider 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. Cluster Region> - Cockroach
Version string - Major version of CockroachDB running on the cluster.
- Dedicated
Pulumiverse.
Cockroach. Inputs. Cluster Dedicated - Parent
Id string - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- Serverless
Pulumiverse.
Cockroach. Inputs. Cluster Serverless
- Cloud
Provider string - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- Name string
- Name of the cluster.
- Regions
[]Cluster
Region Args - Cockroach
Version string - Major version of CockroachDB running on the cluster.
- Dedicated
Cluster
Dedicated Args - Parent
Id string - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- Serverless
Cluster
Serverless Args
- cloud
Provider String - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- name String
- Name of the cluster.
- regions
List<Cluster
Region> - cockroach
Version String - Major version of CockroachDB running on the cluster.
- dedicated
Cluster
Dedicated - parent
Id String - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- serverless
Cluster
Serverless
- cloud
Provider string - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- name string
- Name of the cluster.
- regions
Cluster
Region[] - cockroach
Version string - Major version of CockroachDB running on the cluster.
- dedicated
Cluster
Dedicated - parent
Id string - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- serverless
Cluster
Serverless
- cloud_
provider str - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- name str
- Name of the cluster.
- regions
Sequence[Cluster
Region Args] - cockroach_
version str - Major version of CockroachDB running on the cluster.
- dedicated
Cluster
Dedicated Args - parent_
id str - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- serverless
Cluster
Serverless Args
- cloud
Provider String - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- name String
- Name of the cluster.
- regions List<Property Map>
- cockroach
Version String - Major version of CockroachDB running on the cluster.
- dedicated Property Map
- parent
Id String - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- 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 - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- Cluster
Id string - Creator
Id string - ID of the user who created the cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Operation
Status string - Describes the current long-running operation, if any.
- Plan string
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- State string
- Describes whether the cluster is being created, updated, deleted, etc.
- Upgrade
Status string - Describes the status of any in-progress CockroachDB upgrade or rollback.
- Account
Id string - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- Cluster
Id string - Creator
Id string - ID of the user who created the cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Operation
Status string - Describes the current long-running operation, if any.
- Plan string
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- State string
- Describes whether the cluster is being created, updated, deleted, etc.
- Upgrade
Status string - Describes the status of any in-progress CockroachDB upgrade or rollback.
- account
Id String - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- cluster
Id String - creator
Id String - ID of the user who created the cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- operation
Status String - Describes the current long-running operation, if any.
- plan String
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- state String
- Describes whether the cluster is being created, updated, deleted, etc.
- upgrade
Status String - Describes the status of any in-progress CockroachDB upgrade or rollback.
- account
Id string - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- cluster
Id string - creator
Id string - ID of the user who created the cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- operation
Status string - Describes the current long-running operation, if any.
- plan string
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- state string
- Describes whether the cluster is being created, updated, deleted, etc.
- upgrade
Status 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.
- cluster_
id str - 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.
- plan str
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- 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.
- account
Id String - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- cluster
Id String - creator
Id String - ID of the user who created the cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- operation
Status String - Describes the current long-running operation, if any.
- plan String
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- state String
- Describes whether the cluster is being created, updated, deleted, etc.
- upgrade
Status 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,
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,
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.
- Account
Id string - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- Cloud
Provider string - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- Cluster
Id string - Cockroach
Version string - Major version of CockroachDB running on the cluster.
- Creator
Id string - ID of the user who created the cluster.
- Dedicated
Pulumiverse.
Cockroach. Inputs. Cluster Dedicated - Name string
- Name of the cluster.
- Operation
Status string - Describes the current long-running operation, if any.
- Parent
Id string - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- Plan string
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- Regions
List<Pulumiverse.
Cockroach. Inputs. Cluster Region> - Serverless
Pulumiverse.
Cockroach. Inputs. Cluster Serverless - State string
- Describes whether the cluster is being created, updated, deleted, etc.
- Upgrade
Status string - Describes the status of any in-progress CockroachDB upgrade or rollback.
- Account
Id string - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- Cloud
Provider string - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- Cluster
Id string - Cockroach
Version string - Major version of CockroachDB running on the cluster.
- Creator
Id string - ID of the user who created the cluster.
- Dedicated
Cluster
Dedicated Args - Name string
- Name of the cluster.
- Operation
Status string - Describes the current long-running operation, if any.
- Parent
Id string - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- Plan string
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- Regions
[]Cluster
Region Args - Serverless
Cluster
Serverless Args - State string
- Describes whether the cluster is being created, updated, deleted, etc.
- Upgrade
Status string - Describes the status of any in-progress CockroachDB upgrade or rollback.
- account
Id String - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- cloud
Provider String - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- cluster
Id String - cockroach
Version String - Major version of CockroachDB running on the cluster.
- creator
Id String - ID of the user who created the cluster.
- dedicated
Cluster
Dedicated - name String
- Name of the cluster.
- operation
Status String - Describes the current long-running operation, if any.
- parent
Id String - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- plan String
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- regions
List<Cluster
Region> - serverless
Cluster
Serverless - state String
- Describes whether the cluster is being created, updated, deleted, etc.
- upgrade
Status String - Describes the status of any in-progress CockroachDB upgrade or rollback.
- account
Id string - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- cloud
Provider string - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- cluster
Id string - cockroach
Version string - Major version of CockroachDB running on the cluster.
- creator
Id string - ID of the user who created the cluster.
- dedicated
Cluster
Dedicated - name string
- Name of the cluster.
- operation
Status string - Describes the current long-running operation, if any.
- parent
Id string - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- plan string
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- regions
Cluster
Region[] - serverless
Cluster
Serverless - state string
- Describes whether the cluster is being created, updated, deleted, etc.
- upgrade
Status 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
- cluster_
id str - cockroach_
version str - Major version of CockroachDB running on the cluster.
- creator_
id str - ID of the user who created the cluster.
- dedicated
Cluster
Dedicated Args - 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 deployment type: 'DEDICATED' or 'SERVERLESS'.
- regions
Sequence[Cluster
Region Args] - serverless
Cluster
Serverless Args - 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.
- account
Id String - The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
- cloud
Provider String - Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
- cluster
Id String - cockroach
Version String - Major version of CockroachDB running on the cluster.
- creator
Id String - ID of the user who created the cluster.
- dedicated Property Map
- name String
- Name of the cluster.
- operation
Status String - Describes the current long-running operation, if any.
- parent
Id String - The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
- plan String
- Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
- regions List<Property Map>
- serverless Property Map
- state String
- Describes whether the cluster is being created, updated, deleted, etc.
- upgrade
Status String - Describes the status of any in-progress CockroachDB upgrade or rollback.
Supporting Types
ClusterDedicated, ClusterDedicatedArgs
- 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 string - Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
- Memory
Gib double - Memory per node in GiB.
- Num
Virtual intCpus - Number of virtual CPUs per node in the cluster.
- Private
Network boolVisibility - 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.
- 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 string - Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
- Memory
Gib float64 - Memory per node in GiB.
- Num
Virtual intCpus - Number of virtual CPUs per node in the cluster.
- Private
Network boolVisibility - 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.
- disk
Iops 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.
- machine
Type String - Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
- memory
Gib Double - Memory per node in GiB.
- num
Virtual IntegerCpus - Number of virtual CPUs per node in the cluster.
- private
Network BooleanVisibility - Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- storage
Gib Integer - Storage amount per node in GiB.
- disk
Iops 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.
- machine
Type string - Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
- memory
Gib number - Memory per node in GiB.
- num
Virtual numberCpus - Number of virtual CPUs per node in the cluster.
- private
Network booleanVisibility - Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- storage
Gib 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_ intcpus - Number of virtual CPUs per node in the cluster.
- private_
network_ boolvisibility - 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.
- disk
Iops 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.
- machine
Type String - Machine type identifier within the given cloud provider, e.g., m6.xlarge, n2-standard-4.
- memory
Gib Number - Memory per node in GiB.
- num
Virtual NumberCpus - Number of virtual CPUs per node in the cluster.
- private
Network BooleanVisibility - Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.
- storage
Gib 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.
- Internal
Dns string - 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 string - DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
- Ui
Dns 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.
- Internal
Dns string - 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 string - DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
- Ui
Dns 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.
- internal
Dns String - 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 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.
- sql
Dns String - DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
- ui
Dns 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.
- internal
Dns string - 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 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.
- sql
Dns string - DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
- ui
Dns 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.
- internal
Dns String - 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 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.
- sql
Dns String - DNS name of the cluster's SQL interface. Used to connect to the cluster with IP allowlisting.
- ui
Dns String - DNS name used when connecting to the DB Console for the cluster.
ClusterServerless, ClusterServerlessArgs
- Routing
Id string - Cluster identifier in a connection string.
- Spend
Limit int - Spend limit in US cents.
- Usage
Limits Pulumiverse.Cockroach. Inputs. Cluster Serverless Usage Limits
- Routing
Id string - Cluster identifier in a connection string.
- Spend
Limit int - Spend limit in US cents.
- Usage
Limits ClusterServerless Usage Limits
- routing
Id String - Cluster identifier in a connection string.
- spend
Limit Integer - Spend limit in US cents.
- usage
Limits ClusterServerless Usage Limits
- routing
Id string - Cluster identifier in a connection string.
- spend
Limit number - Spend limit in US cents.
- usage
Limits ClusterServerless Usage Limits
- routing_
id str - Cluster identifier in a connection string.
- spend_
limit int - Spend limit in US cents.
- usage_
limits ClusterServerless Usage Limits
- routing
Id String - Cluster identifier in a connection string.
- spend
Limit Number - Spend limit in US cents.
- usage
Limits Property Map
ClusterServerlessUsageLimits, ClusterServerlessUsageLimitsArgs
- Request
Unit intLimit - Maximum number of Request Units that the cluster can consume during the month.
- Storage
Mib intLimit - Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
- Request
Unit intLimit - Maximum number of Request Units that the cluster can consume during the month.
- Storage
Mib intLimit - Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
- request
Unit IntegerLimit - Maximum number of Request Units that the cluster can consume during the month.
- storage
Mib IntegerLimit - Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
- request
Unit numberLimit - Maximum number of Request Units that the cluster can consume during the month.
- storage
Mib numberLimit - Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
- request_
unit_ intlimit - Maximum number of Request Units that the cluster can consume during the month.
- storage_
mib_ intlimit - Maximum amount of storage (in MiB) that the cluster can have at any time during the month.
- request
Unit NumberLimit - Maximum number of Request Units that the cluster can consume during the month.
- storage
Mib NumberLimit - 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.