Package-level declarations

Types

Link copied to clipboard

RDS account can be imported using the id, e.g.

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 dbInstanceId: Output<String>? = null, val description: Output<String>? = null, val instanceId: Output<String>? = null, val kmsEncryptedPassword: Output<String>? = null, val kmsEncryptionContext: Output<Map<String, Any>>? = null, val name: Output<String>? = null, val password: Output<String>? = null, val resetPermissionFlag: Output<Boolean>? = null, val type: Output<String>? = null) : ConvertibleToJava<AccountArgs>

RDS account can be imported using the id, e.g.

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

Provides an RDS 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 dbNames: Output<List<String>>? = null, val instanceId: Output<String>? = null, val privilege: Output<String>? = null) : ConvertibleToJava<AccountPrivilegeArgs>

Provides an RDS 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

Provides an RDS instance backup policy resource and used to configure instance backup policy.

Link copied to clipboard
data class BackupPolicyArgs(val archiveBackupKeepCount: Output<Int>? = null, val archiveBackupKeepPolicy: Output<String>? = null, val archiveBackupRetentionPeriod: Output<Int>? = null, val backupInterval: Output<String>? = null, val backupPeriods: Output<List<String>>? = null, val backupRetentionPeriod: Output<Int>? = null, val backupTime: Output<String>? = null, val category: Output<String>? = null, val compressType: Output<String>? = null, val enableBackupLog: Output<Boolean>? = null, val highSpaceUsageProtection: Output<String>? = null, val instanceId: Output<String>? = null, val localLogRetentionHours: Output<Int>? = null, val localLogRetentionSpace: Output<Int>? = null, val logBackup: Output<Boolean>? = null, val logBackupFrequency: Output<String>? = null, val logBackupRetentionPeriod: Output<Int>? = null, val logRetentionPeriod: Output<Int>? = null, val preferredBackupPeriods: Output<List<String>>? = null, val preferredBackupTime: Output<String>? = null, val releasedKeepPolicy: Output<String>? = null, val retentionPeriod: Output<Int>? = null) : ConvertibleToJava<BackupPolicyArgs>

Provides an RDS instance backup policy resource and used to configure instance backup policy.

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

Provides an RDS connection resource to allocate an Internet connection string for RDS instance.

Link copied to clipboard
data class ConnectionArgs(val babelfishPort: Output<String>? = null, val connectionPrefix: Output<String>? = null, val instanceId: Output<String>? = null, val port: Output<String>? = null) : ConvertibleToJava<ConnectionArgs>

Provides an RDS connection resource to allocate an Internet connection string for RDS instance.

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

Provides an RDS database resource. A DB database deployed in a DB instance. A DB instance can own multiple databases.

