alicloud logo
Alibaba Cloud v3.34.0, Mar 17 23

alicloud.rds.DdrInstance

Import

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

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

Create DdrInstance Resource

new DdrInstance(name: string, args: DdrInstanceArgs, opts?: CustomResourceOptions);
@overload
def DdrInstance(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                acl: Optional[str] = None,
                auto_renew: Optional[bool] = None,
                auto_renew_period: Optional[int] = None,
                auto_upgrade_minor_version: Optional[str] = None,
                backup_set_id: Optional[str] = None,
                ca_type: Optional[str] = None,
                client_ca_cert: Optional[str] = None,
                client_ca_enabled: Optional[int] = None,
                client_cert_revocation_list: Optional[str] = None,
                client_crl_enabled: Optional[int] = None,
                connection_string_prefix: Optional[str] = None,
                db_instance_ip_array_attribute: Optional[str] = None,
                db_instance_ip_array_name: Optional[str] = None,
                db_instance_storage_type: Optional[str] = None,
                deletion_protection: Optional[bool] = None,
                effective_time: Optional[str] = None,
                encryption_key: Optional[str] = None,
                engine: Optional[str] = None,
                engine_version: Optional[str] = None,
                force_restart: Optional[bool] = None,
                fresh_white_list_readins: Optional[str] = None,
                ha_config: Optional[str] = None,
                instance_name: Optional[str] = None,
                instance_storage: Optional[int] = None,
                instance_type: Optional[str] = None,
                maintain_time: Optional[str] = None,
                manual_ha_time: Optional[str] = None,
                modify_mode: Optional[str] = None,
                monitoring_period: Optional[int] = None,
                parameters: Optional[Sequence[DdrInstanceParameterArgs]] = None,
                payment_type: Optional[str] = None,
                period: Optional[int] = None,
                pg_hba_confs: Optional[Sequence[DdrInstancePgHbaConfArgs]] = None,
                port: Optional[str] = None,
                private_ip_address: Optional[str] = None,
                released_keep_policy: Optional[str] = None,
                replication_acl: Optional[str] = None,
                resource_group_id: Optional[str] = None,
                restore_time: Optional[str] = None,
                restore_type: Optional[str] = None,
                security_group_ids: Optional[Sequence[str]] = None,
                security_ip_mode: Optional[str] = None,
                security_ip_type: Optional[str] = None,
                security_ips: Optional[Sequence[str]] = None,
                server_cert: Optional[str] = None,
                server_key: Optional[str] = None,
                source_db_instance_name: Optional[str] = None,
                source_region: Optional[str] = None,
                sql_collector_config_value: Optional[int] = None,
                sql_collector_status: Optional[str] = None,
                ssl_action: Optional[str] = None,
                storage_auto_scale: Optional[str] = None,
                storage_threshold: Optional[int] = None,
                storage_upper_bound: Optional[int] = None,
                switch_time: Optional[str] = None,
                tags: Optional[Mapping[str, Any]] = None,
                target_minor_version: Optional[str] = None,
                tcp_connection_type: Optional[str] = None,
                tde_status: Optional[str] = None,
                upgrade_db_instance_kernel_version: Optional[bool] = None,
                upgrade_time: Optional[str] = None,
                vpc_id: Optional[str] = None,
                vswitch_id: Optional[str] = None,
                whitelist_network_type: Optional[str] = None,
                zone_id: Optional[str] = None)
@overload
def DdrInstance(resource_name: str,
                args: DdrInstanceArgs,
                opts: Optional[ResourceOptions] = None)
func NewDdrInstance(ctx *Context, name string, args DdrInstanceArgs, opts ...ResourceOption) (*DdrInstance, error)
public DdrInstance(string name, DdrInstanceArgs args, CustomResourceOptions? opts = null)
public DdrInstance(String name, DdrInstanceArgs args)
public DdrInstance(String name, DdrInstanceArgs args, CustomResourceOptions options)
type: alicloud:rds:DdrInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DdrInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DdrInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DdrInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DdrInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DdrInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DdrInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DdrInstance resource accepts the following input properties:

Engine string

Database type. Value options: MySQL, SQLServer.

EngineVersion string

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

InstanceStorage int

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

InstanceType string

DB Instance type.

PaymentType string

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

RestoreType string

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
Acl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
AutoRenew bool

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

AutoRenewPeriod int

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.

AutoUpgradeMinorVersion string

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
BackupSetId string

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.

CaType string

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
ClientCaCert string

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.

ClientCaEnabled int

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:

  • 1: enables the public key
  • 0: disables the public key
ClientCertRevocationList string

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.

ClientCrlEnabled int

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:

  • 1: enables the CRL
  • 0: disables the CRL
ConnectionStringPrefix string
DbInstanceIpArrayAttribute string

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

DbInstanceIpArrayName string

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

DbInstanceStorageType string

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
DeletionProtection bool

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
EffectiveTime string

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
EncryptionKey string

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

ForceRestart bool

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

FreshWhiteListReadins string

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
HaConfig string

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
InstanceName string

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

MaintainTime string

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

ManualHaTime string

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.

ModifyMode string

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
MonitoringPeriod int

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

Parameters List<Pulumi.AliCloud.Rds.Inputs.DdrInstanceParameterArgs>

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

Period int
PgHbaConfs List<Pulumi.AliCloud.Rds.Inputs.DdrInstancePgHbaConfArgs>

The configuration of AD domain (documented below).

Port string
PrivateIpAddress string

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.

ReleasedKeepPolicy string

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
ReplicationAcl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
ResourceGroupId string

The ID of resource group which the DB instance belongs.

RestoreTime string

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.

SecurityGroupIds List<string>

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

SecurityIpMode string

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

SecurityIpType string

The type of IP address in the IP address whitelist.

SecurityIps List<string>

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]).

ServerCert string

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.

ServerKey string

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.

SourceDbInstanceName string

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

Block pg_hba_conf

SourceRegion string

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

SqlCollectorConfigValue int

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

SqlCollectorStatus string

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

SslAction string

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.

StorageAutoScale string

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
StorageThreshold int

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

  • 10
  • 20
  • 30
  • 40
  • 50
StorageUpperBound int

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.

SwitchTime string

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.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
TargetMinorVersion string

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
TcpConnectionType string

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
TdeStatus string

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

UpgradeDbInstanceKernelVersion bool

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

  • true: upgrade
  • false: not to upgrade
