DdrInstanceArgs

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, String>>? = 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>

Import

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

$ pulumi import alicloud:rds/ddrInstance:DdrInstance example rm-abc12345678

Constructors

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

Properties

Link copied to clipboard
val acl: Output<String>? = null

The method that is used to verify the identities of clients. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:

Link copied to clipboard
val autoRenew: Output<Boolean>? = null

Whether to renewal a DB instance automatically or not. It is valid when payment_type is Subscription. Default to false.

Link copied to clipboard
val autoRenewPeriod: Output<Int>? = null

Auto-renewal period of an instance, in the unit of the month. It is valid when payment_type is Subscription. Valid value:1~12, Default to 1.

Link copied to clipboard
val autoUpgradeMinorVersion: Output<String>? = null

The upgrade method to use. Valid values:

Link copied to clipboard
val backupSetId: Output<String>? = null

The ID of the backup set that is used for the restoration. You can call the DescribeCrossRegionBackups operation to query the ID of the backup set.

Link copied to clipboard
val caType: Output<String>? = null

The type of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. If you set the SSLEnabled parameter to 1, the default value of this parameter is aliyun. Value range:

Link copied to clipboard
val clientCaCert: Output<String>? = null

The public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. If you set the ClientCAEbabled parameter to 1, you must also specify this parameter.

Link copied to clipboard
val clientCaEnabled: Output<Int>? = null

Specifies whether to enable the public key of the CA that issues client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. Valid values:

Link copied to clipboard
val clientCertRevocationList: Output<String>? = null

The CRL that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. If you set the ClientCrlEnabled parameter to 1, you must also specify this parameter.

Link copied to clipboard
val clientCrlEnabled: Output<Int>? = null

Specifies whether to enable a certificate revocation list (CRL) that contains revoked client certificates. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:

Link copied to clipboard
val connectionStringPrefix: Output<String>? = null

The private connection string prefix. If you want to update public connection string prefix, please use resource alicloud.rds.Connection connection_prefix.

Link copied to clipboard
val dbInstanceIpArrayAttribute: Output<String>? = null

The attribute of the IP address whitelist. By default, this parameter is empty.

Link copied to clipboard
val dbInstanceIpArrayName: Output<String>? = null

The name of the IP address whitelist. Default value: Default.

Link copied to clipboard
val dbInstanceStorageType: Output<String>? = null

The storage type of the instance. Valid values:

Link copied to clipboard
val deletionProtection: Output<Boolean>? = null

The switch of delete protection. Valid values:

Link copied to clipboard
val effectiveTime: Output<String>? = null

The method to update the engine version and change. Default value: Immediate. Valid values:

Link copied to clipboard
val encryptionKey: Output<String>? = null

The key id of the KMS. Used for encrypting a disk if not null. Only for PostgreSQL, MySQL and SQLServer.

Link copied to clipboard
val engine: Output<String>? = null

Database type. Value options: MySQL, SQLServer.

Link copied to clipboard
val engineVersion: Output<String>? = null

Database version. Value options can refer to the latest docs CreateDdrInstance EngineVersion.

Link copied to clipboard
val forceRestart: Output<Boolean>? = null

Set it to true to make some parameter efficient when modifying them. Default to false.

Link copied to clipboard
val freshWhiteListReadins: Output<String>? = null

The read-only instances to which you want to synchronize the IP address whitelist.

Link copied to clipboard
val haConfig: Output<String>? = null

The primary/secondary switchover mode of the instance. Default value: Auto. Valid values:

Link copied to clipboard
val instanceName: Output<String>? = null

The name of DB instance. It a string of 2 to 256 characters.

Link copied to clipboard
val instanceStorage: Output<Int>? = null

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB. This value must be a multiple of 5 GB. For more information, see Primary ApsaraDB RDS instance types.

Link copied to clipboard
val instanceType: Output<String>? = null

DB Instance type.

Link copied to clipboard
val maintainTime: Output<String>? = null

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

Link copied to clipboard
val manualHaTime: Output<String>? = null

The time after when you want to enable automatic primary/secondary switchover. At most, you can set this parameter to 23:59:59 seven days later. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Link copied to clipboard
val modifyMode: Output<String>? = null

The method that is used to modify the IP address whitelist. Default value: Cover. Valid values:

Link copied to clipboard
val monitoringPeriod: Output<Int>? = null

The monitoring frequency in seconds. Valid values are 5, 60, 300. Defaults to 300.

Link copied to clipboard

Set of parameters needs to be set after DB instance was launched. Available parameters can refer to the latest docs View database parameter templates . See parameters below.

Link copied to clipboard
val paymentType: Output<String>? = null

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

Link copied to clipboard
val period: Output<Int>? = null

The duration that you will buy DB instance (in month). It is valid when payment_type is Subscription. Valid values: 1~9, 12, 24, 36.

Link copied to clipboard

The configuration of AD domain . See pg_hba_conf below.

