Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. Cluster
CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs
lbrlabs/pulumi-cockroach

cockroach.Cluster

Explore with Pulumi AI

cockroach logo
CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs
lbrlabs/pulumi-cockroach

    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:

    Outputs

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

    AccountId string
    ClusterId string

    The ID of this resource.

    CreatorId string
    Id string

    The provider-assigned unique ID for this managed resource.

    OperationStatus string
    Plan string
    State string
    UpgradeStatus string
    AccountId string
    ClusterId string

    The ID of this resource.

    CreatorId string
    Id string

    The provider-assigned unique ID for this managed resource.

    OperationStatus string
    Plan string
    State string
    UpgradeStatus string
    accountId String
    clusterId String

    The ID of this resource.

    creatorId String
    id String

    The provider-assigned unique ID for this managed resource.

    operationStatus String
    plan String
    state String
    upgradeStatus String
    accountId string
    clusterId string

    The ID of this resource.

    creatorId string
    id string

    The provider-assigned unique ID for this managed resource.

    operationStatus string
    plan string
    state string
    upgradeStatus 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
    accountId String
    clusterId String

    The ID of this resource.

    creatorId String
    id String

    The provider-assigned unique ID for this managed resource.

    operationStatus String
    plan String
    state String
    upgradeStatus 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.
    The following state arguments are supported:
    accountId String
    cloudProvider String
    clusterId String

    The ID of this resource.

    cockroachVersion String
    creatorId String
    dedicated Property Map
    name String

    Name of cluster

    operationStatus String
    plan String
    regions List<Property Map>
    serverless Property Map
    state String
    upgradeStatus String

    Supporting Types

    ClusterDedicated, ClusterDedicatedArgs

    DiskIops int
    MachineType string
    MemoryGib double
    NumVirtualCpus int
    PrivateNetworkVisibility bool

    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.

    StorageGib int
    DiskIops int
    MachineType string
    MemoryGib float64
    NumVirtualCpus int
    PrivateNetworkVisibility bool

    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.

    StorageGib int
    diskIops Integer
    machineType String
    memoryGib Double
    numVirtualCpus Integer
    privateNetworkVisibility Boolean

    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.

    storageGib Integer
    diskIops number
    machineType string
    memoryGib number
    numVirtualCpus number
    privateNetworkVisibility boolean

    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.

    storageGib number
    disk_iops int
    machine_type str
    memory_gib float
    num_virtual_cpus int
    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
    diskIops Number
    machineType String
    memoryGib Number
    numVirtualCpus Number
    privateNetworkVisibility Boolean

    Set to true to assign private IP addresses to nodes. Required for CMEK and other advanced networking features.

    storageGib Number

    ClusterRegion, ClusterRegionArgs

    Name string

    Name of cluster

    NodeCount 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.

    SqlDns string
    UiDns string
    Name string

    Name of cluster

    NodeCount 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.

    SqlDns string
    UiDns string
    name String

    Name of cluster

    nodeCount Integer
    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
    uiDns String
    name string

    Name of cluster

    nodeCount number
    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
    uiDns string
    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
    name String

    Name of cluster

    nodeCount Number
    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
    uiDns String

    ClusterServerless, ClusterServerlessArgs

    routingId String
    spendLimit Integer

    Spend limit in US cents.

    usageLimits ClusterServerlessUsageLimits
    routingId string
    spendLimit number

    Spend limit in US cents.

    usageLimits ClusterServerlessUsageLimits
    routingId String
    spendLimit Number

    Spend limit in US cents.

    usageLimits Property Map

    ClusterServerlessUsageLimits, ClusterServerlessUsageLimitsArgs

    Package Details

    Repository
    cockroach lbrlabs/pulumi-cockroach
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the cockroach Terraform Provider.

    cockroach logo
    CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs
    lbrlabs/pulumi-cockroach