@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
142 lines (141 loc) • 4.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Create and manage Scaleway RDB database privilege.
* For more information, see [the documentation](https://developers.scaleway.com/en/products/rdb/api/#user-and-permissions).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const mainDatabaseInstance = new scaleway.DatabaseInstance("mainDatabaseInstance", {
* nodeType: "DB-DEV-S",
* engine: "PostgreSQL-11",
* isHaCluster: true,
* disableBackup: true,
* userName: "my_initial_user",
* password: "thiZ_is_v&ry_s3cret",
* });
* const mainDatabase = new scaleway.Database("mainDatabase", {instanceId: mainDatabaseInstance.id});
* const mainDatabaseUser = new scaleway.DatabaseUser("mainDatabaseUser", {
* instanceId: mainDatabaseInstance.id,
* password: "thiZ_is_v&ry_s3cret",
* isAdmin: false,
* });
* const mainDatabasePrivilege = new scaleway.DatabasePrivilege("mainDatabasePrivilege", {
* instanceId: mainDatabaseInstance.id,
* userName: "my-db-user",
* databaseName: "my-db-name",
* permission: "all",
* }, {
* dependsOn: [
* mainDatabaseUser,
* mainDatabase,
* ],
* });
* ```
*
* ## Import
*
* The user privileges can be imported using the `{region}/{instance_id}/{database_name}/{user_name}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/databasePrivilege:DatabasePrivilege o fr-par/11111111-1111-1111-1111-111111111111/database_name/foo
* ```
*/
export declare class DatabasePrivilege extends pulumi.CustomResource {
/**
* Get an existing DatabasePrivilege 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?: DatabasePrivilegeState, opts?: pulumi.CustomResourceOptions): DatabasePrivilege;
/**
* Returns true if the given object is an instance of DatabasePrivilege. 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 DatabasePrivilege;
/**
* 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 DatabasePrivilege 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: DatabasePrivilegeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DatabasePrivilege resources.
*/
export interface DatabasePrivilegeState {
/**
* 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 DatabasePrivilege resource.
*/
export interface DatabasePrivilegeArgs {
/**
* 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>;
}