UpgradeTime string

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
VpcId string

The VPC ID of the instance.

VswitchId string

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

WhitelistNetworkType string

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
ZoneId string

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.

Engine string

Database type. Value options: MySQL, SQLServer.

EngineVersion string

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

InstanceStorage int

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

InstanceType string

DB Instance type.

PaymentType string

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

RestoreType string

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
Acl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
AutoRenew bool

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

AutoRenewPeriod int

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.

AutoUpgradeMinorVersion string

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
BackupSetId string

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.

CaType string

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
ClientCaCert string

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.

ClientCaEnabled int

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:

  • 1: enables the public key
  • 0: disables the public key
ClientCertRevocationList string

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.

ClientCrlEnabled int

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:

  • 1: enables the CRL
  • 0: disables the CRL
ConnectionStringPrefix string
DbInstanceIpArrayAttribute string

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

DbInstanceIpArrayName string

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

DbInstanceStorageType string

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
DeletionProtection bool

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
EffectiveTime string

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
EncryptionKey string

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

ForceRestart bool

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

FreshWhiteListReadins string

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
HaConfig string

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
InstanceName string

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

MaintainTime string

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

ManualHaTime string

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.

ModifyMode string

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
MonitoringPeriod int

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

Parameters []DdrInstanceParameterArgs

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

Period int
PgHbaConfs []DdrInstancePgHbaConfArgs

The configuration of AD domain (documented below).

Port string
PrivateIpAddress string

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.

ReleasedKeepPolicy string

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
ReplicationAcl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
ResourceGroupId string

The ID of resource group which the DB instance belongs.

RestoreTime string

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.

SecurityGroupIds []string

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

SecurityIpMode string

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

SecurityIpType string

The type of IP address in the IP address whitelist.

SecurityIps []string

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]).

ServerCert string

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.

ServerKey string

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.

SourceDbInstanceName string

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

Block pg_hba_conf

SourceRegion string

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

SqlCollectorConfigValue int

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

SqlCollectorStatus string

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

SslAction string

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.

StorageAutoScale string

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
StorageThreshold int

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

  • 10
  • 20
  • 30
  • 40
  • 50
StorageUpperBound int

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.

SwitchTime string

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.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
TargetMinorVersion string

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
TcpConnectionType string

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
TdeStatus string

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

UpgradeDbInstanceKernelVersion bool

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

  • true: upgrade
  • false: not to upgrade
UpgradeTime string

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
VpcId string

The VPC ID of the instance.

VswitchId string

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

WhitelistNetworkType string

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
ZoneId string

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.

engine String

Database type. Value options: MySQL, SQLServer.

engineVersion String

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

instanceStorage Integer

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

instanceType String

DB Instance type.

paymentType String

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

restoreType String

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
acl String

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
autoRenew Boolean

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

autoRenewPeriod Integer

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.

autoUpgradeMinorVersion String

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
backupSetId String

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.

caType String

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
clientCaCert String

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.

clientCaEnabled Integer

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:

  • 1: enables the public key
  • 0: disables the public key
clientCertRevocationList String

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.

clientCrlEnabled Integer

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:

  • 1: enables the CRL
  • 0: disables the CRL
connectionStringPrefix String
dbInstanceIpArrayAttribute String

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

dbInstanceIpArrayName String

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

dbInstanceStorageType String

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
deletionProtection Boolean

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
effectiveTime String

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
encryptionKey String

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

forceRestart Boolean

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

freshWhiteListReadins String

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
haConfig String

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
instanceName String

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

maintainTime String

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

manualHaTime String

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.

modifyMode String

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
monitoringPeriod Integer

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

parameters List<DdrInstanceParameterArgs>

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

period Integer
pgHbaConfs List<DdrInstancePgHbaConfArgs>

The configuration of AD domain (documented below).

port String
privateIpAddress String

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.

releasedKeepPolicy String

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
replicationAcl String

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
resourceGroupId String

The ID of resource group which the DB instance belongs.

restoreTime String

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.

securityGroupIds List<String>

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

securityIpMode String

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

securityIpType String

The type of IP address in the IP address whitelist.

securityIps List<String>

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]).

serverCert String

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.

serverKey String

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.

sourceDbInstanceName String

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

Block pg_hba_conf

sourceRegion String

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

sqlCollectorConfigValue Integer

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

sqlCollectorStatus String

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

sslAction String

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.

storageAutoScale String

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
storageThreshold Integer

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

  • 10
  • 20
  • 30
  • 40
  • 50
storageUpperBound Integer

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.

switchTime String

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.

tags Map<String,Object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
targetMinorVersion String

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
tcpConnectionType String

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
tdeStatus String

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

upgradeDbInstanceKernelVersion Boolean

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

  • true: upgrade
  • false: not to upgrade
upgradeTime String

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
vpcId String

The VPC ID of the instance.

vswitchId String

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

whitelistNetworkType String

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
zoneId String

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.

engine string

Database type. Value options: MySQL, SQLServer.

engineVersion string

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

instanceStorage number

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

instanceType string

DB Instance type.

paymentType string

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

restoreType string

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
acl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
autoRenew boolean

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

autoRenewPeriod number

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.

autoUpgradeMinorVersion string

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
backupSetId string

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.

caType string

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
clientCaCert string

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.

clientCaEnabled number

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:

  • 1: enables the public key
  • 0: disables the public key
clientCertRevocationList string

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.

clientCrlEnabled number

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:

  • 1: enables the CRL
  • 0: disables the CRL
connectionStringPrefix string
dbInstanceIpArrayAttribute string

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

dbInstanceIpArrayName string

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

dbInstanceStorageType string

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
deletionProtection boolean

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
effectiveTime string

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
encryptionKey string

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

forceRestart boolean

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

freshWhiteListReadins string

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
haConfig string

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
instanceName string

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

maintainTime string

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

manualHaTime string

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.

modifyMode string

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
monitoringPeriod number

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

parameters DdrInstanceParameterArgs[]

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

period number
pgHbaConfs DdrInstancePgHbaConfArgs[]

The configuration of AD domain (documented below).

port string
privateIpAddress string

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.

releasedKeepPolicy string

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
replicationAcl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
resourceGroupId string

The ID of resource group which the DB instance belongs.

restoreTime string

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.

securityGroupIds string[]

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

securityIpMode string

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

