@upcloud/pulumi-upcloud
Version:
A Pulumi package for creating and managing UpCloud resources.
165 lines (164 loc) • 5.64 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* This resource represents a user in managed database
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as upcloud from "@upcloud/pulumi-upcloud";
*
* const example = new upcloud.ManagedDatabasePostgresql("example", {
* name: "postgres",
* plan: "1x1xCPU-2GB-25GB",
* title: "postgres",
* zone: "fi-hel1",
* });
* const exampleUser = new upcloud.ManagedDatabaseUser("example_user", {
* service: example.id,
* username: "example_user",
* password: "<USER_PASSWORD>",
* });
* ```
*/
export declare class ManagedDatabaseUser extends pulumi.CustomResource {
/**
* Get an existing ManagedDatabaseUser 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?: ManagedDatabaseUserState, opts?: pulumi.CustomResourceOptions): ManagedDatabaseUser;
/**
* Returns true if the given object is an instance of ManagedDatabaseUser. 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 ManagedDatabaseUser;
/**
* MySQL only, authentication type.
*/
readonly authentication: pulumi.Output<string | undefined>;
/**
* OpenSearch access control object.
*/
readonly opensearchAccessControl: pulumi.Output<outputs.ManagedDatabaseUserOpensearchAccessControl | undefined>;
/**
* Password for the database user. Defaults to a random value
*/
readonly password: pulumi.Output<string>;
/**
* PostgreSQL access control object.
*/
readonly pgAccessControl: pulumi.Output<outputs.ManagedDatabaseUserPgAccessControl | undefined>;
/**
* Redis access control object.
*/
readonly redisAccessControl: pulumi.Output<outputs.ManagedDatabaseUserRedisAccessControl | undefined>;
/**
* Service's UUID for which this user belongs to
*/
readonly service: pulumi.Output<string>;
/**
* Type of the user. Only normal type users can be created
*/
readonly type: pulumi.Output<string>;
/**
* Name of the database user
*/
readonly username: pulumi.Output<string>;
/**
* Valkey access control object.
*/
readonly valkeyAccessControl: pulumi.Output<outputs.ManagedDatabaseUserValkeyAccessControl | undefined>;
/**
* Create a ManagedDatabaseUser 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: ManagedDatabaseUserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ManagedDatabaseUser resources.
*/
export interface ManagedDatabaseUserState {
/**
* MySQL only, authentication type.
*/
authentication?: pulumi.Input<string>;
/**
* OpenSearch access control object.
*/
opensearchAccessControl?: pulumi.Input<inputs.ManagedDatabaseUserOpensearchAccessControl>;
/**
* Password for the database user. Defaults to a random value
*/
password?: pulumi.Input<string>;
/**
* PostgreSQL access control object.
*/
pgAccessControl?: pulumi.Input<inputs.ManagedDatabaseUserPgAccessControl>;
/**
* Redis access control object.
*/
redisAccessControl?: pulumi.Input<inputs.ManagedDatabaseUserRedisAccessControl>;
/**
* Service's UUID for which this user belongs to
*/
service?: pulumi.Input<string>;
/**
* Type of the user. Only normal type users can be created
*/
type?: pulumi.Input<string>;
/**
* Name of the database user
*/
username?: pulumi.Input<string>;
/**
* Valkey access control object.
*/
valkeyAccessControl?: pulumi.Input<inputs.ManagedDatabaseUserValkeyAccessControl>;
}
/**
* The set of arguments for constructing a ManagedDatabaseUser resource.
*/
export interface ManagedDatabaseUserArgs {
/**
* MySQL only, authentication type.
*/
authentication?: pulumi.Input<string>;
/**
* OpenSearch access control object.
*/
opensearchAccessControl?: pulumi.Input<inputs.ManagedDatabaseUserOpensearchAccessControl>;
/**
* Password for the database user. Defaults to a random value
*/
password?: pulumi.Input<string>;
/**
* PostgreSQL access control object.
*/
pgAccessControl?: pulumi.Input<inputs.ManagedDatabaseUserPgAccessControl>;
/**
* Redis access control object.
*/
redisAccessControl?: pulumi.Input<inputs.ManagedDatabaseUserRedisAccessControl>;
/**
* Service's UUID for which this user belongs to
*/
service: pulumi.Input<string>;
/**
* Name of the database user
*/
username: pulumi.Input<string>;
/**
* Valkey access control object.
*/
valkeyAccessControl?: pulumi.Input<inputs.ManagedDatabaseUserValkeyAccessControl>;
}