@mapped/pulumi-astra
Version:
A Pulumi package for creating and managing astra cloud resources.
86 lines (85 loc) • 3.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* `astra.Keyspace` provides a keyspace resource. Keyspaces are groupings of tables for Cassandra. `astra.Keyspace` resources are associated with a database id. You can have multiple keyspaces per DB in addition to the default keyspace provided in the `astra.Database` resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as astra from "@pulumi/astra";
*
* const example = new astra.Keyspace("example", {
* databaseId: "48bfc13b-c1a5-48db-b70f-b6ef9709872b",
* });
* ```
*
* ## Import
*
* # the import id includes the database_id and the keyspace name.
*
* ```sh
* $ pulumi import astra:index/keyspace:Keyspace example 48bfc13b-c1a5-48db-b70f-b6ef9709872b/keyspace/example
* ```
*/
export declare class Keyspace extends pulumi.CustomResource {
/**
* Get an existing Keyspace resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KeyspaceState, opts?: pulumi.CustomResourceOptions): Keyspace;
/**
* Returns true if the given object is an instance of Keyspace. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Keyspace;
/**
* Astra database to create the keyspace.
*/
readonly databaseId: pulumi.Output<string>;
/**
* Keyspace name can have up to 48 alpha-numeric characters and contain underscores; only letters and numbers are supported
* as the first character.
*/
readonly name: pulumi.Output<string>;
/**
* Create a Keyspace resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: KeyspaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Keyspace resources.
*/
export interface KeyspaceState {
/**
* Astra database to create the keyspace.
*/
databaseId?: pulumi.Input<string>;
/**
* Keyspace name can have up to 48 alpha-numeric characters and contain underscores; only letters and numbers are supported
* as the first character.
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Keyspace resource.
*/
export interface KeyspaceArgs {
/**
* Astra database to create the keyspace.
*/
databaseId: pulumi.Input<string>;
/**
* Keyspace name can have up to 48 alpha-numeric characters and contain underscores; only letters and numbers are supported
* as the first character.
*/
name?: pulumi.Input<string>;
}