Link copied to clipboard
val port: Output<String>? = null

The private port of the database service. If you want to update public port, please use resource alicloud.rds.Connection port.

Link copied to clipboard
val privateIpAddress: Output<String>? = null

The private IP address of the instance. The private IP address must be within the Classless Inter-Domain Routing (CIDR) block of the vSwitch that is specified by the VSwitchId parameter.

Link copied to clipboard
val releasedKeepPolicy: Output<String>? = null

The policy based on which ApsaraDB RDS retains archived backup files after the instance is released. Valid values:

Link copied to clipboard
val replicationAcl: Output<String>? = null

The method that is used to verify the replication permission. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. In addition, this parameter is available only when the public key of the CA that issues client certificates is enabled. Valid values:

Link copied to clipboard
val resourceGroupId: Output<String>? = null

The ID of resource group which the DB instance belongs.

Link copied to clipboard
val restoreTime: Output<String>? = null

The point in time to which you want to restore data. The point in time that you specify must be earlier than the current time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Link copied to clipboard
val restoreType: Output<String>? = null

The method that is used to restore data. Valid values:

Link copied to clipboard
val securityGroupIds: Output<List<String>>? = null

) The list IDs to join ECS Security Group. At most supports three security groups.

Link copied to clipboard
val securityIpMode: Output<String>? = null

Valid values are normal, safety, Default to normal. support safety switch to high security access mode.

Link copied to clipboard
val securityIps: Output<List<String>>? = null

List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is 1,32).

Link copied to clipboard
val securityIpType: Output<String>? = null

The type of IP address in the IP address whitelist.

Link copied to clipboard
val serverCert: Output<String>? = null

The content of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. If you set the CAType parameter to custom, you must also specify this parameter.

Link copied to clipboard
val serverKey: Output<String>? = null

The private key of the server certificate. This parameter is supported only when the instance runs PostgreSQL with standard or enhanced SSDs. If you set the CAType parameter to custom, you must also specify this parameter.

Link copied to clipboard
val sourceDbInstanceName: Output<String>? = null

The ID of the source instance if you want to restore data to a point in time.

Link copied to clipboard
val sourceRegion: Output<String>? = null

The region ID of the source instance if you want to restore data to a point in time.

Link copied to clipboard
val sqlCollectorConfigValue: Output<Int>? = null

The sql collector keep time of the instance. Valid values are 30, 180, 365, 1095, 1825, Default to 30.

Link copied to clipboard
val sqlCollectorStatus: Output<String>? = null

The sql collector status of the instance. Valid values are Enabled, Disabled, Default to Disabled.

Link copied to clipboard
val sslAction: Output<String>? = null

Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate. See more engine and engineVersion limitation.

Link copied to clipboard
val storageAutoScale: Output<String>? = null

Automatic storage space expansion switch. Valid values:

Link copied to clipboard
val storageThreshold: Output<Int>? = null

The trigger threshold (percentage) for automatic storage space expansion. Valid values:

Link copied to clipboard
val storageUpperBound: Output<Int>? = null

The upper limit of the total storage space for automatic expansion of the storage space, that is, automatic expansion will not cause the total storage space of the instance to exceed this value. Unit: GB. The value must be ≥0.

Link copied to clipboard
val switchTime: Output<String>? = null

The specific point in time when you want to perform the update. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. It is valid only when upgrade_db_instance_kernel_version = true. The time must be in UTC.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A mapping of tags to assign to the resource.

Link copied to clipboard
val targetMinorVersion: Output<String>? = null

The minor engine version to which you want to update the instance. If you do not specify this parameter, the instance is updated to the latest minor engine version. It is valid only when upgrade_db_instance_kernel_version = true. You must specify the minor engine version in one of the following formats:

Link copied to clipboard
val tcpConnectionType: Output<String>? = null

The availability check method of the instance. Valid values:

Link copied to clipboard
val tdeStatus: Output<String>? = null

The TDE(Transparent Data Encryption) status. See more engine and engineVersion limitation.

Link copied to clipboard

Whether to upgrade a minor version of the kernel. Valid values:

Link copied to clipboard
val upgradeTime: Output<String>? = null

The method to update the minor engine version. Default value: Immediate. It is valid only when upgrade_db_instance_kernel_version = true. Valid values:

Link copied to clipboard
val vpcId: Output<String>? = null

The VPC ID of the instance.

Link copied to clipboard
val vswitchId: Output<String>? = null

The virtual switch ID to launch DB instances in one VPC. If there are multiple vswitches, separate them with commas.

Link copied to clipboard
val whitelistNetworkType: Output<String>? = null

The network type of the IP address whitelist. Default value: MIX. Valid values:

Link copied to clipboard
val zoneId: Output<String>? = null

The Zone to launch the DB instance. It supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in the one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.

Functions

Link copied to clipboard
open override fun toJava(): DdrInstanceArgs