@upcloud/pulumi-upcloud
Version:
A Pulumi package for creating and managing UpCloud resources.
302 lines (301 loc) • 10.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* This resource represents MySQL managed database. See UpCloud [Managed Databases](https://upcloud.com/products/managed-databases) product page for more details about the service.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as upcloud from "@upcloud/pulumi-upcloud";
*
* // Minimal config
* const example1 = new upcloud.ManagedDatabaseMysql("example_1", {
* name: "mysql-1",
* title: "mysql-1-example-1",
* plan: "1x1xCPU-2GB-25GB",
* zone: "fi-hel1",
* });
* // Shutdown instance after creation
* const example2 = new upcloud.ManagedDatabaseMysql("example_2", {
* name: "mysql-2",
* title: "mysql-2-example-2",
* plan: "1x1xCPU-2GB-25GB",
* zone: "fi-hel1",
* powered: false,
* });
* // Service with custom properties
* // Note that this basically sets strict mode off which is not normally recommended
* const example3 = new upcloud.ManagedDatabaseMysql("example_3", {
* name: "mysql-3",
* title: "mysql-3-example-3",
* plan: "1x1xCPU-2GB-25GB",
* zone: "fi-hel1",
* properties: {
* sqlMode: "NO_ENGINE_SUBSTITUTION",
* waitTimeout: 300,
* sortBufferSize: 4000000,
* maxAllowedPacket: 16000000,
* adminUsername: "admin",
* adminPassword: "<ADMIN_PASSWORD>",
* },
* });
* ```
*/
export declare class ManagedDatabaseMysql extends pulumi.CustomResource {
/**
* Get an existing ManagedDatabaseMysql 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?: ManagedDatabaseMysqlState, opts?: pulumi.CustomResourceOptions): ManagedDatabaseMysql;
/**
* Returns true if the given object is an instance of ManagedDatabaseMysql. 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 ManagedDatabaseMysql;
/**
* Service component information
*/
readonly components: pulumi.Output<outputs.ManagedDatabaseMysqlComponent[]>;
/**
* User defined key-value pairs to classify the managed database.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Maintenance window day of week. Lower case weekday name (monday, tuesday, ...)
*/
readonly maintenanceWindowDow: pulumi.Output<string>;
/**
* Maintenance window UTC time in hh:mm:ss format
*/
readonly maintenanceWindowTime: pulumi.Output<string>;
/**
* Name of the service. The name is used as a prefix for the logical hostname. Must be unique within an account
*/
readonly name: pulumi.Output<string>;
/**
* Private networks attached to the managed database
*/
readonly networks: pulumi.Output<outputs.ManagedDatabaseMysqlNetwork[] | undefined>;
/**
* Information about nodes providing the managed service
*/
readonly nodeStates: pulumi.Output<outputs.ManagedDatabaseMysqlNodeState[]>;
/**
* Service plan to use. This determines how much resources the instance will have. You can list available plans with `upctl
* database plans <type>`.
*/
readonly plan: pulumi.Output<string>;
/**
* The administrative power state of the service
*/
readonly powered: pulumi.Output<boolean | undefined>;
/**
* Primary database name
*/
readonly primaryDatabase: pulumi.Output<string>;
/**
* Database Engine properties for MySQL
*/
readonly properties: pulumi.Output<outputs.ManagedDatabaseMysqlProperties>;
/**
* Hostname to the service instance
*/
readonly serviceHost: pulumi.Output<string>;
/**
* Primary username's password to the service instance
*/
readonly servicePassword: pulumi.Output<string>;
/**
* Port to the service instance
*/
readonly servicePort: pulumi.Output<string>;
/**
* URI to the service instance
*/
readonly serviceUri: pulumi.Output<string>;
/**
* Primary username to the service instance
*/
readonly serviceUsername: pulumi.Output<string>;
/**
* State of the service
*/
readonly state: pulumi.Output<string>;
/**
* If set to true, prevents the managed service from being powered off, or deleted.
*/
readonly terminationProtection: pulumi.Output<boolean | undefined>;
/**
* Title of a managed database instance
*/
readonly title: pulumi.Output<string>;
/**
* Type of the service
*/
readonly type: pulumi.Output<string>;
/**
* Zone where the instance resides, e.g. `de-fra1`. You can list available zones with `upctl zone list`.
*/
readonly zone: pulumi.Output<string>;
/**
* Create a ManagedDatabaseMysql 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: ManagedDatabaseMysqlArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ManagedDatabaseMysql resources.
*/
export interface ManagedDatabaseMysqlState {
/**
* Service component information
*/
components?: pulumi.Input<pulumi.Input<inputs.ManagedDatabaseMysqlComponent>[]>;
/**
* User defined key-value pairs to classify the managed database.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Maintenance window day of week. Lower case weekday name (monday, tuesday, ...)
*/
maintenanceWindowDow?: pulumi.Input<string>;
/**
* Maintenance window UTC time in hh:mm:ss format
*/
maintenanceWindowTime?: pulumi.Input<string>;
/**
* Name of the service. The name is used as a prefix for the logical hostname. Must be unique within an account
*/
name?: pulumi.Input<string>;
/**
* Private networks attached to the managed database
*/
networks?: pulumi.Input<pulumi.Input<inputs.ManagedDatabaseMysqlNetwork>[]>;
/**
* Information about nodes providing the managed service
*/
nodeStates?: pulumi.Input<pulumi.Input<inputs.ManagedDatabaseMysqlNodeState>[]>;
/**
* Service plan to use. This determines how much resources the instance will have. You can list available plans with `upctl
* database plans <type>`.
*/
plan?: pulumi.Input<string>;
/**
* The administrative power state of the service
*/
powered?: pulumi.Input<boolean>;
/**
* Primary database name
*/
primaryDatabase?: pulumi.Input<string>;
/**
* Database Engine properties for MySQL
*/
properties?: pulumi.Input<inputs.ManagedDatabaseMysqlProperties>;
/**
* Hostname to the service instance
*/
serviceHost?: pulumi.Input<string>;
/**
* Primary username's password to the service instance
*/
servicePassword?: pulumi.Input<string>;
/**
* Port to the service instance
*/
servicePort?: pulumi.Input<string>;
/**
* URI to the service instance
*/
serviceUri?: pulumi.Input<string>;
/**
* Primary username to the service instance
*/
serviceUsername?: pulumi.Input<string>;
/**
* State of the service
*/
state?: pulumi.Input<string>;
/**
* If set to true, prevents the managed service from being powered off, or deleted.
*/
terminationProtection?: pulumi.Input<boolean>;
/**
* Title of a managed database instance
*/
title?: pulumi.Input<string>;
/**
* Type of the service
*/
type?: pulumi.Input<string>;
/**
* Zone where the instance resides, e.g. `de-fra1`. You can list available zones with `upctl zone list`.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ManagedDatabaseMysql resource.
*/
export interface ManagedDatabaseMysqlArgs {
/**
* User defined key-value pairs to classify the managed database.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Maintenance window day of week. Lower case weekday name (monday, tuesday, ...)
*/
maintenanceWindowDow?: pulumi.Input<string>;
/**
* Maintenance window UTC time in hh:mm:ss format
*/
maintenanceWindowTime?: pulumi.Input<string>;
/**
* Name of the service. The name is used as a prefix for the logical hostname. Must be unique within an account
*/
name?: pulumi.Input<string>;
/**
* Private networks attached to the managed database
*/
networks?: pulumi.Input<pulumi.Input<inputs.ManagedDatabaseMysqlNetwork>[]>;
/**
* Service plan to use. This determines how much resources the instance will have. You can list available plans with `upctl
* database plans <type>`.
*/
plan: pulumi.Input<string>;
/**
* The administrative power state of the service
*/
powered?: pulumi.Input<boolean>;
/**
* Database Engine properties for MySQL
*/
properties?: pulumi.Input<inputs.ManagedDatabaseMysqlProperties>;
/**
* If set to true, prevents the managed service from being powered off, or deleted.
*/
terminationProtection?: pulumi.Input<boolean>;
/**
* Title of a managed database instance
*/
title: pulumi.Input<string>;
/**
* Zone where the instance resides, e.g. `de-fra1`. You can list available zones with `upctl zone list`.
*/
zone: pulumi.Input<string>;
}