Link copied to clipboard
data class DatabaseArgs(val characterSet: Output<String>? = null, val description: Output<String>? = null, val instanceId: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<DatabaseArgs>

Provides an RDS database resource. A DB database deployed in a DB instance. A DB instance can own multiple databases.

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

RDS ddr instance can be imported using the id, e.g.

Link copied to clipboard
data class DdrInstanceArgs(val acl: Output<String>? = null, val autoRenew: Output<Boolean>? = null, val autoRenewPeriod: Output<Int>? = null, val autoUpgradeMinorVersion: Output<String>? = null, val backupSetId: Output<String>? = null, val caType: Output<String>? = null, val clientCaCert: Output<String>? = null, val clientCaEnabled: Output<Int>? = null, val clientCertRevocationList: Output<String>? = null, val clientCrlEnabled: Output<Int>? = null, val connectionStringPrefix: Output<String>? = null, val dbInstanceIpArrayAttribute: Output<String>? = null, val dbInstanceIpArrayName: Output<String>? = null, val dbInstanceStorageType: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val effectiveTime: Output<String>? = null, val encryptionKey: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val forceRestart: Output<Boolean>? = null, val freshWhiteListReadins: Output<String>? = null, val haConfig: Output<String>? = null, val instanceName: Output<String>? = null, val instanceStorage: Output<Int>? = null, val instanceType: Output<String>? = null, val maintainTime: Output<String>? = null, val manualHaTime: Output<String>? = null, val modifyMode: Output<String>? = null, val monitoringPeriod: Output<Int>? = null, val parameters: Output<List<DdrInstanceParameterArgs>>? = null, val paymentType: Output<String>? = null, val period: Output<Int>? = null, val pgHbaConfs: Output<List<DdrInstancePgHbaConfArgs>>? = null, val port: Output<String>? = null, val privateIpAddress: Output<String>? = null, val releasedKeepPolicy: Output<String>? = null, val replicationAcl: Output<String>? = null, val resourceGroupId: Output<String>? = null, val restoreTime: Output<String>? = null, val restoreType: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val securityIpMode: Output<String>? = null, val securityIpType: Output<String>? = null, val securityIps: Output<List<String>>? = null, val serverCert: Output<String>? = null, val serverKey: Output<String>? = null, val sourceDbInstanceName: Output<String>? = null, val sourceRegion: Output<String>? = null, val sqlCollectorConfigValue: Output<Int>? = null, val sqlCollectorStatus: Output<String>? = null, val sslAction: Output<String>? = null, val storageAutoScale: Output<String>? = null, val storageThreshold: Output<Int>? = null, val storageUpperBound: Output<Int>? = null, val switchTime: Output<String>? = null, val tags: Output<Map<String, Any>>? = null, val targetMinorVersion: Output<String>? = null, val tcpConnectionType: Output<String>? = null, val tdeStatus: Output<String>? = null, val upgradeDbInstanceKernelVersion: Output<Boolean>? = null, val upgradeTime: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val whitelistNetworkType: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<DdrInstanceArgs>

RDS ddr instance can be imported using the id, e.g.

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

RDS instance can be imported using the id, e.g.

Link copied to clipboard
data class InstanceArgs(val acl: Output<String>? = null, val autoRenew: Output<Boolean>? = null, val autoRenewPeriod: Output<Int>? = null, val autoUpgradeMinorVersion: Output<String>? = null, val babelfishConfigs: Output<List<InstanceBabelfishConfigArgs>>? = null, val babelfishPort: Output<String>? = null, val caType: Output<String>? = null, val category: Output<String>? = null, val clientCaCert: Output<String>? = null, val clientCaEnabled: Output<Int>? = null, val clientCertRevocationList: Output<String>? = null, val clientCrlEnabled: Output<Int>? = null, val connectionStringPrefix: Output<String>? = null, val dbInstanceIpArrayAttribute: Output<String>? = null, val dbInstanceIpArrayName: Output<String>? = null, val dbInstanceStorageType: Output<String>? = null, val dbIsIgnoreCase: Output<Boolean>? = null, val dbTimeZone: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val effectiveTime: Output<String>? = null, val encryptionKey: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val forceRestart: Output<Boolean>? = null, val freshWhiteListReadins: Output<String>? = null, val haConfig: Output<String>? = null, val instanceChargeType: Output<String>? = null, val instanceName: Output<String>? = null, val instanceStorage: Output<Int>? = null, val instanceType: Output<String>? = null, val maintainTime: Output<String>? = null, val manualHaTime: Output<String>? = null, val modifyMode: Output<String>? = null, val monitoringPeriod: Output<Int>? = null, val parameters: Output<List<InstanceParameterArgs>>? = null, val period: Output<Int>? = null, val pgHbaConfs: Output<List<InstancePgHbaConfArgs>>? = null, val port: Output<String>? = null, val privateIpAddress: Output<String>? = null, val releasedKeepPolicy: Output<String>? = null, val replicationAcl: Output<String>? = null, val resourceGroupId: Output<String>? = null, val securityGroupId: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val securityIpMode: Output<String>? = null, val securityIpType: Output<String>? = null, val securityIps: Output<List<String>>? = null, val serverCert: Output<String>? = null, val serverKey: Output<String>? = null, val sqlCollectorConfigValue: Output<Int>? = null, val sqlCollectorStatus: Output<String>? = null, val sslAction: Output<String>? = null, val sslConnectionString: Output<String>? = null, val storageAutoScale: Output<String>? = null, val storageThreshold: Output<Int>? = null, val storageUpperBound: Output<Int>? = null, val switchTime: Output<String>? = null, val tags: Output<Map<String, Any>>? = null, val targetMinorVersion: Output<String>? = null, val tcpConnectionType: Output<String>? = null, val tdeStatus: Output<String>? = null, val upgradeDbInstanceKernelVersion: Output<Boolean>? = null, val upgradeTime: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val whitelistNetworkType: Output<String>? = null, val zoneId: Output<String>? = null, val zoneIdSlaveA: Output<String>? = null, val zoneIdSlaveB: Output<String>? = null) : ConvertibleToJava<InstanceArgs>

RDS instance can be imported using the id, e.g.

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

Provides a RDS Account resource. For information about RDS Account and how to use it, see What is Account.

Link copied to clipboard
data class RdsAccountArgs(val accountDescription: Output<String>? = null, val accountName: Output<String>? = null, val accountPassword: Output<String>? = null, val accountType: Output<String>? = null, val dbInstanceId: Output<String>? = null, val description: Output<String>? = null, val instanceId: Output<String>? = null, val kmsEncryptedPassword: Output<String>? = null, val kmsEncryptionContext: Output<Map<String, Any>>? = null, val name: Output<String>? = null, val password: Output<String>? = null, val resetPermissionFlag: Output<Boolean>? = null, val type: Output<String>? = null) : ConvertibleToJava<RdsAccountArgs>

Provides a RDS Account resource. For information about RDS Account and how to use it, see What is Account.

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

Provides a RDS Backup resource. For information about RDS Backup and how to use it, see What is Backup.

Link copied to clipboard
data class RdsBackupArgs(val backupMethod: Output<String>? = null, val backupStrategy: Output<String>? = null, val backupType: Output<String>? = null, val dbInstanceId: Output<String>? = null, val dbName: Output<String>? = null, val removeFromState: Output<Boolean>? = null) : ConvertibleToJava<RdsBackupArgs>

Provides a RDS Backup resource. For information about RDS Backup and how to use it, see What is Backup.

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

Provides a RDS Clone DB Instance resource. For information about RDS Clone DB Instance and how to use it, see What is ApsaraDB for RDS.

Link copied to clipboard
data class RdsCloneDbInstanceArgs(val acl: Output<String>? = null, val autoUpgradeMinorVersion: Output<String>? = null, val backupId: Output<String>? = null, val backupType: Output<String>? = null, val caType: Output<String>? = null, val category: Output<String>? = null, val certificate: Output<String>? = null, val clientCaCert: Output<String>? = null, val clientCaEnabled: Output<Int>? = null, val clientCertRevocationList: Output<String>? = null, val clientCrlEnabled: Output<Int>? = null, val connectionStringPrefix: Output<String>? = null, val dbInstanceClass: Output<String>? = null, val dbInstanceDescription: Output<String>? = null, val dbInstanceStorage: Output<Int>? = null, val dbInstanceStorageType: Output<String>? = null, val dbName: Output<String>? = null, val dbNames: Output<String>? = null, val dedicatedHostGroupId: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val direction: Output<String>? = null, val effectiveTime: Output<String>? = null, val encryptionKey: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val forceRestart: Output<Boolean>? = null, val haMode: Output<String>? = null, val instanceNetworkType: Output<String>? = null, val maintainTime: Output<String>? = null, val parameters: Output<List<RdsCloneDbInstanceParameterArgs>>? = null, val password: Output<String>? = null, val paymentType: Output<String>? = null, val period: Output<String>? = null, val pgHbaConfs: Output<List<RdsCloneDbInstancePgHbaConfArgs>>? = null, val port: Output<String>? = null, val privateIpAddress: Output<String>? = null, val privateKey: Output<String>? = null, val releasedKeepPolicy: Output<String>? = null, val replicationAcl: Output<String>? = null, val resourceGroupId: Output<String>? = null, val restoreTable: Output<String>? = null, val restoreTime: Output<String>? = null, val roleArn: Output<String>? = null, val securityIps: Output<List<String>>? = null, val serverCert: Output<String>? = null, val serverKey: Output<String>? = null, val sourceBiz: Output<String>? = null, val sourceDbInstanceId: Output<String>? = null, val sslEnabled: Output<Int>? = null, val switchTime: Output<String>? = null, val syncMode: Output<String>? = null, val tableMeta: Output<String>? = null, val tcpConnectionType: Output<String>? = null, val tdeStatus: Output<String>? = null, val usedTime: Output<Int>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<RdsCloneDbInstanceArgs>

Provides a RDS Clone DB Instance resource. For information about RDS Clone DB Instance and how to use it, see What is ApsaraDB for RDS.

Link copied to clipboard

Information about RDS database exclusive agent and its usage, see Dedicated proxy (read/write splitting)..

Link copied to clipboard
data class RdsDbProxyArgs(val dbProxyConnectStringPort: Output<Int>? = null, val dbProxyConnectionPrefix: Output<String>? = null, val dbProxyEndpointReadWriteMode: Output<String>? = null, val dbProxyFeatures: Output<String>? = null, val dbProxyInstanceNum: Output<Int>? = null, val dbProxySslEnabled: Output<String>? = null, val effectiveSpecificTime: Output<String>? = null, val effectiveTime: Output<String>? = null, val instanceId: Output<String>? = null, val instanceNetworkType: Output<String>? = null, val readOnlyInstanceDistributionType: Output<String>? = null, val readOnlyInstanceMaxDelayTime: Output<Int>? = null, val readOnlyInstanceWeights: Output<List<RdsDbProxyReadOnlyInstanceWeightArgs>>? = null, val resourceGroupId: Output<String>? = null, val switchTime: Output<String>? = null, val upgradeTime: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null) : ConvertibleToJava<RdsDbProxyArgs>

Information about RDS database exclusive agent and its usage, see Dedicated proxy (read/write splitting)..

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

Provides an RDS instance emote disaster recovery strategy policy resource and used to configure instance emote disaster recovery strategy policy. For information about RDS cross region backup settings and how to use them, see What is cross region backup.

Link copied to clipboard
data class RdsInstanceCrossBackupPolicyArgs(val crossBackupRegion: Output<String>? = null, val instanceId: Output<String>? = null, val logBackupEnabled: Output<String>? = null, val retention: Output<Int>? = null) : ConvertibleToJava<RdsInstanceCrossBackupPolicyArgs>

Provides an RDS instance emote disaster recovery strategy policy resource and used to configure instance emote disaster recovery strategy policy. For information about RDS cross region backup settings and how to use them, see What is cross region backup.

Link copied to clipboard

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

Link copied to clipboard
data class RdsParameterGroupArgs(val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val paramDetails: Output<List<RdsParameterGroupParamDetailArgs>>? = null, val parameterGroupDesc: Output<String>? = null, val parameterGroupName: Output<String>? = null) : ConvertibleToJava<RdsParameterGroupArgs>

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

Link copied to clipboard

Provides a RDS Service Linked Role. For information about RDS Service Linked Role and how to use it, see What is Service Linked Role..

Link copied to clipboard
data class RdsServiceLinkedRoleArgs(val serviceName: Output<String>? = null) : ConvertibleToJava<RdsServiceLinkedRoleArgs>

Provides a RDS Service Linked Role. For information about RDS Service Linked Role and how to use it, see What is Service Linked Role..

Link copied to clipboard

Provides a RDS Upgrade DB Instance resource. For information about RDS Upgrade DB Instance and how to use it, see What is ApsaraDB for RDS.

Link copied to clipboard
data class RdsUpgradeDbInstanceArgs(val acl: Output<String>? = null, val autoUpgradeMinorVersion: Output<String>? = null, val caType: Output<String>? = null, val certificate: Output<String>? = null, val clientCaCert: Output<String>? = null, val clientCaEnabled: Output<Int>? = null, val clientCertRevocationList: Output<String>? = null, val clientCrlEnabled: Output<Int>? = null, val collectStatMode: Output<String>? = null, val connectionStringPrefix: Output<String>? = null, val dbInstanceClass: Output<String>? = null, val dbInstanceDescription: Output<String>? = null, val dbInstanceStorage: Output<Int>? = null, val dbInstanceStorageType: Output<String>? = null, val dbName: Output<String>? = null, val dedicatedHostGroupId: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val direction: Output<String>? = null, val effectiveTime: Output<String>? = null, val encryptionKey: Output<String>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val forceRestart: Output<Boolean>? = null, val haMode: Output<String>? = null, val instanceNetworkType: Output<String>? = null, val maintainTime: Output<String>? = null, val parameters: Output<List<RdsUpgradeDbInstanceParameterArgs>>? = null, val password: Output<String>? = null, val paymentType: Output<String>? = null, val pgHbaConfs: Output<List<RdsUpgradeDbInstancePgHbaConfArgs>>? = null, val port: Output<String>? = null, val privateIpAddress: Output<String>? = null, val privateKey: Output<String>? = null, val releasedKeepPolicy: Output<String>? = null, val replicationAcl: Output<String>? = null, val resourceGroupId: Output<String>? = null, val roleArn: Output<String>? = null, val securityIps: Output<List<String>>? = null, val serverCert: Output<String>? = null, val serverKey: Output<String>? = null, val sourceBiz: Output<String>? = null, val sourceDbInstanceId: Output<String>? = null, val sslEnabled: Output<Int>? = null, val switchOver: Output<String>? = null, val switchTime: Output<String>? = null, val switchTimeMode: Output<String>? = null, val syncMode: Output<String>? = null, val targetMajorVersion: Output<String>? = null, val tcpConnectionType: Output<String>? = null, val tdeStatus: Output<String>? = null, val vpcId: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null, val zoneIdSlave1: Output<String>? = null) : ConvertibleToJava<RdsUpgradeDbInstanceArgs>

Provides a RDS Upgrade DB Instance resource. For information about RDS Upgrade DB Instance and how to use it, see What is ApsaraDB for RDS.

Link copied to clipboard

Provides an RDS readonly instance resource.

Link copied to clipboard
data class ReadOnlyInstanceArgs(val acl: Output<String>? = null, val caType: Output<String>? = null, val clientCaCert: Output<String>? = null, val clientCaEnabled: Output<Int>? = null, val clientCertRevocationList: Output<String>? = null, val clientCrlEnabled: Output<Int>? = null, val dbInstanceIpArrayAttribute: Output<String>? = null, val dbInstanceIpArrayName: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val engineVersion: Output<String>? = null, val forceRestart: Output<Boolean>? = null, val instanceName: Output<String>? = null, val instanceStorage: Output<Int>? = null, val instanceType: Output<String>? = null, val masterDbInstanceId: Output<String>? = null, val modifyMode: Output<String>? = null, val parameters: Output<List<ReadOnlyInstanceParameterArgs>>? = null, val replicationAcl: Output<String>? = null, val resourceGroupId: Output<String>? = null, val securityIpType: Output<String>? = null, val securityIps: Output<List<String>>? = null, val serverCert: Output<String>? = null, val serverKey: Output<String>? = null, val sslEnabled: Output<Int>? = null, val switchTime: Output<String>? = null, val tags: Output<Map<String, Any>>? = null, val targetMinorVersion: Output<String>? = null, val upgradeDbInstanceKernelVersion: Output<Boolean>? = null, val upgradeTime: Output<String>? = null, val vswitchId: Output<String>? = null, val whitelistNetworkType: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<ReadOnlyInstanceArgs>

Provides an RDS readonly instance resource.

Link copied to clipboard

Provides an RDS read write splitting connection resource to allocate an Intranet connection string for RDS instance.

Link copied to clipboard
data class ReadWriteSplittingConnectionArgs(val connectionPrefix: Output<String>? = null, val distributionType: Output<String>? = null, val instanceId: Output<String>? = null, val maxDelayTime: Output<Int>? = null, val port: Output<Int>? = null, val weight: Output<Map<String, Any>>? = null) : ConvertibleToJava<ReadWriteSplittingConnectionArgs>

Provides an RDS read write splitting connection resource to allocate an Intranet connection string for RDS instance.

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 connectionResource(name: String, block: suspend ConnectionResourceBuilder.() -> Unit): Connection
Link copied to clipboard
suspend fun databaseResource(name: String, block: suspend DatabaseResourceBuilder.() -> Unit): Database
Link copied to clipboard
suspend fun ddrInstanceResource(name: String, block: suspend DdrInstanceResourceBuilder.() -> Unit): DdrInstance
Link copied to clipboard
suspend fun instanceResource(name: String, block: suspend InstanceResourceBuilder.() -> Unit): Instance
Link copied to clipboard
suspend fun rdsAccountResource(name: String, block: suspend RdsAccountResourceBuilder.() -> Unit): RdsAccount
Link copied to clipboard
suspend fun rdsBackupResource(name: String, block: suspend RdsBackupResourceBuilder.() -> Unit): RdsBackup
Link copied to clipboard
suspend fun rdsDbProxyResource(name: String, block: suspend RdsDbProxyResourceBuilder.() -> Unit): RdsDbProxy
Link copied to clipboard
Link copied to clipboard