securityIpType string

The type of IP address in the IP address whitelist.

securityIps string[]

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]).

serverCert string

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.

serverKey string

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.

sourceDbInstanceName string

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

Block pg_hba_conf

sourceRegion string

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

sqlCollectorConfigValue number

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

sqlCollectorStatus string

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

sslAction string

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.

storageAutoScale string

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
storageThreshold number

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

  • 10
  • 20
  • 30
  • 40
  • 50
storageUpperBound number

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.

switchTime string

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.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
targetMinorVersion string

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
tcpConnectionType string

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
tdeStatus string

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

upgradeDbInstanceKernelVersion boolean

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

  • true: upgrade
  • false: not to upgrade
upgradeTime string

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
vpcId string

The VPC ID of the instance.

vswitchId string

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

whitelistNetworkType string

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
zoneId string

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.

engine str

Database type. Value options: MySQL, SQLServer.

engine_version str

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

instance_storage int

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

instance_type str

DB Instance type.

payment_type str

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

restore_type str

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
acl str

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
auto_renew bool

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

auto_renew_period int

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.

auto_upgrade_minor_version str

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
backup_set_id str

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.

ca_type str

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
client_ca_cert str

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.

client_ca_enabled int

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:

  • 1: enables the public key
  • 0: disables the public key
client_cert_revocation_list str

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.

client_crl_enabled int

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:

  • 1: enables the CRL
  • 0: disables the CRL
connection_string_prefix str
db_instance_ip_array_attribute str

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

db_instance_ip_array_name str

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

db_instance_storage_type str

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
deletion_protection bool

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
effective_time str

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
encryption_key str

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

force_restart bool

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

fresh_white_list_readins str

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
ha_config str

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
instance_name str

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

maintain_time str

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

manual_ha_time str

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.

modify_mode str

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
monitoring_period int

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

parameters Sequence[DdrInstanceParameterArgs]

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

period int
pg_hba_confs Sequence[DdrInstancePgHbaConfArgs]

The configuration of AD domain (documented below).

port str
private_ip_address str

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.

released_keep_policy str

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
replication_acl str

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
resource_group_id str

The ID of resource group which the DB instance belongs.

restore_time str

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.

security_group_ids Sequence[str]

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

security_ip_mode str

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

security_ip_type str

The type of IP address in the IP address whitelist.

security_ips Sequence[str]

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]).

server_cert str

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.

server_key str

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.

source_db_instance_name str

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

Block pg_hba_conf

source_region str

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

sql_collector_config_value int

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

sql_collector_status str

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

ssl_action str

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.

storage_auto_scale str

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
storage_threshold int

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

  • 10
  • 20
  • 30
  • 40
  • 50
storage_upper_bound int

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.

switch_time str

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.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
target_minor_version str

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
tcp_connection_type str

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
tde_status str

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

upgrade_db_instance_kernel_version bool

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

  • true: upgrade
  • false: not to upgrade
upgrade_time str

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
vpc_id str

The VPC ID of the instance.

vswitch_id str

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

whitelist_network_type str

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
zone_id str

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.

engine String

Database type. Value options: MySQL, SQLServer.

engineVersion String

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

instanceStorage Number

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

instanceType String

DB Instance type.

paymentType String

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

restoreType String

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
acl String

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
autoRenew Boolean

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

autoRenewPeriod Number

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.

autoUpgradeMinorVersion String

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
backupSetId String

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.

caType String

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
clientCaCert String

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.

clientCaEnabled Number

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:

  • 1: enables the public key
  • 0: disables the public key
clientCertRevocationList String

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.

clientCrlEnabled Number

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:

  • 1: enables the CRL
  • 0: disables the CRL
connectionStringPrefix String
dbInstanceIpArrayAttribute String

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

dbInstanceIpArrayName String

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

dbInstanceStorageType String

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
deletionProtection Boolean

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
effectiveTime String

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
encryptionKey String

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

forceRestart Boolean

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

freshWhiteListReadins String

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
haConfig String

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
instanceName String

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

maintainTime String

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

manualHaTime String

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.

modifyMode String

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
monitoringPeriod Number

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

parameters List<Property Map>

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

period Number
pgHbaConfs List<Property Map>

The configuration of AD domain (documented below).

port String
privateIpAddress String

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.

releasedKeepPolicy String

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
replicationAcl String

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
resourceGroupId String

The ID of resource group which the DB instance belongs.

restoreTime String

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.

securityGroupIds List<String>

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

securityIpMode String

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

securityIpType String

The type of IP address in the IP address whitelist.

securityIps List<String>

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]).

serverCert String

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.

serverKey String

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.

sourceDbInstanceName String

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

Block pg_hba_conf

sourceRegion String

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

sqlCollectorConfigValue Number

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

sqlCollectorStatus String

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

sslAction String

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.

storageAutoScale String

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
storageThreshold Number

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

  • 10
  • 20
  • 30
  • 40
  • 50
storageUpperBound Number

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.

switchTime String

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.

tags Map<Any>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
targetMinorVersion String

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
tcpConnectionType String

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
tdeStatus String

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

upgradeDbInstanceKernelVersion Boolean

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

  • true: upgrade
  • false: not to upgrade
upgradeTime String

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
vpcId String

The VPC ID of the instance.

vswitchId String

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

whitelistNetworkType String

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
zoneId String

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the DdrInstance resource produces the following output properties:

Category string

The RDS edition of the instance.

ConnectionString string

RDS database connection string.

Id string

The provider-assigned unique ID for this managed resource.

SslStatus string

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

ZoneIdSlaveA string

The region ID of the secondary instance if you create a secondary instance.

ZoneIdSlaveB string

The region ID of the log instance if you create a log instance.

Category string

The RDS edition of the instance.

ConnectionString string

RDS database connection string.

Id string

The provider-assigned unique ID for this managed resource.

SslStatus string

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

ZoneIdSlaveA string

The region ID of the secondary instance if you create a secondary instance.

ZoneIdSlaveB string

The region ID of the log instance if you create a log instance.

category String

The RDS edition of the instance.

connectionString String

RDS database connection string.

id String

The provider-assigned unique ID for this managed resource.

sslStatus String

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

zoneIdSlaveA String

The region ID of the secondary instance if you create a secondary instance.

zoneIdSlaveB String

The region ID of the log instance if you create a log instance.

category string

The RDS edition of the instance.

