@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
123 lines (122 loc) • 4.22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Create and manage Scaleway DocumentDB database privilege.
* For more information, see [the documentation](https://www.scaleway.com/en/developers/api/document_db/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const main = new scaleway.DocumentdbPrivilege("main", {
* databaseName: "my-db-name",
* instanceId: "11111111-1111-1111-1111-111111111111",
* permission: "all",
* userName: "my-db-user",
* });
* ```
*
* ## Import
*
* The user privileges can be imported using the `{region}/{instance_id}/{database_name}/{user_name}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/documentdbPrivilege:DocumentdbPrivilege o fr-par/11111111-1111-1111-1111-111111111111/database_name/foo
* ```
*/
export declare class DocumentdbPrivilege extends pulumi.CustomResource {
/**
* Get an existing DocumentdbPrivilege 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?: DocumentdbPrivilegeState, opts?: pulumi.CustomResourceOptions): DocumentdbPrivilege;
/**
* Returns true if the given object is an instance of DocumentdbPrivilege. 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 DocumentdbPrivilege;
/**
* Name of the database (e.g. `my-db-name`).
*/
readonly databaseName: pulumi.Output<string>;
/**
* UUID of the rdb instance.
*/
readonly instanceId: pulumi.Output<string>;
/**
* Permission to set. Valid values are `readonly`, `readwrite`, `all`, `custom` and `none`.
*/
readonly permission: pulumi.Output<string>;
/**
* `region`) The region in which the resource exists.
*/
readonly region: pulumi.Output<string>;
/**
* Name of the user (e.g. `my-db-user`).
*/
readonly userName: pulumi.Output<string>;
/**
* Create a DocumentdbPrivilege 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: DocumentdbPrivilegeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DocumentdbPrivilege resources.
*/
export interface DocumentdbPrivilegeState {
/**
* Name of the database (e.g. `my-db-name`).
*/
databaseName?: pulumi.Input<string>;
/**
* UUID of the rdb instance.
*/
instanceId?: pulumi.Input<string>;
/**
* Permission to set. Valid values are `readonly`, `readwrite`, `all`, `custom` and `none`.
*/
permission?: pulumi.Input<string>;
/**
* `region`) The region in which the resource exists.
*/
region?: pulumi.Input<string>;
/**
* Name of the user (e.g. `my-db-user`).
*/
userName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DocumentdbPrivilege resource.
*/
export interface DocumentdbPrivilegeArgs {
/**
* Name of the database (e.g. `my-db-name`).
*/
databaseName: pulumi.Input<string>;
/**
* UUID of the rdb instance.
*/
instanceId: pulumi.Input<string>;
/**
* Permission to set. Valid values are `readonly`, `readwrite`, `all`, `custom` and `none`.
*/
permission: pulumi.Input<string>;
/**
* `region`) The region in which the resource exists.
*/
region?: pulumi.Input<string>;
/**
* Name of the user (e.g. `my-db-user`).
*/
userName: pulumi.Input<string>;
}