com.pulumi.alicloud.polardb.kotlin.Database.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-alicloud-kotlin Show documentation
Show all versions of pulumi-alicloud-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.alicloud.polardb.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [Database].
*/
@PulumiTagMarker
public class DatabaseResourceBuilder internal constructor() {
public var name: String? = null
public var args: DatabaseArgs = DatabaseArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend DatabaseArgsBuilder.() -> Unit) {
val builder = DatabaseArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Database {
val builtJavaResource = com.pulumi.alicloud.polardb.Database(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Database(builtJavaResource)
}
}
/**
* Provides a PolarDB database resource. A database deployed in a PolarDB cluster. A PolarDB cluster can own multiple databases.
* > **NOTE:** Available since v1.66.0.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as alicloud from "@pulumi/alicloud";
* const default = alicloud.polardb.getNodeClasses({
* dbType: "MySQL",
* dbVersion: "8.0",
* payType: "PostPaid",
* category: "Normal",
* });
* const defaultNetwork = new alicloud.vpc.Network("default", {
* vpcName: "terraform-example",
* cidrBlock: "172.16.0.0/16",
* });
* const defaultSwitch = new alicloud.vpc.Switch("default", {
* vpcId: defaultNetwork.id,
* cidrBlock: "172.16.0.0/24",
* zoneId: _default.then(_default => _default.classes?.[0]?.zoneId),
* vswitchName: "terraform-example",
* });
* const defaultCluster = new alicloud.polardb.Cluster("default", {
* dbType: "MySQL",
* dbVersion: "8.0",
* dbNodeClass: _default.then(_default => _default.classes?.[0]?.supportedEngines?.[0]?.availableResources?.[0]?.dbNodeClass),
* payType: "PostPaid",
* vswitchId: defaultSwitch.id,
* description: "terraform-example",
* });
* const defaultDatabase = new alicloud.polardb.Database("default", {
* dbClusterId: defaultCluster.id,
* dbName: "terraform-example",
* });
* ```
* ```python
* import pulumi
* import pulumi_alicloud as alicloud
* default = alicloud.polardb.get_node_classes(db_type="MySQL",
* db_version="8.0",
* pay_type="PostPaid",
* category="Normal")
* default_network = alicloud.vpc.Network("default",
* vpc_name="terraform-example",
* cidr_block="172.16.0.0/16")
* default_switch = alicloud.vpc.Switch("default",
* vpc_id=default_network.id,
* cidr_block="172.16.0.0/24",
* zone_id=default.classes[0].zone_id,
* vswitch_name="terraform-example")
* default_cluster = alicloud.polardb.Cluster("default",
* db_type="MySQL",
* db_version="8.0",
* db_node_class=default.classes[0].supported_engines[0].available_resources[0].db_node_class,
* pay_type="PostPaid",
* vswitch_id=default_switch.id,
* description="terraform-example")
* default_database = alicloud.polardb.Database("default",
* db_cluster_id=default_cluster.id,
* db_name="terraform-example")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AliCloud = Pulumi.AliCloud;
* return await Deployment.RunAsync(() =>
* {
* var @default = AliCloud.PolarDB.GetNodeClasses.Invoke(new()
* {
* DbType = "MySQL",
* DbVersion = "8.0",
* PayType = "PostPaid",
* Category = "Normal",
* });
* var defaultNetwork = new AliCloud.Vpc.Network("default", new()
* {
* VpcName = "terraform-example",
* CidrBlock = "172.16.0.0/16",
* });
* var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
* {
* VpcId = defaultNetwork.Id,
* CidrBlock = "172.16.0.0/24",
* ZoneId = @default.Apply(@default => @default.Apply(getNodeClassesResult => getNodeClassesResult.Classes[0]?.ZoneId)),
* VswitchName = "terraform-example",
* });
* var defaultCluster = new AliCloud.PolarDB.Cluster("default", new()
* {
* DbType = "MySQL",
* DbVersion = "8.0",
* DbNodeClass = @default.Apply(@default => @default.Apply(getNodeClassesResult => getNodeClassesResult.Classes[0]?.SupportedEngines[0]?.AvailableResources[0]?.DbNodeClass)),
* PayType = "PostPaid",
* VswitchId = defaultSwitch.Id,
* Description = "terraform-example",
* });
* var defaultDatabase = new AliCloud.PolarDB.Database("default", new()
* {
* DbClusterId = defaultCluster.Id,
* DbName = "terraform-example",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
* "github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
* DbType: pulumi.StringRef("MySQL"),
* DbVersion: pulumi.StringRef("8.0"),
* PayType: "PostPaid",
* Category: pulumi.StringRef("Normal"),
* }, nil)
* if err != nil {
* return err
* }
* defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
* VpcName: pulumi.String("terraform-example"),
* CidrBlock: pulumi.String("172.16.0.0/16"),
* })
* if err != nil {
* return err
* }
* defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
* VpcId: defaultNetwork.ID(),
* CidrBlock: pulumi.String("172.16.0.0/24"),
* ZoneId: pulumi.String(_default.Classes[0].ZoneId),
* VswitchName: pulumi.String("terraform-example"),
* })
* if err != nil {
* return err
* }
* defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
* DbType: pulumi.String("MySQL"),
* DbVersion: pulumi.String("8.0"),
* DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
* PayType: pulumi.String("PostPaid"),
* VswitchId: defaultSwitch.ID(),
* Description: pulumi.String("terraform-example"),
* })
* if err != nil {
* return err
* }
* _, err = polardb.NewDatabase(ctx, "default", &polardb.DatabaseArgs{
* DbClusterId: defaultCluster.ID(),
* DbName: pulumi.String("terraform-example"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.alicloud.polardb.PolardbFunctions;
* import com.pulumi.alicloud.polardb.inputs.GetNodeClassesArgs;
* import com.pulumi.alicloud.vpc.Network;
* import com.pulumi.alicloud.vpc.NetworkArgs;
* import com.pulumi.alicloud.vpc.Switch;
* import com.pulumi.alicloud.vpc.SwitchArgs;
* import com.pulumi.alicloud.polardb.Cluster;
* import com.pulumi.alicloud.polardb.ClusterArgs;
* import com.pulumi.alicloud.polardb.Database;
* import com.pulumi.alicloud.polardb.DatabaseArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* final var default = PolardbFunctions.getNodeClasses(GetNodeClassesArgs.builder()
* .dbType("MySQL")
* .dbVersion("8.0")
* .payType("PostPaid")
* .category("Normal")
* .build());
* var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
* .vpcName("terraform-example")
* .cidrBlock("172.16.0.0/16")
* .build());
* var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
* .vpcId(defaultNetwork.id())
* .cidrBlock("172.16.0.0/24")
* .zoneId(default_.classes()[0].zoneId())
* .vswitchName("terraform-example")
* .build());
* var defaultCluster = new Cluster("defaultCluster", ClusterArgs.builder()
* .dbType("MySQL")
* .dbVersion("8.0")
* .dbNodeClass(default_.classes()[0].supportedEngines()[0].availableResources()[0].dbNodeClass())
* .payType("PostPaid")
* .vswitchId(defaultSwitch.id())
* .description("terraform-example")
* .build());
* var defaultDatabase = new Database("defaultDatabase", DatabaseArgs.builder()
* .dbClusterId(defaultCluster.id())
* .dbName("terraform-example")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* defaultNetwork:
* type: alicloud:vpc:Network
* name: default
* properties:
* vpcName: terraform-example
* cidrBlock: 172.16.0.0/16
* defaultSwitch:
* type: alicloud:vpc:Switch
* name: default
* properties:
* vpcId: ${defaultNetwork.id}
* cidrBlock: 172.16.0.0/24
* zoneId: ${default.classes[0].zoneId}
* vswitchName: terraform-example
* defaultCluster:
* type: alicloud:polardb:Cluster
* name: default
* properties:
* dbType: MySQL
* dbVersion: '8.0'
* dbNodeClass: ${default.classes[0].supportedEngines[0].availableResources[0].dbNodeClass}
* payType: PostPaid
* vswitchId: ${defaultSwitch.id}
* description: terraform-example
* defaultDatabase:
* type: alicloud:polardb:Database
* name: default
* properties:
* dbClusterId: ${defaultCluster.id}
* dbName: terraform-example
* variables:
* default:
* fn::invoke:
* Function: alicloud:polardb:getNodeClasses
* Arguments:
* dbType: MySQL
* dbVersion: '8.0'
* payType: PostPaid
* category: Normal
* ```
*
* ## Import
* PolarDB database can be imported using the id, e.g.
* ```sh
* $ pulumi import alicloud:polardb/database:Database example "pc-12345:tf_database"
* ```
*/
public class Database internal constructor(
override val javaResource: com.pulumi.alicloud.polardb.Database,
) : KotlinCustomResource(javaResource, DatabaseMapper) {
/**
* Account name authorized to access the database. Only supports PostgreSQL.
*/
public val accountName: Output?
get() = javaResource.accountName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is "utf8" \(`utf8mb4` only supports versions 5.5 and 5.6\).
*/
public val characterSetName: Output?
get() = javaResource.characterSetName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The Id of cluster that can run database.
*/
public val dbClusterId: Output
get() = javaResource.dbClusterId().applyValue({ args0 -> args0 })
/**
* Database description. It must start with a Chinese character or English letter, cannot start with "http://" or "https://". It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length must be 2-256 characters.
*/
public val dbDescription: Output?
get() = javaResource.dbDescription().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letterand have no more than 64 characters.
*/
public val dbName: Output
get() = javaResource.dbName().applyValue({ args0 -> args0 })
}
public object DatabaseMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.alicloud.polardb.Database::class == javaResource::class
override fun map(javaResource: Resource): Database = Database(
javaResource as
com.pulumi.alicloud.polardb.Database,
)
}
/**
* @see [Database].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Database].
*/
public suspend fun database(name: String, block: suspend DatabaseResourceBuilder.() -> Unit): Database {
val builder = DatabaseResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Database].
* @param name The _unique_ name of the resulting resource.
*/
public fun database(name: String): Database {
val builder = DatabaseResourceBuilder()
builder.name(name)
return builder.build()
}