connectionString string

RDS database connection string.

id string

The provider-assigned unique ID for this managed resource.

sslStatus string

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

zoneIdSlaveA string

The region ID of the secondary instance if you create a secondary instance.

zoneIdSlaveB string

The region ID of the log instance if you create a log instance.

category str

The RDS edition of the instance.

connection_string str

RDS database connection string.

id str

The provider-assigned unique ID for this managed resource.

ssl_status str

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

zone_id_slave_a str

The region ID of the secondary instance if you create a secondary instance.

zone_id_slave_b str

The region ID of the log instance if you create a log instance.

category String

The RDS edition of the instance.

connectionString String

RDS database connection string.

id String

The provider-assigned unique ID for this managed resource.

sslStatus String

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

zoneIdSlaveA String

The region ID of the secondary instance if you create a secondary instance.

zoneIdSlaveB String

The region ID of the log instance if you create a log instance.

Look up Existing DdrInstance Resource

Get an existing DdrInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DdrInstanceState, opts?: CustomResourceOptions): DdrInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl: Optional[str] = None,
        auto_renew: Optional[bool] = None,
        auto_renew_period: Optional[int] = None,
        auto_upgrade_minor_version: Optional[str] = None,
        backup_set_id: Optional[str] = None,
        ca_type: Optional[str] = None,
        category: Optional[str] = None,
        client_ca_cert: Optional[str] = None,
        client_ca_enabled: Optional[int] = None,
        client_cert_revocation_list: Optional[str] = None,
        client_crl_enabled: Optional[int] = None,
        connection_string: Optional[str] = None,
        connection_string_prefix: Optional[str] = None,
        db_instance_ip_array_attribute: Optional[str] = None,
        db_instance_ip_array_name: Optional[str] = None,
        db_instance_storage_type: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        effective_time: Optional[str] = None,
        encryption_key: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        force_restart: Optional[bool] = None,
        fresh_white_list_readins: Optional[str] = None,
        ha_config: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_storage: Optional[int] = None,
        instance_type: Optional[str] = None,
        maintain_time: Optional[str] = None,
        manual_ha_time: Optional[str] = None,
        modify_mode: Optional[str] = None,
        monitoring_period: Optional[int] = None,
        parameters: Optional[Sequence[DdrInstanceParameterArgs]] = None,
        payment_type: Optional[str] = None,
        period: Optional[int] = None,
        pg_hba_confs: Optional[Sequence[DdrInstancePgHbaConfArgs]] = None,
        port: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        released_keep_policy: Optional[str] = None,
        replication_acl: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        restore_time: Optional[str] = None,
        restore_type: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        security_ip_mode: Optional[str] = None,
        security_ip_type: Optional[str] = None,
        security_ips: Optional[Sequence[str]] = None,
        server_cert: Optional[str] = None,
        server_key: Optional[str] = None,
        source_db_instance_name: Optional[str] = None,
        source_region: Optional[str] = None,
        sql_collector_config_value: Optional[int] = None,
        sql_collector_status: Optional[str] = None,
        ssl_action: Optional[str] = None,
        ssl_status: Optional[str] = None,
        storage_auto_scale: Optional[str] = None,
        storage_threshold: Optional[int] = None,
        storage_upper_bound: Optional[int] = None,
        switch_time: Optional[str] = None,
        tags: Optional[Mapping[str, Any]] = None,
        target_minor_version: Optional[str] = None,
        tcp_connection_type: Optional[str] = None,
        tde_status: Optional[str] = None,
        upgrade_db_instance_kernel_version: Optional[bool] = None,
        upgrade_time: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        whitelist_network_type: Optional[str] = None,
        zone_id: Optional[str] = None,
        zone_id_slave_a: Optional[str] = None,
        zone_id_slave_b: Optional[str] = None) -> DdrInstance
func GetDdrInstance(ctx *Context, name string, id IDInput, state *DdrInstanceState, opts ...ResourceOption) (*DdrInstance, error)
public static DdrInstance Get(string name, Input<string> id, DdrInstanceState? state, CustomResourceOptions? opts = null)
public static DdrInstance get(String name, Output<String> id, DdrInstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Acl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
AutoRenew bool

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

AutoRenewPeriod int

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.

AutoUpgradeMinorVersion string

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
BackupSetId string

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.

CaType string

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
Category string

The RDS edition of the instance.

ClientCaCert string

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.

ClientCaEnabled int

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:

  • 1: enables the public key
  • 0: disables the public key
ClientCertRevocationList string

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.

ClientCrlEnabled int

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:

  • 1: enables the CRL
  • 0: disables the CRL
ConnectionString string

RDS database connection string.

ConnectionStringPrefix string
DbInstanceIpArrayAttribute string

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

DbInstanceIpArrayName string

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

DbInstanceStorageType string

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
DeletionProtection bool

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
EffectiveTime string

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
EncryptionKey string

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

Engine string

Database type. Value options: MySQL, SQLServer.

EngineVersion string

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

ForceRestart bool

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

FreshWhiteListReadins string

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
HaConfig string

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
InstanceName string

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

InstanceStorage int

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

InstanceType string

DB Instance type.

MaintainTime string

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

ManualHaTime string

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.

ModifyMode string

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
MonitoringPeriod int

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

Parameters List<Pulumi.AliCloud.Rds.Inputs.DdrInstanceParameterArgs>

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

PaymentType string

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

Period int
PgHbaConfs List<Pulumi.AliCloud.Rds.Inputs.DdrInstancePgHbaConfArgs>

The configuration of AD domain (documented below).

Port string
PrivateIpAddress string

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.

ReleasedKeepPolicy string

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
ReplicationAcl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
ResourceGroupId string

The ID of resource group which the DB instance belongs.

RestoreTime string

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.

RestoreType string

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
SecurityGroupIds List<string>

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

SecurityIpMode string

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

SecurityIpType string

The type of IP address in the IP address whitelist.

SecurityIps List<string>

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]).

ServerCert string

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.

ServerKey string

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.

SourceDbInstanceName string

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

Block pg_hba_conf

SourceRegion string

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

SqlCollectorConfigValue int

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

SqlCollectorStatus string

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

SslAction string

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.

SslStatus string

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

StorageAutoScale string

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
StorageThreshold int

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

  • 10
  • 20
  • 30
  • 40
  • 50
StorageUpperBound int

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.

SwitchTime string

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.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
TargetMinorVersion string

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
TcpConnectionType string

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
TdeStatus string

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

UpgradeDbInstanceKernelVersion bool

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

  • true: upgrade
  • false: not to upgrade
UpgradeTime string

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
VpcId string

The VPC ID of the instance.

VswitchId string

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

WhitelistNetworkType string

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
ZoneId string

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.

ZoneIdSlaveA string

The region ID of the secondary instance if you create a secondary instance.

ZoneIdSlaveB string

The region ID of the log instance if you create a log instance.

Acl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
AutoRenew bool

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

AutoRenewPeriod int

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.

AutoUpgradeMinorVersion string

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
BackupSetId string

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.

CaType string

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
Category string

The RDS edition of the instance.

ClientCaCert string

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.

ClientCaEnabled int

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:

  • 1: enables the public key
  • 0: disables the public key
ClientCertRevocationList string

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.

ClientCrlEnabled int

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:

  • 1: enables the CRL
  • 0: disables the CRL
ConnectionString string

RDS database connection string.

ConnectionStringPrefix string
DbInstanceIpArrayAttribute string

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

DbInstanceIpArrayName string

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

DbInstanceStorageType string

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
DeletionProtection bool

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
EffectiveTime string

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
EncryptionKey string

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

Engine string

Database type. Value options: MySQL, SQLServer.

EngineVersion string

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

ForceRestart bool

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

FreshWhiteListReadins string

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
HaConfig string

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
InstanceName string

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

InstanceStorage int

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

InstanceType string

DB Instance type.

MaintainTime string

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

ManualHaTime string

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.

ModifyMode string

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
MonitoringPeriod int

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

Parameters []DdrInstanceParameterArgs

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

PaymentType string

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

Period int
PgHbaConfs []DdrInstancePgHbaConfArgs

The configuration of AD domain (documented below).

Port string
PrivateIpAddress string

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.

ReleasedKeepPolicy string

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
ReplicationAcl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
ResourceGroupId string

The ID of resource group which the DB instance belongs.

RestoreTime string

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.

RestoreType string

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
SecurityGroupIds []string

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

SecurityIpMode string

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

SecurityIpType string

The type of IP address in the IP address whitelist.

SecurityIps []string

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]).

ServerCert string

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.

ServerKey string

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.

SourceDbInstanceName string

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

Block pg_hba_conf

SourceRegion string

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

SqlCollectorConfigValue int

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

SqlCollectorStatus string

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

SslAction string

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.

SslStatus string

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

StorageAutoScale string

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
StorageThreshold int

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

  • 10
  • 20
  • 30
  • 40
  • 50
StorageUpperBound int

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.

SwitchTime string

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.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
TargetMinorVersion string

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
TcpConnectionType string

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
TdeStatus string

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

UpgradeDbInstanceKernelVersion bool

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

  • true: upgrade
  • false: not to upgrade
UpgradeTime string

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
VpcId string

The VPC ID of the instance.

VswitchId string

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

WhitelistNetworkType string

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
ZoneId string

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.

ZoneIdSlaveA string

The region ID of the secondary instance if you create a secondary instance.

ZoneIdSlaveB string

The region ID of the log instance if you create a log instance.

acl String

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
autoRenew Boolean

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

autoRenewPeriod Integer

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.

autoUpgradeMinorVersion String

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
backupSetId String

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.

caType String

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
category String

The RDS edition of the instance.

clientCaCert String

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.

clientCaEnabled Integer

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:

  • 1: enables the public key
  • 0: disables the public key
clientCertRevocationList String

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.

clientCrlEnabled Integer

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:

  • 1: enables the CRL
  • 0: disables the CRL
connectionString String

RDS database connection string.

connectionStringPrefix String
dbInstanceIpArrayAttribute String

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

dbInstanceIpArrayName String

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

dbInstanceStorageType String

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
deletionProtection Boolean

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
effectiveTime String

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
encryptionKey String

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

engine String

Database type. Value options: MySQL, SQLServer.

engineVersion String

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

forceRestart Boolean

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

freshWhiteListReadins String

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
haConfig String

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
instanceName String

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

instanceStorage Integer

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

instanceType String

DB Instance type.

maintainTime String

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

manualHaTime String

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.

modifyMode String

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
monitoringPeriod Integer

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

parameters List<DdrInstanceParameterArgs>

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

paymentType String

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

period Integer
pgHbaConfs List<DdrInstancePgHbaConfArgs>

The configuration of AD domain (documented below).

port String
privateIpAddress String

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.

releasedKeepPolicy String

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
replicationAcl String

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
resourceGroupId String

The ID of resource group which the DB instance belongs.

restoreTime String

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.

restoreType String

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
securityGroupIds List<String>

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

securityIpMode String

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

securityIpType String

The type of IP address in the IP address whitelist.

securityIps List<String>

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]).

serverCert String

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.

serverKey String

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.

sourceDbInstanceName String

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

Block pg_hba_conf

sourceRegion String

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

sqlCollectorConfigValue Integer

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

sqlCollectorStatus String

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

sslAction String

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.

sslStatus String

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

storageAutoScale String

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
storageThreshold Integer

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

  • 10
  • 20
  • 30
  • 40
  • 50
storageUpperBound Integer

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.

switchTime String

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.

tags Map<String,Object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
targetMinorVersion String

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
tcpConnectionType String

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
tdeStatus String

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

upgradeDbInstanceKernelVersion Boolean

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

  • true: upgrade
  • false: not to upgrade
upgradeTime String

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
vpcId String

The VPC ID of the instance.

vswitchId String

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

whitelistNetworkType String

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
zoneId String

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.

zoneIdSlaveA String

The region ID of the secondary instance if you create a secondary instance.

zoneIdSlaveB String

The region ID of the log instance if you create a log instance.

acl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
autoRenew boolean

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

autoRenewPeriod number

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.

autoUpgradeMinorVersion string

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
backupSetId string

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.

caType string

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
category string

The RDS edition of the instance.

clientCaCert string

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.

clientCaEnabled number

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:

  • 1: enables the public key
  • 0: disables the public key
clientCertRevocationList string

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.

clientCrlEnabled number

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:

  • 1: enables the CRL
  • 0: disables the CRL
connectionString string

RDS database connection string.

connectionStringPrefix string
dbInstanceIpArrayAttribute string

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

dbInstanceIpArrayName string

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

dbInstanceStorageType string

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
deletionProtection boolean

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
effectiveTime string

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
encryptionKey string

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

engine string

Database type. Value options: MySQL, SQLServer.

engineVersion string

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

forceRestart boolean

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

freshWhiteListReadins string

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
haConfig string

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
instanceName string

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

instanceStorage number

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

instanceType string

DB Instance type.

maintainTime string

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

manualHaTime string

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.

modifyMode string

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
monitoringPeriod number

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

parameters DdrInstanceParameterArgs[]

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

paymentType string

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

period number
pgHbaConfs DdrInstancePgHbaConfArgs[]

The configuration of AD domain (documented below).

port string
privateIpAddress string

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.

releasedKeepPolicy string

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
replicationAcl string

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
resourceGroupId string

The ID of resource group which the DB instance belongs.

restoreTime string

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.

restoreType string

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
securityGroupIds string[]

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

securityIpMode string

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

securityIpType string

The type of IP address in the IP address whitelist.

securityIps string[]

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]).

serverCert string

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.

serverKey string

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.

sourceDbInstanceName string

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

Block pg_hba_conf

sourceRegion string

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

sqlCollectorConfigValue number

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

sqlCollectorStatus string

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

sslAction string

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.

sslStatus string

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

storageAutoScale string

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
storageThreshold number

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

  • 10
  • 20
  • 30
  • 40
  • 50
storageUpperBound number

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.

switchTime string

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.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
targetMinorVersion string

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
tcpConnectionType string

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
tdeStatus string

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

upgradeDbInstanceKernelVersion boolean

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

  • true: upgrade
  • false: not to upgrade
upgradeTime string

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
vpcId string

The VPC ID of the instance.

vswitchId string

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

whitelistNetworkType string

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
zoneId string

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.

zoneIdSlaveA string

The region ID of the secondary instance if you create a secondary instance.

zoneIdSlaveB string

The region ID of the log instance if you create a log instance.

acl str

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
auto_renew bool

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

auto_renew_period int

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.

auto_upgrade_minor_version str

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
backup_set_id str

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.

ca_type str

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
category str

The RDS edition of the instance.

client_ca_cert str

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.

client_ca_enabled int

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:

  • 1: enables the public key
  • 0: disables the public key
client_cert_revocation_list str

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.

client_crl_enabled int

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:

  • 1: enables the CRL
  • 0: disables the CRL
connection_string str

RDS database connection string.

connection_string_prefix str
db_instance_ip_array_attribute str

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

db_instance_ip_array_name str

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

db_instance_storage_type str

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
deletion_protection bool

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
effective_time str

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
encryption_key str

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

engine str

Database type. Value options: MySQL, SQLServer.

engine_version str

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

force_restart bool

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

fresh_white_list_readins str

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
ha_config str

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
instance_name str

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

instance_storage int

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

instance_type str

DB Instance type.

maintain_time str

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

manual_ha_time str

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.

modify_mode str

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
monitoring_period int

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

parameters Sequence[DdrInstanceParameterArgs]

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

payment_type str

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

period int
pg_hba_confs Sequence[DdrInstancePgHbaConfArgs]

The configuration of AD domain (documented below).

port str
private_ip_address str

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.

released_keep_policy str

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
replication_acl str

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
resource_group_id str

The ID of resource group which the DB instance belongs.

restore_time str

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.

restore_type str

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
security_group_ids Sequence[str]

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

security_ip_mode str

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

security_ip_type str

The type of IP address in the IP address whitelist.

security_ips Sequence[str]

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]).

server_cert str

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.

server_key str

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.

source_db_instance_name str

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

Block pg_hba_conf

source_region str

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

sql_collector_config_value int

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

sql_collector_status str

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

ssl_action str

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.

ssl_status str

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

storage_auto_scale str

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
storage_threshold int

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

  • 10
  • 20
  • 30
  • 40
  • 50
storage_upper_bound int

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.

switch_time str

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.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
target_minor_version str

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
tcp_connection_type str

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
tde_status str

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

upgrade_db_instance_kernel_version bool

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

  • true: upgrade
  • false: not to upgrade
upgrade_time str

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
vpc_id str

The VPC ID of the instance.

vswitch_id str

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

whitelist_network_type str

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
zone_id str

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.

zone_id_slave_a str

The region ID of the secondary instance if you create a secondary instance.

zone_id_slave_b str

The region ID of the log instance if you create a log instance.

acl String

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
autoRenew Boolean

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

autoRenewPeriod Number

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.

autoUpgradeMinorVersion String

The upgrade method to use. Valid values:

  • Auto: Instances are automatically upgraded to a higher minor version.
  • Manual: Instances are forcibly upgraded to a higher minor version when the current version is unpublished.
backupSetId String

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.

caType String

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:

  • aliyun: a cloud certificate
  • custom: a custom certificate
category String

The RDS edition of the instance.

clientCaCert String

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.

clientCaEnabled Number

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:

  • 1: enables the public key
  • 0: disables the public key
clientCertRevocationList String

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.

clientCrlEnabled Number

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:

  • 1: enables the CRL
  • 0: disables the CRL
connectionString String

RDS database connection string.

connectionStringPrefix String
dbInstanceIpArrayAttribute String

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

dbInstanceIpArrayName String

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

dbInstanceStorageType String

The storage type of the instance. Valid values:

  • local_ssd: specifies to use local SSDs. This value is recommended.
  • cloud_ssd: specifies to use standard SSDs.
  • cloud_essd: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd2: specifies to use enhanced SSDs (ESSDs).
  • cloud_essd3: specifies to use enhanced SSDs (ESSDs).
deletionProtection Boolean

The switch of delete protection. Valid values:

  • true: delete protect.
  • false: no delete protect.
effectiveTime String

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

  • Immediate: The change immediately takes effect.
  • MaintainTime: The change takes effect during the specified maintenance window. For more information, see ModifyDBInstanceMaintainTime.
encryptionKey String

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

engine String

Database type. Value options: MySQL, SQLServer.

engineVersion String

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

forceRestart Boolean

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

freshWhiteListReadins String

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

  • If the instance is attached with a read-only instance, you can use this parameter to synchronize the IP address whitelist to the read-only instance. If the instance is attached with multiple read-only instances, the read-only instances must be separated by commas (,).
  • If the instance is not attached with a read-only instance, this parameter is empty.
haConfig String

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

  • Auto: The system automatically switches over services from the primary to secondary instances in the event of a fault.
  • Manual: You must manually switch over services from the primary to secondary instances in the event of a fault.
instanceName String

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

instanceStorage Number

The storage capacity of the destination instance. Valid values: 5 to 2000. Unit: GB.

instanceType String

DB Instance type.

maintainTime String

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

manualHaTime String

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.

modifyMode String

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

  • Cover: Use the value of the SecurityIps parameter to overwrite the existing entries in the IP address whitelist.
  • Append: Add the IP addresses and CIDR blocks that are specified in the SecurityIps parameter to the IP address whitelist.
  • Delete: Delete IP addresses and CIDR blocks that are specified in the SecurityIps parameter from the IP address whitelist. You must retain at least one IP address or CIDR block.
monitoringPeriod Number

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

parameters List<Property Map>

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

paymentType String

Valid values are Subscription, PayAsYouGo, Default to PayAsYouGo.

period Number
pgHbaConfs List<Property Map>

The configuration of AD domain (documented below).

port String
privateIpAddress String

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.

releasedKeepPolicy String

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

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All the archived backup files are retained.
replicationAcl String

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:

  • cert
  • perfer
  • verify-ca
  • verify-full (supported only when the instance runs PostgreSQL 12 or later)
resourceGroupId String

The ID of resource group which the DB instance belongs.

restoreTime String

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.

restoreType String

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

  • BackupSet: Data is restored from a backup set. If you use this value, you must also specify the BackupSetID parameter.
  • BackupTime: restores data to a point in time. You must also specify the RestoreTime, SourceRegion, and SourceDBInstanceName parameters.
securityGroupIds List<String>

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

securityIpMode String

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

securityIpType String

The type of IP address in the IP address whitelist.

securityIps List<String>

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]).

serverCert String

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.

serverKey String

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.

sourceDbInstanceName String

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

Block pg_hba_conf

sourceRegion String

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

sqlCollectorConfigValue Number

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

sqlCollectorStatus String

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

sslAction String

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.

sslStatus String

Status of the SSL feature. Yes: SSL is turned on; No: SSL is turned off.

storageAutoScale String

Automatic storage space expansion switch. Valid values:

  • Enable
  • Disable
storageThreshold Number

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

  • 10
  • 20
  • 30
  • 40
  • 50
storageUpperBound Number

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.

switchTime String

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.

tags Map<Any>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
targetMinorVersion String

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:

  • PostgreSQL: rds_postgres_00_. Example: rds_postgres_1200_20200830.
  • MySQL: _. Examples: rds_20200229, xcluster_20200229, and xcluster80_20200229. The following RDS editions are supported:
  • rds: The instance runs RDS Basic or High-availability Edition.
  • xcluster: The instance runs MySQL 5.7 on RDS Enterprise Edition.
  • xcluster80: The instance runs MySQL 8.0 on RDS Enterprise Edition.
  • SQLServer: . Example: 15.0.4073.23.
tcpConnectionType String

The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.
tdeStatus String

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

upgradeDbInstanceKernelVersion Boolean

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

  • true: upgrade
  • false: not to upgrade
upgradeTime String

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

  • Immediate: The minor engine version is immediately updated.
  • MaintainTime: The minor engine version is updated during the maintenance window. For more information about how to change the maintenance window, see ModifyDBInstanceMaintainTime.
  • SpecifyTime: The minor engine version is updated at the point in time you specify.
vpcId String

The VPC ID of the instance.

vswitchId String

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

whitelistNetworkType String

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

  • Classic: classic network in enhanced whitelist mode
  • VPC: virtual private cloud (VPC) in enhanced whitelist mode
  • MIX: standard whitelist mode
zoneId String

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.

zoneIdSlaveA String

The region ID of the secondary instance if you create a secondary instance.

zoneIdSlaveB String

The region ID of the log instance if you create a log instance.

Supporting Types

DdrInstanceParameter

Name string
Value string
Name string
Value string
name String
value String
name string
value string
name str
value str
name String
value String

DdrInstancePgHbaConf

Address string

The IP addresses from which the specified users can access the specified databases. If you set this parameter to 0.0.0.0/0, the specified users are allowed to access the specified databases from all IP addresses.

Database string

The name of the database that the specified users are allowed to access. If you set this parameter to all, the specified users are allowed to access all databases in the instance. If you specify multiple databases, separate the database names with commas (,).

Method string

The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.

PriorityId int

The priority of an AD domain. If you set this parameter to 0, the AD domain has the highest priority. Valid values: 0 to 10000. This parameter is used to identify each AD domain. When you add an AD domain, the value of the PriorityId parameter of the new AD domain cannot be the same as the value of the PriorityId parameter for any existing AD domain. When you modify or delete an AD domain, you must also modify or delete the value of the PriorityId parameter for this AD domain.

Type string

The type of connection to the instance. Valid values:

  • host: specifies to verify TCP/IP connections, including SSL connections and non-SSL connections.
  • hostssl: specifies to verify only TCP/IP connections that are established over SSL connections.
  • hostnossl: specifies to verify only TCP/IP connections that are established over non-SSL connections.
User string

The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).

Mask string

The mask of the instance. If the value of the Address parameter is an IP address, you can use this parameter to specify the mask of the IP address.

Option string

Optional. The value of this parameter is based on the value of the HbaItem.N.Method parameter. In this topic, LDAP is used as an example. You must configure this parameter. For more information, see Authentication Methods.

Address string

The IP addresses from which the specified users can access the specified databases. If you set this parameter to 0.0.0.0/0, the specified users are allowed to access the specified databases from all IP addresses.

Database string

The name of the database that the specified users are allowed to access. If you set this parameter to all, the specified users are allowed to access all databases in the instance. If you specify multiple databases, separate the database names with commas (,).

Method string

The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.

PriorityId int

The priority of an AD domain. If you set this parameter to 0, the AD domain has the highest priority. Valid values: 0 to 10000. This parameter is used to identify each AD domain. When you add an AD domain, the value of the PriorityId parameter of the new AD domain cannot be the same as the value of the PriorityId parameter for any existing AD domain. When you modify or delete an AD domain, you must also modify or delete the value of the PriorityId parameter for this AD domain.

Type string

