Package-level declarations

Types

Link copied to clipboard

Provides a PolarDB account resource and used to manage databases.

Link copied to clipboard
data class AccountArgs(val accountDescription: Output<String>? = null, val accountName: Output<String>? = null, val accountPassword: Output<String>? = null, val accountType: Output<String>? = null, val dbClusterId: Output<String>? = null, val kmsEncryptedPassword: Output<String>? = null, val kmsEncryptionContext: Output<Map<String, Any>>? = null) : ConvertibleToJava<AccountArgs>

Provides a PolarDB account resource and used to manage databases.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides a PolarDB account privilege resource and used to grant several database some access privilege. A database can be granted by multiple account.

Link copied to clipboard
data class AccountPrivilegeArgs(val accountName: Output<String>? = null, val accountPrivilege: Output<String>? = null, val dbClusterId: Output<String>? = null, val dbNames: Output<List<String>>? = null) : ConvertibleToJava<AccountPrivilegeArgs>

Provides a PolarDB account privilege resource and used to grant several database some access privilege. A database can be granted by multiple account.

Link copied to clipboard
Link copied to clipboard

PolarDB backup policy can be imported using the id or cluster id, e.g.

Link copied to clipboard
data class BackupPolicyArgs(val backupRetentionPolicyOnClusterDeletion: Output<String>? = null, val dbClusterId: Output<String>? = null, val preferredBackupPeriods: Output<List<String>>? = null, val preferredBackupTime: Output<String>? = null) : ConvertibleToJava<BackupPolicyArgs>

PolarDB backup policy can be imported using the id or cluster id, e.g.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides a PolarDB cluster resource. A PolarDB cluster is an isolated database environment in the cloud. A PolarDB cluster can contain multiple user-created databases.

Link copied to clipboard
data class ClusterArgs(val autoRenewPeriod: Output<Int>? = null, val backupRetentionPolicyOnClusterDeletion: Output<String>? = null, val cloneDataPoint: Output<String>? = null, val collectorStatus: Output<String>? = null, val creationCategory: Output<String>? = null, val creationOption: Output<String>? = null, val dbClusterIpArrays: Output<List<ClusterDbClusterIpArrayArgs>>? = null, val dbNodeClass: Output<String>? = null, val dbNodeCount: Output<Int>? = null, val dbType: Output<String>? = null, val dbVersion: Output<String>? = null, val deletionLock: Output<Int>? = null, val description: Output<String>? = null, val encryptNewTables: Output<String>? = null, val gdnId: Output<String>? = null, val imciSwitch: Output<String>? = null, val maintainTime: Output<String>? = null, val modifyType: Output<String>? = null, val parameters: Output<List<ClusterParameterArgs>>? = null, val payType: Output<String>? = null, val period: Output<Int>? = null, val renewalStatus: Output<String>? = null, val resourceGroupId: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val securityIps: Output<List<String>>? = null, val sourceResourceId: Output<String>? = null, val subCategory: Output<String>? = null, val tags: Output<Map<String, Any>>? = null, val tdeStatus: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<ClusterArgs>

Provides a PolarDB cluster resource. A PolarDB cluster is an isolated database environment in the cloud. A PolarDB cluster can contain multiple user-created databases.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides a PolarDB database resource. A database deployed in a PolarDB cluster. A PolarDB cluster can own multiple databases.

Link copied to clipboard
data class DatabaseArgs(val characterSetName: Output<String>? = null, val dbClusterId: Output<String>? = null, val dbDescription: Output<String>? = null, val dbName: Output<String>? = null) : ConvertibleToJava<DatabaseArgs>

Provides a PolarDB database resource. A database deployed in a PolarDB cluster. A PolarDB cluster can own multiple databases.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides a PolarDB endpoint resource to manage endpoint of PolarDB cluster.

Link copied to clipboard

Provides a PolarDB endpoint address resource to allocate an Internet endpoint address string for PolarDB instance.

Link copied to clipboard
data class EndpointAddressArgs(val connectionPrefix: Output<String>? = null, val dbClusterId: Output<String>? = null, val dbEndpointId: Output<String>? = null, val netType: Output<String>? = null) : ConvertibleToJava<EndpointAddressArgs>

Provides a PolarDB endpoint address resource to allocate an Internet endpoint address string for PolarDB instance.

Link copied to clipboard
data class EndpointArgs(val autoAddNewNodes: Output<String>? = null, val dbClusterId: Output<String>? = null, val endpointConfig: Output<Map<String, Any>>? = null, val endpointType: Output<String>? = null, val netType: Output<String>? = null, val nodes: Output<List<String>>? = null, val readWriteMode: Output<String>? = null, val sslAutoRotate: Output<String>? = null, val sslEnabled: Output<String>? = null) : ConvertibleToJava<EndpointArgs>

Provides a PolarDB endpoint resource to manage endpoint of PolarDB cluster.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Provides a PolarDB Global Database Network resource. For information about PolarDB Global Database Network and how to use it, see What is Global Database Network.

Link copied to clipboard
data class GlobalDatabaseNetworkArgs(val dbClusterId: Output<String>? = null, val description: Output<String>? = null) : ConvertibleToJava<GlobalDatabaseNetworkArgs>

Provides a PolarDB Global Database Network resource. For information about PolarDB Global Database Network and how to use it, see What is Global Database Network.

Link copied to clipboard

Provides a PolarDB Parameter Group resource. For information about PolarDB Parameter Group and how to use it, see What is Parameter Group.

Link copied to clipboard
data class ParameterGroupArgs(val dbType: Output<String>? = null, val dbVersion: Output<String>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<List<ParameterGroupParameterArgs>>? = null) : ConvertibleToJava<ParameterGroupArgs>

Provides a PolarDB Parameter Group resource. For information about PolarDB Parameter Group and how to use it, see What is Parameter Group.

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
suspend fun accountResource(name: String, block: suspend AccountResourceBuilder.() -> Unit): Account
Link copied to clipboard
suspend fun backupPolicyResource(name: String, block: suspend BackupPolicyResourceBuilder.() -> Unit): BackupPolicy
Link copied to clipboard
suspend fun clusterResource(name: String, block: suspend ClusterResourceBuilder.() -> Unit): Cluster
Link copied to clipboard
suspend fun databaseResource(name: String, block: suspend DatabaseResourceBuilder.() -> Unit): Database
Link copied to clipboard
Link copied to clipboard
suspend fun endpointResource(name: String, block: suspend EndpointResourceBuilder.() -> Unit): Endpoint
Link copied to clipboard