pulumi-alicloud-kotlin/com.pulumi.alicloud.polardb.kotlin

Package-level declarations

Types

class Account : KotlinCustomResource

Provides a PolarDB account resource and used to manage databases.

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, String>>? = null) : ConvertibleToJava<AccountArgs>

Provides a PolarDB account resource and used to manage databases.

AccountArgsBuilder

class AccountArgsBuilder

Builder for AccountArgs.

AccountMapper

object AccountMapper : ResourceMapper<Account>

AccountPrivilege

class AccountPrivilege : KotlinCustomResource

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

AccountPrivilegeArgs

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.

AccountPrivilegeArgsBuilder

class AccountPrivilegeArgsBuilder

Builder for AccountPrivilegeArgs.

AccountPrivilegeMapper

object AccountPrivilegeMapper : ResourceMapper<AccountPrivilege>

AccountPrivilegeResourceBuilder

class AccountPrivilegeResourceBuilder

Builder for AccountPrivilege.

AccountResourceBuilder

class AccountResourceBuilder

Builder for Account.

BackupPolicy

class BackupPolicy : KotlinCustomResource

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

BackupPolicyArgs

data class BackupPolicyArgs(val backupFrequency: Output<String>? = null, val backupRetentionPeriod: Output<String>? = null, val backupRetentionPolicyOnClusterDeletion: Output<String>? = null, val dataLevel1BackupFrequency: Output<String>? = null, val dataLevel1BackupPeriods: Output<List<String>>? = null, val dataLevel1BackupRetentionPeriod: Output<Int>? = null, val dataLevel1BackupTime: Output<String>? = null, val dataLevel2BackupAnotherRegionRegion: Output<String>? = null, val dataLevel2BackupAnotherRegionRetentionPeriod: Output<Int>? = null, val dataLevel2BackupPeriods: Output<List<String>>? = null, val dataLevel2BackupRetentionPeriod: Output<Int>? = null, val dbClusterId: Output<String>? = null, val logBackupAnotherRegionRegion: Output<String>? = null, val logBackupAnotherRegionRetentionPeriod: Output<Int>? = null, val logBackupRetentionPeriod: Output<Int>? = 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.

BackupPolicyArgsBuilder

class BackupPolicyArgsBuilder

Builder for BackupPolicyArgs.

BackupPolicyMapper

object BackupPolicyMapper : ResourceMapper<BackupPolicy>

BackupPolicyResourceBuilder

class BackupPolicyResourceBuilder

Builder for BackupPolicy.

Cluster

class Cluster : KotlinCustomResource

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

ClusterArgs

data class ClusterArgs(val allowShutDown: Output<String>? = null, val autoRenewPeriod: Output<Int>? = null, val backupRetentionPolicyOnClusterDeletion: Output<String>? = null, val cloneDataPoint: Output<String>? = null, val collectorStatus: Output<String>? = null, val compressStorage: Output<String>? = null, val creationCategory: Output<String>? = null, val creationOption: Output<String>? = null, val dbClusterIpArrays: Output<List<ClusterDbClusterIpArrayArgs>>? = null, val dbMinorVersion: Output<String>? = null, val dbNodeClass: Output<String>? = null, val dbNodeCount: Output<Int>? = null, val dbNodeId: Output<String>? = null, val dbNodeNum: Output<Int>? = null, val dbType: Output<String>? = null, val dbVersion: Output<String>? = null, val defaultTimeZone: Output<String>? = null, val deletionLock: Output<Int>? = null, val description: Output<String>? = null, val encryptNewTables: Output<String>? = null, val encryptionKey: Output<String>? = null, val fromTimeService: Output<String>? = null, val gdnId: Output<String>? = null, val hotReplicaMode: Output<String>? = null, val hotStandbyCluster: Output<String>? = null, val imciSwitch: Output<String>? = null, val loosePolarLogBin: Output<String>? = null, val looseXengine: Output<String>? = null, val looseXengineUseMemoryPct: Output<Int>? = null, val lowerCaseTableNames: Output<Int>? = null, val maintainTime: Output<String>? = null, val modifyType: Output<String>? = null, val parameterGroupId: Output<String>? = null, val parameters: Output<List<ClusterParameterArgs>>? = null, val payType: Output<String>? = null, val period: Output<Int>? = null, val plannedEndTime: Output<String>? = null, val plannedStartTime: Output<String>? = null, val provisionedIops: Output<String>? = null, val proxyClass: Output<String>? = null, val proxyType: Output<String>? = null, val renewalStatus: Output<String>? = null, val resourceGroupId: Output<String>? = null, val roleArn: Output<String>? = null, val scaleApRoNumMax: Output<Int>? = null, val scaleApRoNumMin: Output<Int>? = null, val scaleMax: Output<Int>? = null, val scaleMin: Output<Int>? = null, val scaleRoNumMax: Output<Int>? = null, val scaleRoNumMin: Output<Int>? = null, val secondsUntilAutoPause: Output<Int>? = null, val securityGroupIds: Output<List<String>>? = null, val securityIps: Output<List<String>>? = null, val serverlessRuleCpuEnlargeThreshold: Output<Int>? = null, val serverlessRuleCpuShrinkThreshold: Output<Int>? = null, val serverlessRuleMode: Output<String>? = null, val serverlessSteadySwitch: Output<String>? = null, val serverlessType: Output<String>? = null, val sourceResourceId: Output<String>? = null, val standbyAz: Output<String>? = null, val storagePayType: Output<String>? = null, val storageSpace: Output<Int>? = null, val storageType: Output<String>? = null, val strictConsistency: Output<String>? = null, val subCategory: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val targetDbRevisionVersionCode: Output<String>? = null, val tdeStatus: Output<String>? = null, val upgradeType: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<ClusterArgs>

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

ClusterArgsBuilder

class ClusterArgsBuilder

Builder for ClusterArgs.

ClusterEndpoint

class ClusterEndpoint : KotlinCustomResource

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

ClusterEndpointArgs

data class ClusterEndpointArgs(val autoAddNewNodes: Output<String>? = null, val connectionPrefix: Output<String>? = null, val dbClusterId: Output<String>? = null, val dbEndpointDescription: Output<String>? = null, val endpointConfig: Output<Map<String, String>>? = null, val netType: Output<String>? = null, val nodes: Output<List<String>>? = null, val port: Output<String>? = null, val readWriteMode: Output<String>? = null, val sslAutoRotate: Output<String>? = null, val sslEnabled: Output<String>? = null) : ConvertibleToJava<ClusterEndpointArgs>

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

ClusterEndpointArgsBuilder

class ClusterEndpointArgsBuilder

Builder for ClusterEndpointArgs.

ClusterEndpointMapper

object ClusterEndpointMapper : ResourceMapper<ClusterEndpoint>

ClusterEndpointResourceBuilder

class ClusterEndpointResourceBuilder

Builder for ClusterEndpoint.

ClusterMapper

object ClusterMapper : ResourceMapper<Cluster>

ClusterResourceBuilder

class ClusterResourceBuilder

Builder for Cluster.

Database

class Database : KotlinCustomResource

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

DatabaseArgs

data class DatabaseArgs(val accountName: Output<String>? = null, 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.

DatabaseArgsBuilder

class DatabaseArgsBuilder

Builder for DatabaseArgs.

DatabaseMapper

object DatabaseMapper : ResourceMapper<Database>

DatabaseResourceBuilder

class DatabaseResourceBuilder

Builder for Database.

Endpoint

class Endpoint : KotlinCustomResource

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

EndpointAddress

class EndpointAddress : KotlinCustomResource

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

EndpointAddressArgs

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

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

EndpointAddressArgsBuilder

class EndpointAddressArgsBuilder

Builder for EndpointAddressArgs.

EndpointAddressMapper

object EndpointAddressMapper : ResourceMapper<EndpointAddress>

EndpointAddressResourceBuilder

class EndpointAddressResourceBuilder

Builder for EndpointAddress.

EndpointArgs

data class EndpointArgs(val autoAddNewNodes: Output<String>? = null, val connectionPrefix: Output<String>? = null, val dbClusterId: Output<String>? = null, val dbEndpointDescription: Output<String>? = null, val endpointConfig: Output<Map<String, String>>? = null, val endpointType: Output<String>? = null, val netType: Output<String>? = null, val nodes: Output<List<String>>? = null, val port: Output<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 custom endpoint of PolarDB cluster.

EndpointArgsBuilder

class EndpointArgsBuilder

Builder for EndpointArgs.

EndpointMapper

object EndpointMapper : ResourceMapper<Endpoint>

EndpointResourceBuilder

class EndpointResourceBuilder

Builder for Endpoint.

GlobalDatabaseNetwork

class GlobalDatabaseNetwork : KotlinCustomResource

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.

GlobalDatabaseNetworkArgs

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.

GlobalDatabaseNetworkArgsBuilder

class GlobalDatabaseNetworkArgsBuilder

Builder for GlobalDatabaseNetworkArgs.

GlobalDatabaseNetworkMapper

object GlobalDatabaseNetworkMapper : ResourceMapper<GlobalDatabaseNetwork>

GlobalDatabaseNetworkResourceBuilder

class GlobalDatabaseNetworkResourceBuilder

Builder for GlobalDatabaseNetwork.

ParameterGroup

class ParameterGroup : KotlinCustomResource

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

ParameterGroupArgs

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.

ParameterGroupArgsBuilder

class ParameterGroupArgsBuilder

Builder for ParameterGroupArgs.

ParameterGroupMapper

object ParameterGroupMapper : ResourceMapper<ParameterGroup>

ParameterGroupResourceBuilder

class ParameterGroupResourceBuilder

Builder for ParameterGroup.

PolardbFunctions

object PolardbFunctions

PrimaryEndpoint

class PrimaryEndpoint : KotlinCustomResource

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

PrimaryEndpointArgs

data class PrimaryEndpointArgs(val connectionPrefix: Output<String>? = null, val dbClusterId: Output<String>? = null, val dbEndpointDescription: Output<String>? = null, val netType: Output<String>? = null, val port: Output<String>? = null, val sslAutoRotate: Output<String>? = null, val sslEnabled: Output<String>? = null) : ConvertibleToJava<PrimaryEndpointArgs>

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

PrimaryEndpointArgsBuilder

class PrimaryEndpointArgsBuilder

Builder for PrimaryEndpointArgs.

PrimaryEndpointMapper

object PrimaryEndpointMapper : ResourceMapper<PrimaryEndpoint>

PrimaryEndpointResourceBuilder

class PrimaryEndpointResourceBuilder

Builder for PrimaryEndpoint.

Functions

account

fun account(name: String): Account

suspend fun account(name: String, block: suspend AccountResourceBuilder.() -> Unit): Account

accountPrivilege

fun accountPrivilege(name: String): AccountPrivilege

suspend fun accountPrivilege(name: String, block: suspend AccountPrivilegeResourceBuilder.() -> Unit): AccountPrivilege

backupPolicy

fun backupPolicy(name: String): BackupPolicy

suspend fun backupPolicy(name: String, block: suspend BackupPolicyResourceBuilder.() -> Unit): BackupPolicy

cluster

fun cluster(name: String): Cluster

suspend fun cluster(name: String, block: suspend ClusterResourceBuilder.() -> Unit): Cluster

clusterEndpoint

fun clusterEndpoint(name: String): ClusterEndpoint

suspend fun clusterEndpoint(name: String, block: suspend ClusterEndpointResourceBuilder.() -> Unit): ClusterEndpoint

database

fun database(name: String): Database

suspend fun database(name: String, block: suspend DatabaseResourceBuilder.() -> Unit): Database

endpoint

fun endpoint(name: String): Endpoint

suspend fun endpoint(name: String, block: suspend EndpointResourceBuilder.() -> Unit): Endpoint

endpointAddress

fun endpointAddress(name: String): EndpointAddress

suspend fun endpointAddress(name: String, block: suspend EndpointAddressResourceBuilder.() -> Unit): EndpointAddress

globalDatabaseNetwork

fun globalDatabaseNetwork(name: String): GlobalDatabaseNetwork

suspend fun globalDatabaseNetwork(name: String, block: suspend GlobalDatabaseNetworkResourceBuilder.() -> Unit): GlobalDatabaseNetwork

parameterGroup

fun parameterGroup(name: String): ParameterGroup

suspend fun parameterGroup(name: String, block: suspend ParameterGroupResourceBuilder.() -> Unit): ParameterGroup

primaryEndpoint

fun primaryEndpoint(name: String): PrimaryEndpoint

suspend fun primaryEndpoint(name: String, block: suspend PrimaryEndpointResourceBuilder.() -> Unit): PrimaryEndpoint