Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. Database
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.Database

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    CockroachDB database.

    Create Database Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cluster_id: Optional[str] = None,
             name: Optional[str] = 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.

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var databaseResource = new Cockroach.Database("databaseResource", new()
{
    ClusterId = "string",
    Name = "string",
});

    example, err := cockroach.NewDatabase(ctx, "databaseResource", &cockroach.DatabaseArgs{
	ClusterId: pulumi.String("string"),
	Name:      pulumi.String("string"),
})

    var databaseResource = new Database("databaseResource", DatabaseArgs.builder()
    .clusterId("string")
    .name("string")
    .build());

    database_resource = cockroach.Database("databaseResource",
    cluster_id="string",
    name="string")

    const databaseResource = new cockroach.Database("databaseResource", {
    clusterId: "string",
    name: "string",
});

    type: cockroach:Database
properties:
    clusterId: string
    name: string

    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
    ID of the cluster the database belongs to.
    Name string
    Database name.
    ClusterId string
    ID of the cluster the database belongs to.
    Name string
    Database name.
    clusterId String
    ID of the cluster the database belongs to.
    name String
    Database name.
    clusterId string
    ID of the cluster the database belongs to.
    name string
    Database name.
    cluster_id str
    ID of the cluster the database belongs to.
    name str
    Database name.
    clusterId String
    ID of the cluster the database belongs to.
    name String
    Database name.

    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
    Number of tables in the database.
    Id string
    The provider-assigned unique ID for this managed resource.
    TableCount int
    Number of tables in the database.
    id String
    The provider-assigned unique ID for this managed resource.
    tableCount Integer
    Number of tables in the database.
    id string
    The provider-assigned unique ID for this managed resource.
    tableCount number
    Number of tables in the database.
    id str
    The provider-assigned unique ID for this managed resource.
    table_count int
    Number of tables in the database.
    id String
    The provider-assigned unique ID for this managed resource.
    tableCount Number
    Number of tables in the database.

    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
    ID of the cluster the database belongs to.
    Name string
    Database name.
    TableCount int
    Number of tables in the database.
    ClusterId string
    ID of the cluster the database belongs to.
    Name string
    Database name.
    TableCount int
    Number of tables in the database.
    clusterId String
    ID of the cluster the database belongs to.
    name String
    Database name.
    tableCount Integer
    Number of tables in the database.
    clusterId string
    ID of the cluster the database belongs to.
    name string
    Database name.
    tableCount number
    Number of tables in the database.
    cluster_id str
    ID of the cluster the database belongs to.
    name str
    Database name.
    table_count int
    Number of tables in the database.
    clusterId String
    ID of the cluster the database belongs to.
    name String
    Database name.
    tableCount Number
    Number of tables in the database.

    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.2.3 published on Monday, May 27, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach