@mapped/pulumi-astra
Version:
A Pulumi package for creating and managing astra cloud resources.
196 lines (195 loc) • 5.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as astra from "@pulumi/astra";
*
* const example = new astra.Database("example", {
* cloudProvider: "gcp",
* keyspace: "keyspace",
* regions: ["us-east1"],
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import astra:index/database:Database example 48bfc13b-c1a5-48db-b70f-b6ef9709872b
* ```
*/
export declare class Database extends pulumi.CustomResource {
/**
* Get an existing Database 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?: DatabaseState, opts?: pulumi.CustomResourceOptions): Database;
/**
* Returns true if the given object is an instance of Database. 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 Database;
/**
* The total_storage
*/
readonly additionalKeyspaces: pulumi.Output<string[]>;
/**
* The cloud provider to launch the database. (Currently supported: aws, azure, gcp)
*/
readonly cloudProvider: pulumi.Output<string>;
/**
* The cqlsh_url
*/
readonly cqlshUrl: pulumi.Output<string>;
/**
* The data_endpoint_url
*/
readonly dataEndpointUrl: pulumi.Output<string>;
/**
* The grafana_url
*/
readonly grafanaUrl: pulumi.Output<string>;
/**
* The graphql_url
*/
readonly graphqlUrl: pulumi.Output<string>;
/**
* Initial keyspace name. For additional keyspaces, use the astra_keyspace resource.
*/
readonly keyspace: pulumi.Output<string>;
/**
* Astra database name.
*/
readonly name: pulumi.Output<string>;
/**
* The node_count
*/
readonly nodeCount: pulumi.Output<number>;
/**
* The org id.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The owner id.
*/
readonly ownerId: pulumi.Output<string>;
/**
* Cloud regions to launch the database. (see https://docs.datastax.com/en/astra/docs/database-regions.html for supported
* regions)
*/
readonly regions: pulumi.Output<string[]>;
/**
* The replication_factor
*/
readonly replicationFactor: pulumi.Output<number>;
/**
* The status
*/
readonly status: pulumi.Output<string>;
/**
* The total_storage
*/
readonly totalStorage: pulumi.Output<number>;
/**
* Create a Database 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: DatabaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Database resources.
*/
export interface DatabaseState {
/**
* The total_storage
*/
additionalKeyspaces?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The cloud provider to launch the database. (Currently supported: aws, azure, gcp)
*/
cloudProvider?: pulumi.Input<string>;
/**
* The cqlsh_url
*/
cqlshUrl?: pulumi.Input<string>;
/**
* The data_endpoint_url
*/
dataEndpointUrl?: pulumi.Input<string>;
/**
* The grafana_url
*/
grafanaUrl?: pulumi.Input<string>;
/**
* The graphql_url
*/
graphqlUrl?: pulumi.Input<string>;
/**
* Initial keyspace name. For additional keyspaces, use the astra_keyspace resource.
*/
keyspace?: pulumi.Input<string>;
/**
* Astra database name.
*/
name?: pulumi.Input<string>;
/**
* The node_count
*/
nodeCount?: pulumi.Input<number>;
/**
* The org id.
*/
organizationId?: pulumi.Input<string>;
/**
* The owner id.
*/
ownerId?: pulumi.Input<string>;
/**
* Cloud regions to launch the database. (see https://docs.datastax.com/en/astra/docs/database-regions.html for supported
* regions)
*/
regions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The replication_factor
*/
replicationFactor?: pulumi.Input<number>;
/**
* The status
*/
status?: pulumi.Input<string>;
/**
* The total_storage
*/
totalStorage?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Database resource.
*/
export interface DatabaseArgs {
/**
* The cloud provider to launch the database. (Currently supported: aws, azure, gcp)
*/
cloudProvider: pulumi.Input<string>;
/**
* Initial keyspace name. For additional keyspaces, use the astra_keyspace resource.
*/
keyspace: pulumi.Input<string>;
/**
* Astra database name.
*/
name?: pulumi.Input<string>;
/**
* Cloud regions to launch the database. (see https://docs.datastax.com/en/astra/docs/database-regions.html for supported
* regions)
*/
regions: pulumi.Input<pulumi.Input<string>[]>;
}