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

cockroach.Database

Explore with Pulumi AI

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

    Database

    Create Database Resource

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cluster_id: Optional[str] = None,
             name: Optional[str] = None)
@overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)

    type: cockroach:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    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 DatabaseArgs
    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 DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Database 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 Database resource accepts the following input properties:

    ClusterId string
    Name string
    ClusterId string
    Name string
    clusterId String
    name String
    clusterId string
    name string
    clusterId String
    name String

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    TableCount int
    Id string

    The provider-assigned unique ID for this managed resource.

    TableCount int
    id String

    The provider-assigned unique ID for this managed resource.

    tableCount Integer
    id string

    The provider-assigned unique ID for this managed resource.

    tableCount number
    id str

    The provider-assigned unique ID for this managed resource.

    table_count int
    id String

    The provider-assigned unique ID for this managed resource.

    tableCount Number

    Look up Existing Database Resource

    Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        name: Optional[str] = None,
        table_count: Optional[int] = None) -> Database
    func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
    public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
    public static Database get(String name, Output<String> id, DatabaseState 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:
    ClusterId string
    Name string
    TableCount int
    ClusterId string
    Name string
    TableCount int
    clusterId String
    name String
    tableCount Integer
    clusterId string
    name string
    tableCount number
    clusterId String
    name String
    tableCount Number

    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