The type of connection to the instance. Valid values:

  • host: specifies to verify TCP/IP connections, including SSL connections and non-SSL connections.
  • hostssl: specifies to verify only TCP/IP connections that are established over SSL connections.
  • hostnossl: specifies to verify only TCP/IP connections that are established over non-SSL connections.
User string

The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).

Mask string

The mask of the instance. If the value of the Address parameter is an IP address, you can use this parameter to specify the mask of the IP address.

Option string

Optional. The value of this parameter is based on the value of the HbaItem.N.Method parameter. In this topic, LDAP is used as an example. You must configure this parameter. For more information, see Authentication Methods.

address String

The IP addresses from which the specified users can access the specified databases. If you set this parameter to 0.0.0.0/0, the specified users are allowed to access the specified databases from all IP addresses.

database String

The name of the database that the specified users are allowed to access. If you set this parameter to all, the specified users are allowed to access all databases in the instance. If you specify multiple databases, separate the database names with commas (,).

method String

The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.

priorityId Integer

The priority of an AD domain. If you set this parameter to 0, the AD domain has the highest priority. Valid values: 0 to 10000. This parameter is used to identify each AD domain. When you add an AD domain, the value of the PriorityId parameter of the new AD domain cannot be the same as the value of the PriorityId parameter for any existing AD domain. When you modify or delete an AD domain, you must also modify or delete the value of the PriorityId parameter for this AD domain.

type String

The type of connection to the instance. Valid values:

  • host: specifies to verify TCP/IP connections, including SSL connections and non-SSL connections.
  • hostssl: specifies to verify only TCP/IP connections that are established over SSL connections.
  • hostnossl: specifies to verify only TCP/IP connections that are established over non-SSL connections.
user String

The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).

mask String

The mask of the instance. If the value of the Address parameter is an IP address, you can use this parameter to specify the mask of the IP address.

option String

Optional. The value of this parameter is based on the value of the HbaItem.N.Method parameter. In this topic, LDAP is used as an example. You must configure this parameter. For more information, see Authentication Methods.

address string

The IP addresses from which the specified users can access the specified databases. If you set this parameter to 0.0.0.0/0, the specified users are allowed to access the specified databases from all IP addresses.

database string

The name of the database that the specified users are allowed to access. If you set this parameter to all, the specified users are allowed to access all databases in the instance. If you specify multiple databases, separate the database names with commas (,).

method string

The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.

priorityId number

The priority of an AD domain. If you set this parameter to 0, the AD domain has the highest priority. Valid values: 0 to 10000. This parameter is used to identify each AD domain. When you add an AD domain, the value of the PriorityId parameter of the new AD domain cannot be the same as the value of the PriorityId parameter for any existing AD domain. When you modify or delete an AD domain, you must also modify or delete the value of the PriorityId parameter for this AD domain.

type string

The type of connection to the instance. Valid values:

  • host: specifies to verify TCP/IP connections, including SSL connections and non-SSL connections.
  • hostssl: specifies to verify only TCP/IP connections that are established over SSL connections.
  • hostnossl: specifies to verify only TCP/IP connections that are established over non-SSL connections.
user string

The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).

mask string

The mask of the instance. If the value of the Address parameter is an IP address, you can use this parameter to specify the mask of the IP address.

option string

Optional. The value of this parameter is based on the value of the HbaItem.N.Method parameter. In this topic, LDAP is used as an example. You must configure this parameter. For more information, see Authentication Methods.

address str

The IP addresses from which the specified users can access the specified databases. If you set this parameter to 0.0.0.0/0, the specified users are allowed to access the specified databases from all IP addresses.

database str

The name of the database that the specified users are allowed to access. If you set this parameter to all, the specified users are allowed to access all databases in the instance. If you specify multiple databases, separate the database names with commas (,).

method str

The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.

priority_id int

The priority of an AD domain. If you set this parameter to 0, the AD domain has the highest priority. Valid values: 0 to 10000. This parameter is used to identify each AD domain. When you add an AD domain, the value of the PriorityId parameter of the new AD domain cannot be the same as the value of the PriorityId parameter for any existing AD domain. When you modify or delete an AD domain, you must also modify or delete the value of the PriorityId parameter for this AD domain.

type str

The type of connection to the instance. Valid values:

  • host: specifies to verify TCP/IP connections, including SSL connections and non-SSL connections.
  • hostssl: specifies to verify only TCP/IP connections that are established over SSL connections.
  • hostnossl: specifies to verify only TCP/IP connections that are established over non-SSL connections.
user str

The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).

mask str

The mask of the instance. If the value of the Address parameter is an IP address, you can use this parameter to specify the mask of the IP address.

option str

Optional. The value of this parameter is based on the value of the HbaItem.N.Method parameter. In this topic, LDAP is used as an example. You must configure this parameter. For more information, see Authentication Methods.

address String

The IP addresses from which the specified users can access the specified databases. If you set this parameter to 0.0.0.0/0, the specified users are allowed to access the specified databases from all IP addresses.

database String

The name of the database that the specified users are allowed to access. If you set this parameter to all, the specified users are allowed to access all databases in the instance. If you specify multiple databases, separate the database names with commas (,).

method String

The authentication method of Lightweight Directory Access Protocol (LDAP). Valid values: trust, reject, scram-sha-256, md5, password, gss, sspi, ldap, radius, cert, pam.

priorityId Number

The priority of an AD domain. If you set this parameter to 0, the AD domain has the highest priority. Valid values: 0 to 10000. This parameter is used to identify each AD domain. When you add an AD domain, the value of the PriorityId parameter of the new AD domain cannot be the same as the value of the PriorityId parameter for any existing AD domain. When you modify or delete an AD domain, you must also modify or delete the value of the PriorityId parameter for this AD domain.

type String

The type of connection to the instance. Valid values:

  • host: specifies to verify TCP/IP connections, including SSL connections and non-SSL connections.
  • hostssl: specifies to verify only TCP/IP connections that are established over SSL connections.
  • hostnossl: specifies to verify only TCP/IP connections that are established over non-SSL connections.
user String

The user that is allowed to access the instance. If you specify multiple users, separate the usernames with commas (,).

mask String

The mask of the instance. If the value of the Address parameter is an IP address, you can use this parameter to specify the mask of the IP address.

option String

Optional. The value of this parameter is based on the value of the HbaItem.N.Method parameter. In this topic, LDAP is used as an example. You must configure this parameter. For more information, see Authentication Methods.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.