Module rds

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

Functions

getInstanceClasses
getInstanceEngines
getInstances
getZones

Others

Resources

Resource Account

class Account extends CustomResource

Provides an RDS account resource and used to manage databases.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "Rds";
const name = config.get("name") || "dbaccountmysql";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const instance = new alicloud.rds.Instance("instance", {
    engine: "MySQL",
    engineVersion: "5.6",
    instanceName: name,
    instanceStorage: 10,
    instanceType: "rds.mysql.s1.small",
    vswitchId: defaultSwitch.id,
});
const account = new alicloud.rds.Account("account", {
    instanceId: instance.id,
    password: "Test12345",
});

constructor

new Account(name: string, args: AccountArgs, opts?: pulumi.CustomResourceOptions)

Create a Account resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountState, opts?: pulumi.CustomResourceOptions): Account

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Account

Returns true if the given object is an instance of Account. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Database description. It cannot begin with https://. It must start with a Chinese character or English letter. It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length may be 2-256 characters.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The Id of instance in which account belongs.

property kmsEncryptedPassword

public kmsEncryptedPassword: pulumi.Output<string | undefined>;

An KMS encrypts password used to a db account. If the password is filled in, this field will be ignored.

property kmsEncryptionContext

public kmsEncryptionContext: pulumi.Output<{[key: string]: any} | undefined>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating a db account with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property name

public name: pulumi.Output<string>;

Operation account requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 16 characters.

property password

public password: pulumi.Output<string | undefined>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of password and kmsEncryptedPassword fields.

property type

public type: pulumi.Output<string>;

Privilege type of account. - Normal: Common privilege. - Super: High privilege.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource AccountPrivilege

class AccountPrivilege extends CustomResource

constructor

new AccountPrivilege(name: string, args: AccountPrivilegeArgs, opts?: pulumi.CustomResourceOptions)

Create a AccountPrivilege resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountPrivilegeState, opts?: pulumi.CustomResourceOptions): AccountPrivilege

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AccountPrivilege

Returns true if the given object is an instance of AccountPrivilege. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountName

public accountName: pulumi.Output<string>;

A specified account name.

property dbNames

public dbNames: pulumi.Output<string[]>;

List of specified database name.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The Id of instance in which account belongs.

property privilege

public privilege: pulumi.Output<string | undefined>;

The privilege of one account access database. Valid values: - ReadOnly: This value is only for MySQL, MariaDB and SQL Server - ReadWrite: This value is only for MySQL, MariaDB and SQL Server - DDLOnly: (Available in 1.64.0+) This value is only for MySQL and MariaDB - DMLOnly: (Available in 1.64.0+) This value is only for MySQL and MariaDB - DBOwner: (Available in 1.64.0+) This value is only for SQL Server and PostgreSQL.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource BackupPolicy

class BackupPolicy extends CustomResource

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

NOTE: Each DB instance has a backup policy and it will be set default values when destroying the resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "Rds";
const name = config.get("name") || "dbbackuppolicybasic";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const instance = new alicloud.rds.Instance("instance", {
    engine: "MySQL",
    engineVersion: "5.6",
    instanceName: name,
    instanceStorage: 10,
    instanceType: "rds.mysql.s1.small",
    vswitchId: defaultSwitch.id,
});
const policy = new alicloud.rds.BackupPolicy("policy", {
    instanceId: instance.id,
});

constructor

new BackupPolicy(name: string, args: BackupPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a BackupPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BackupPolicyState, opts?: pulumi.CustomResourceOptions): BackupPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is BackupPolicy

Returns true if the given object is an instance of BackupPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property archiveBackupKeepCount

public archiveBackupKeepCount: pulumi.Output<number>;

Instance archive backup keep count. Valid when the enableBackupLog is true and instance is mysql local disk. When archiveBackupKeepPolicy is ByMonth Valid values: [1-31]. When archiveBackupKeepPolicy is ByWeek Valid values: [1-7].

property archiveBackupKeepPolicy

public archiveBackupKeepPolicy: pulumi.Output<string>;

Instance archive backup keep policy. Valid when the enableBackupLog is true and instance is mysql local disk. Valid values are ByMonth, Disable, KeepAll.

property archiveBackupRetentionPeriod

public archiveBackupRetentionPeriod: pulumi.Output<number>;

Instance archive backup retention days. Valid when the enableBackupLog is true and instance is mysql local disk. Valid values: [30-1095], and archiveBackupRetentionPeriod must larger than backupRetentionPeriod 730.

property backupPeriods

public backupPeriods: pulumi.Output<string[]>;

It has been deprecated from version 1.69.0, and use field ‘preferred_backup_period’ instead.

property backupRetentionPeriod

public backupRetentionPeriod: pulumi.Output<number | undefined>;

Instance backup retention days. Valid values: [7-730]. Default to 7. But mysql local disk is unlimited.

property backupTime

public backupTime: pulumi.Output<string>;

It has been deprecated from version 1.69.0, and use field ‘preferred_backup_time’ instead.

property compressType

public compressType: pulumi.Output<string>;

The compress type of instance policy. Valid values are 1, 4, 8.

property enableBackupLog

public enableBackupLog: pulumi.Output<boolean>;

Whether to backup instance log. Valid values are true, false, Default to true. Note: The ‘Basic Edition’ category Rds instance does not support setting log backup. What is Basic Edition.

property highSpaceUsageProtection

public highSpaceUsageProtection: pulumi.Output<string | undefined>;

Instance high space usage protection policy. Valid when the enableBackupLog is true. Valid values are Enable, Disable.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The Id of instance that can run database.

property localLogRetentionHours

public localLogRetentionHours: pulumi.Output<number>;

Instance log backup local retention hours. Valid when the enableBackupLog is true. Valid values: [0-7*24].

property localLogRetentionSpace

public localLogRetentionSpace: pulumi.Output<number>;

Instance log backup local retention space. Valid when the enableBackupLog is true. Valid values: [5-50].

property logBackup

public logBackup: pulumi.Output<boolean>;

It has been deprecated from version 1.68.0, and use field ‘enable_backup_log’ instead.

property logBackupFrequency

public logBackupFrequency: pulumi.Output<string>;

Instance log backup frequency. Valid when the instance engine is SQLServer. Valid values are LogInterval.

property logBackupRetentionPeriod

public logBackupRetentionPeriod: pulumi.Output<number>;

Instance log backup retention days. Valid when the enableBackupLog is 1. Valid values: [7-730]. Default to 7. It cannot be larger than backupRetentionPeriod.

property logRetentionPeriod

public logRetentionPeriod: pulumi.Output<number>;

It has been deprecated from version 1.69.0, and use field ‘log_backup_retention_period’ instead.

property preferredBackupPeriods

public preferredBackupPeriods: pulumi.Output<string[]>;

DB Instance backup period. Please set at least two days to ensure backing up at least twice a week. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [“Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, “Sunday”].

property preferredBackupTime

public preferredBackupTime: pulumi.Output<string | undefined>;

DB instance backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to “02:00Z-03:00Z”. China time is 8 hours behind it.

property retentionPeriod

public retentionPeriod: pulumi.Output<number>;

It has been deprecated from version 1.69.0, and use field ‘backup_retention_period’ instead.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Connection

class Connection extends CustomResource

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

NOTE: Each RDS instance will allocate a intranet connnection string automatically and its prifix is RDS instance ID. To avoid unnecessary conflict, please specified a internet connection prefix before applying the resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "Rds";
const name = config.get("name") || "dbconnectionbasic";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const instance = new alicloud.rds.Instance("instance", {
    engine: "MySQL",
    engineVersion: "5.6",
    instanceName: name,
    instanceStorage: 10,
    instanceType: "rds.mysql.t1.small",
    vswitchId: defaultSwitch.id,
});
const foo = new alicloud.rds.Connection("foo", {
    connectionPrefix: "testabc",
    instanceId: instance.id,
});

constructor

new Connection(name: string, args: ConnectionArgs, opts?: pulumi.CustomResourceOptions)

Create a Connection resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConnectionState, opts?: pulumi.CustomResourceOptions): Connection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Connection

Returns true if the given object is an instance of Connection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectionPrefix

public connectionPrefix: pulumi.Output<string>;

Prefix of an Internet connection string. It must be checked for uniqueness. It may consist of lowercase letters, numbers, and underlines, and must start with a letter and have no more than 30 characters. Default to + ‘tf’.

property connectionString

public connectionString: pulumi.Output<string>;

Connection instance string.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The Id of instance that can run database.

property ipAddress

public ipAddress: pulumi.Output<string>;

The ip address of connection string.

property port

public port: pulumi.Output<string | undefined>;

Internet connection port. Valid value: [3001-3999]. Default to 3306.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Database

class Database extends CustomResource

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

NOTE: This resource does not support creating ‘PPAS’ database. You have to login RDS instance to create manually.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "Rds";
const name = config.get("name") || "dbdatabasebasic";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const instance = new alicloud.rds.Instance("instance", {
    engine: "MySQL",
    engineVersion: "5.6",
    instanceName: name,
    instanceStorage: 10,
    instanceType: "rds.mysql.s1.small",
    vswitchId: defaultSwitch.id,
});
const defaultDatabase = new alicloud.rds.Database("default", {
    instanceId: instance.id,
});

constructor

new Database(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions)

Create a Database resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DatabaseState, opts?: pulumi.CustomResourceOptions): Database

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Database

Returns true if the given object is an instance of Database. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property characterSet

public characterSet: pulumi.Output<string | undefined>;

Character set. The value range is limited to the following: - MySQL: [ utf8, gbk, latin1, utf8mb4 ] (utf8mb4 only supports versions 5.5 and 5.6). - SQLServer: [ Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ] - PostgreSQL: [ KOI8U、UTF8、WIN866、WIN874、WIN1250、WIN1251、WIN1252、WIN1253、WIN1254、WIN1255、WIN1256、WIN1257、WIN1258、EUC_CN、EUC_KR、EUC_TW、EUC_JP、EUC_JIS_2004、KOI8R、MULE_INTERNAL、LATIN1、LATIN2、LATIN3、LATIN4、LATIN5、LATIN6、LATIN7、LATIN8、LATIN9、LATIN10、ISO_8859_5、ISO_8859_6、ISO_8859_7、ISO_8859_8、SQL_ASCII ]

property description

public description: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The Id of instance that can run database.

property name

public name: pulumi.Output<string>;

Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 64 characters.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Instance

class Instance extends CustomResource

Provides an RDS instance resource. A DB instance is an isolated database environment in the cloud. A DB instance can contain multiple user-created databases.

Example Usage

Create a RDS MySQL instance

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "dbInstanceconfig";
const creation = config.get("creation") || "Rds";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.rds.Instance("default", {
    engine: "MySQL",
    engineVersion: "5.6",
    instanceChargeType: "Postpaid",
    instanceName: name,
    instanceStorage: 30,
    instanceType: "rds.mysql.s2.large",
    monitoringPeriod: 60,
    vswitchId: defaultSwitch.id,
});

Create a RDS MySQL instance with specific parameters

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: alicloud_zones_default.zones.0.id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.rds.Instance("default", {
    dbInstanceClass: "rds.mysql.t1.small",
    dbInstanceStorage: "10",
    engine: "MySQL",
    engineVersion: "5.6",
    parameters: [
        {
            name: "innodbLargePrefix",
            value: "ON",
        },
        {
            name: "connectTimeout",
            value: "50",
        },
    ],
});

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property autoRenew

public autoRenew: pulumi.Output<boolean | undefined>;

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

property autoRenewPeriod

public autoRenewPeriod: pulumi.Output<number | undefined>;

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

property autoUpgradeMinorVersion

public autoUpgradeMinorVersion: pulumi.Output<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.

property connectionString

public connectionString: pulumi.Output<string>;

RDS database connection string.

property dbInstanceStorageType

public dbInstanceStorageType: pulumi.Output<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).

property engine

public engine: pulumi.Output<string>;

Database type. Value options: MySQL, SQLServer, PostgreSQL, and PPAS.

property engineVersion

public engineVersion: pulumi.Output<string>;

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

property forceRestart

public forceRestart: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceChargeType

public instanceChargeType: pulumi.Output<string | undefined>;

Valid values are Prepaid, Postpaid, Default to Postpaid. Currently, the resource only supports PostPaid to PrePaid.

property instanceName

public instanceName: pulumi.Output<string | undefined>;

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

property instanceStorage

public instanceStorage: pulumi.Output<number>;

User-defined DB instance storage space. Value range: - [5, 2000] for MySQL/PostgreSQL/PPAS HA dual node edition; - [20,1000] for MySQL 5.7 basic single node edition; - [10, 2000] for SQL Server 2008R2; - [20,2000] for SQL Server 2012 basic single node edition Increase progressively at a rate of 5 GB. For details, see Instance type table. Note: There is extra 5 GB storage for SQL Server Instance and it is not in specified instanceStorage.

property instanceType

public instanceType: pulumi.Output<string>;

DB Instance type. For details, see Instance type table.

property maintainTime

public maintainTime: pulumi.Output<string>;

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

property monitoringPeriod

public monitoringPeriod: pulumi.Output<number>;

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

property parameters

public parameters: pulumi.Output<InstanceParameter[]>;

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

property period

public period: pulumi.Output<number | undefined>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.

property port

public port: pulumi.Output<string>;

RDS database connection port.

property resourceGroupId

public resourceGroupId: pulumi.Output<string>;

The ID of resource group which the DB instance belongs.

property securityGroupId

public securityGroupId: pulumi.Output<string>;

It has been deprecated from 1.69.0 and use securityGroupIds instead.

property securityGroupIds

public securityGroupIds: pulumi.Output<string[]>;

, Available in 1.69.0+) The list IDs to join ECS Security Group. At most supports three security groups.

property securityIpMode

public securityIpMode: pulumi.Output<string | undefined>;

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

property securityIps

public securityIps: pulumi.Output<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]).

property sqlCollectorConfigValue

public sqlCollectorConfigValue: pulumi.Output<number | undefined>;

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

property sqlCollectorStatus

public sqlCollectorStatus: pulumi.Output<string | undefined>;

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

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vswitchId

public vswitchId: pulumi.Output<string | undefined>;

The virtual switch ID to launch DB instances in one VPC.

property zoneId

public zoneId: pulumi.Output<string>;

The Zone to launch the DB instance. From version 1.8.1, it supports multiple zone. If it is a multi-zone and vswitchId 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.

Resource ReadOnlyInstance

class ReadOnlyInstance extends CustomResource

Provides an RDS readonly instance resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "Rds";
const name = config.get("name") || "dbInstancevpc";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.rds.Instance("default", {
    engine: "MySQL",
    engineVersion: "5.6",
    instanceChargeType: "Postpaid",
    instanceName: name,
    instanceStorage: 20,
    instanceType: "rds.mysql.t1.small",
    securityIps: [
        "10.168.1.12",
        "100.69.7.112",
    ],
    vswitchId: defaultSwitch.id,
});
const defaultReadOnlyInstance = new alicloud.rds.ReadOnlyInstance("default", {
    engineVersion: defaultInstance.engineVersion,
    instanceName: `${name}ro`,
    instanceStorage: 30,
    instanceType: defaultInstance.instanceType,
    masterDbInstanceId: defaultInstance.id,
    vswitchId: defaultSwitch.id,
    zoneId: defaultInstance.zoneId,
});

constructor

new ReadOnlyInstance(name: string, args: ReadOnlyInstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a ReadOnlyInstance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReadOnlyInstanceState, opts?: pulumi.CustomResourceOptions): ReadOnlyInstance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ReadOnlyInstance

Returns true if the given object is an instance of ReadOnlyInstance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectionString

public connectionString: pulumi.Output<string>;

RDS database connection string.

property engine

public engine: pulumi.Output<string>;

Database type.

property engineVersion

public engineVersion: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceName

public instanceName: pulumi.Output<string>;

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

property instanceStorage

public instanceStorage: pulumi.Output<number>;

User-defined DB instance storage space. Value range: [5, 2000] for MySQL/SQL Server HA dual node edition. Increase progressively at a rate of 5 GB. For details, see Instance type table.

property instanceType

public instanceType: pulumi.Output<string>;

DB Instance type. For details, see Instance type table.

property masterDbInstanceId

public masterDbInstanceId: pulumi.Output<string>;

ID of the master instance.

property parameters

public parameters: pulumi.Output<ReadOnlyInstanceParameter[]>;

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

property port

public port: pulumi.Output<string>;

RDS database connection port.

property resourceGroupId

public resourceGroupId: pulumi.Output<string>;

The ID of resource group which the DB read-only instance belongs.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vswitchId

public vswitchId: pulumi.Output<string | undefined>;

The virtual switch ID to launch DB instances in one VPC.

property zoneId

public zoneId: pulumi.Output<string>;

The Zone to launch the DB instance.

Resource ReadWriteSplittingConnection

class ReadWriteSplittingConnection extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const creation = config.get("creation") || "Rds";
const name = config.get("name") || "dbInstancevpc";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.rds.Instance("default", {
    engine: "MySQL",
    engineVersion: "5.6",
    instanceChargeType: "Postpaid",
    instanceName: name,
    instanceStorage: 20,
    instanceType: "rds.mysql.t1.small",
    securityIps: [
        "10.168.1.12",
        "100.69.7.112",
    ],
    vswitchId: defaultSwitch.id,
});
const defaultReadOnlyInstance = new alicloud.rds.ReadOnlyInstance("default", {
    engineVersion: defaultInstance.engineVersion,
    instanceName: `${name}ro`,
    instanceStorage: 30,
    instanceType: defaultInstance.instanceType,
    masterDbInstanceId: defaultInstance.id,
    vswitchId: defaultSwitch.id,
    zoneId: defaultInstance.zoneId,
});
const defaultReadWriteSplittingConnection = new alicloud.rds.ReadWriteSplittingConnection("default", {
    connectionPrefix: "t-con-123",
    distributionType: "Standard",
    instanceId: defaultInstance.id,
}, { dependsOn: [defaultReadOnlyInstance] });

constructor

new ReadWriteSplittingConnection(name: string, args: ReadWriteSplittingConnectionArgs, opts?: pulumi.CustomResourceOptions)

Create a ReadWriteSplittingConnection resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReadWriteSplittingConnectionState, opts?: pulumi.CustomResourceOptions): ReadWriteSplittingConnection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ReadWriteSplittingConnection

Returns true if the given object is an instance of ReadWriteSplittingConnection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectionPrefix

public connectionPrefix: pulumi.Output<string | undefined>;

property connectionString

public connectionString: pulumi.Output<string>;

Connection instance string.

property distributionType

public distributionType: pulumi.Output<string>;

Read weight distribution mode. Values are as follows: Standard indicates automatic weight distribution based on types, Custom indicates custom weight distribution.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The Id of instance that can run database.

property maxDelayTime

public maxDelayTime: pulumi.Output<number>;

Delay threshold, in seconds. The value range is 0 to 7200. Default to 30. Read requests are not routed to the read-only instances with a delay greater than the threshold.

property port

public port: pulumi.Output<number>;

Intranet connection port. Valid value: [3001-3999]. Default to 3306.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property weight

public weight: pulumi.Output<{[key: string]: any} | undefined>;

Read weight distribution. Read weights increase at a step of 100 up to 10,000. Enter weights in the following format: {“Instanceid”:“Weight”,“Instanceid”:“Weight”}. This parameter must be set when distributionType is set to Custom.

Functions

Function getInstanceClasses

getInstanceClasses(args?: GetInstanceClassesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceClassesResult>

This data source provides the RDS instance classes resource available info of Alibaba Cloud.

NOTE: Available in v1.46.0+

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const resources = pulumi.output(alicloud.rds.getInstanceClasses({
    engine: "MySQL",
    engineVersion: "5.6",
    instanceChargeType: "PostPaid",
    outputFile: "./classes.txt",
}, { async: true }));

export const firstDbInstanceClass = resources.instanceClasses[0].instanceClass;

Function getInstanceEngines

getInstanceEngines(args?: GetInstanceEnginesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceEnginesResult>

This data source provides the RDS instance engines resource available info of Alibaba Cloud.

NOTE: Available in v1.46.0+

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const resources = pulumi.output(alicloud.rds.getInstanceEngines({
    engine: "MySQL",
    engineVersion: "5.6",
    instanceChargeType: "PostPaid",
    outputFile: "./engines.txt",
}, { async: true }));

export const firstDbCategory = resources.instanceEngines[0].category;

Function getInstances

getInstances(args?: GetInstancesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstancesResult>

The alicloud.rds.getInstances data source provides a collection of RDS instances available in Alibaba Cloud account. Filters support regular expression for the instance name, searches by tags, and other filters which are listed below.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const dbInstancesDs = pulumi.output(alicloud.rds.getInstances({
    nameRegex: "data-\\d+",
    status: "Running",
    tags: {
        size: "tiny",
        type: "database",
    },
}, { async: true }));

export const firstDbInstanceId = dbInstancesDs.instances[0].id;

Function getZones

getZones(args?: GetZonesArgs, opts?: pulumi.InvokeOptions): Promise<GetZonesResult>

This data source provides availability zones for RDS that can be accessed by an Alibaba Cloud account within the region configured in the provider.

NOTE: Available in v1.73.0+.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const zonesIds = alicloud.rds.getZones({});
// Create an RDS instance with the first matched zone
const db = new alicloud.rds.Instance("db", {zoneId: zonesIds.then(zonesIds => zonesIds.zones[0])});
// Other properties...

Others

interface AccountArgs

interface AccountArgs

The set of arguments for constructing a Account resource.

property description

description?: pulumi.Input<string>;

property instanceId

instanceId: pulumi.Input<string>;

The Id of instance in which account belongs.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a db account. If the password is filled in, this field will be ignored.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

property name

name?: pulumi.Input<string>;

Operation account requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 16 characters.

property password

password?: pulumi.Input<string>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of password and kmsEncryptedPassword fields.

property type

type?: pulumi.Input<string>;

Privilege type of account. - Normal: Common privilege. - Super: High privilege.

interface AccountPrivilegeArgs

interface AccountPrivilegeArgs

The set of arguments for constructing a AccountPrivilege resource.

property accountName

accountName: pulumi.Input<string>;

A specified account name.

property dbNames

dbNames: pulumi.Input<pulumi.Input<string>[]>;

List of specified database name.

property instanceId

instanceId: pulumi.Input<string>;

The Id of instance in which account belongs.

property privilege

privilege?: pulumi.Input<string>;

interface AccountPrivilegeState

interface AccountPrivilegeState

Input properties used for looking up and filtering AccountPrivilege resources.

property accountName

accountName?: pulumi.Input<string>;

A specified account name.

property dbNames

dbNames?: pulumi.Input<pulumi.Input<string>[]>;

List of specified database name.

property instanceId

instanceId?: pulumi.Input<string>;

The Id of instance in which account belongs.

property privilege

privilege?: pulumi.Input<string>;

interface AccountState

interface AccountState

Input properties used for looking up and filtering Account resources.

property description

description?: pulumi.Input<string>;

property instanceId

instanceId?: pulumi.Input<string>;

The Id of instance in which account belongs.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a db account. If the password is filled in, this field will be ignored.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

property name

name?: pulumi.Input<string>;

Operation account requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 16 characters.

property password

password?: pulumi.Input<string>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters. You have to specify one of password and kmsEncryptedPassword fields.

property type

type?: pulumi.Input<string>;

Privilege type of account. - Normal: Common privilege. - Super: High privilege.

interface BackupPolicyArgs

interface BackupPolicyArgs

The set of arguments for constructing a BackupPolicy resource.

property archiveBackupKeepCount

archiveBackupKeepCount?: pulumi.Input<number>;

property archiveBackupKeepPolicy

archiveBackupKeepPolicy?: pulumi.Input<string>;

Instance archive backup keep policy. Valid when the enableBackupLog is true and instance is mysql local disk. Valid values are ByMonth, Disable, KeepAll.

property archiveBackupRetentionPeriod

archiveBackupRetentionPeriod?: pulumi.Input<number>;

property backupPeriods

DEPRECATED Attribute 'backup_period' has been deprecated from version 1.69.0. Use preferred_backup_period instead

backupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

It has been deprecated from version 1.69.0, and use field ‘preferred_backup_period’ instead.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

Instance backup retention days. Valid values: [7-730]. Default to 7. But mysql local disk is unlimited.

property backupTime

DEPRECATED Attribute 'backup_time' has been deprecated from version 1.69.0. Use preferred_backup_time instead

backupTime?: pulumi.Input<string>;

It has been deprecated from version 1.69.0, and use field ‘preferred_backup_time’ instead.

property compressType

compressType?: pulumi.Input<string>;

The compress type of instance policy. Valid values are 1, 4, 8.

property enableBackupLog

enableBackupLog?: pulumi.Input<boolean>;

Whether to backup instance log. Valid values are true, false, Default to true. Note: The ‘Basic Edition’ category Rds instance does not support setting log backup. What is Basic Edition.

property highSpaceUsageProtection

highSpaceUsageProtection?: pulumi.Input<string>;

Instance high space usage protection policy. Valid when the enableBackupLog is true. Valid values are Enable, Disable.

property instanceId

instanceId: pulumi.Input<string>;

The Id of instance that can run database.

property localLogRetentionHours

localLogRetentionHours?: pulumi.Input<number>;

Instance log backup local retention hours. Valid when the enableBackupLog is true. Valid values: [0-7*24].

property localLogRetentionSpace

localLogRetentionSpace?: pulumi.Input<number>;

Instance log backup local retention space. Valid when the enableBackupLog is true. Valid values: [5-50].

property logBackup

DEPRECATED Attribute 'log_backup' has been deprecated from version 1.68.0. Use enable_backup_log instead

logBackup?: pulumi.Input<boolean>;

It has been deprecated from version 1.68.0, and use field ‘enable_backup_log’ instead.

property logBackupFrequency

logBackupFrequency?: pulumi.Input<string>;

Instance log backup frequency. Valid when the instance engine is SQLServer. Valid values are LogInterval.

property logBackupRetentionPeriod

logBackupRetentionPeriod?: pulumi.Input<number>;

Instance log backup retention days. Valid when the enableBackupLog is 1. Valid values: [7-730]. Default to 7. It cannot be larger than backupRetentionPeriod.

property logRetentionPeriod

DEPRECATED Attribute 'log_retention_period' has been deprecated from version 1.69.0. Use log_backup_retention_period instead

logRetentionPeriod?: pulumi.Input<number>;

It has been deprecated from version 1.69.0, and use field ‘log_backup_retention_period’ instead.

property preferredBackupPeriods

preferredBackupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

property preferredBackupTime

preferredBackupTime?: pulumi.Input<string>;

DB instance backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to “02:00Z-03:00Z”. China time is 8 hours behind it.

property retentionPeriod

DEPRECATED Attribute 'retention_period' has been deprecated from version 1.69.0. Use backup_retention_period instead

retentionPeriod?: pulumi.Input<number>;

It has been deprecated from version 1.69.0, and use field ‘backup_retention_period’ instead.

interface BackupPolicyState

interface BackupPolicyState

Input properties used for looking up and filtering BackupPolicy resources.

property archiveBackupKeepCount

archiveBackupKeepCount?: pulumi.Input<number>;

property archiveBackupKeepPolicy

archiveBackupKeepPolicy?: pulumi.Input<string>;

Instance archive backup keep policy. Valid when the enableBackupLog is true and instance is mysql local disk. Valid values are ByMonth, Disable, KeepAll.

property archiveBackupRetentionPeriod

archiveBackupRetentionPeriod?: pulumi.Input<number>;

property backupPeriods

DEPRECATED Attribute 'backup_period' has been deprecated from version 1.69.0. Use preferred_backup_period instead

backupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

It has been deprecated from version 1.69.0, and use field ‘preferred_backup_period’ instead.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

Instance backup retention days. Valid values: [7-730]. Default to 7. But mysql local disk is unlimited.

property backupTime

DEPRECATED Attribute 'backup_time' has been deprecated from version 1.69.0. Use preferred_backup_time instead

backupTime?: pulumi.Input<string>;

It has been deprecated from version 1.69.0, and use field ‘preferred_backup_time’ instead.

property compressType

compressType?: pulumi.Input<string>;

The compress type of instance policy. Valid values are 1, 4, 8.

property enableBackupLog

enableBackupLog?: pulumi.Input<boolean>;

Whether to backup instance log. Valid values are true, false, Default to true. Note: The ‘Basic Edition’ category Rds instance does not support setting log backup. What is Basic Edition.

property highSpaceUsageProtection

highSpaceUsageProtection?: pulumi.Input<string>;

Instance high space usage protection policy. Valid when the enableBackupLog is true. Valid values are Enable, Disable.

property instanceId

instanceId?: pulumi.Input<string>;

The Id of instance that can run database.

property localLogRetentionHours

localLogRetentionHours?: pulumi.Input<number>;

Instance log backup local retention hours. Valid when the enableBackupLog is true. Valid values: [0-7*24].

property localLogRetentionSpace

localLogRetentionSpace?: pulumi.Input<number>;

Instance log backup local retention space. Valid when the enableBackupLog is true. Valid values: [5-50].

property logBackup

DEPRECATED Attribute 'log_backup' has been deprecated from version 1.68.0. Use enable_backup_log instead

logBackup?: pulumi.Input<boolean>;

It has been deprecated from version 1.68.0, and use field ‘enable_backup_log’ instead.

property logBackupFrequency

logBackupFrequency?: pulumi.Input<string>;

Instance log backup frequency. Valid when the instance engine is SQLServer. Valid values are LogInterval.

property logBackupRetentionPeriod

logBackupRetentionPeriod?: pulumi.Input<number>;

Instance log backup retention days. Valid when the enableBackupLog is 1. Valid values: [7-730]. Default to 7. It cannot be larger than backupRetentionPeriod.

property logRetentionPeriod

DEPRECATED Attribute 'log_retention_period' has been deprecated from version 1.69.0. Use log_backup_retention_period instead

logRetentionPeriod?: pulumi.Input<number>;

It has been deprecated from version 1.69.0, and use field ‘log_backup_retention_period’ instead.

property preferredBackupPeriods

preferredBackupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

property preferredBackupTime

preferredBackupTime?: pulumi.Input<string>;

DB instance backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to “02:00Z-03:00Z”. China time is 8 hours behind it.

property retentionPeriod

DEPRECATED Attribute 'retention_period' has been deprecated from version 1.69.0. Use backup_retention_period instead

retentionPeriod?: pulumi.Input<number>;

It has been deprecated from version 1.69.0, and use field ‘backup_retention_period’ instead.

interface ConnectionArgs

interface ConnectionArgs

The set of arguments for constructing a Connection resource.

property connectionPrefix

connectionPrefix?: pulumi.Input<string>;

property instanceId

instanceId: pulumi.Input<string>;

The Id of instance that can run database.

property port

port?: pulumi.Input<string>;

Internet connection port. Valid value: [3001-3999]. Default to 3306.

interface ConnectionState

interface ConnectionState

Input properties used for looking up and filtering Connection resources.

property connectionPrefix

connectionPrefix?: pulumi.Input<string>;

property connectionString

connectionString?: pulumi.Input<string>;

Connection instance string.

property instanceId

instanceId?: pulumi.Input<string>;

The Id of instance that can run database.

property ipAddress

ipAddress?: pulumi.Input<string>;

The ip address of connection string.

property port

port?: pulumi.Input<string>;

Internet connection port. Valid value: [3001-3999]. Default to 3306.

interface DatabaseArgs

interface DatabaseArgs

The set of arguments for constructing a Database resource.

property characterSet

characterSet?: pulumi.Input<string>;

property description

description?: pulumi.Input<string>;

property instanceId

instanceId: pulumi.Input<string>;

The Id of instance that can run database.

property name

name?: pulumi.Input<string>;

Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 64 characters.

interface DatabaseState

interface DatabaseState

Input properties used for looking up and filtering Database resources.

property characterSet

characterSet?: pulumi.Input<string>;

property description

description?: pulumi.Input<string>;

property instanceId

instanceId?: pulumi.Input<string>;

The Id of instance that can run database.

property name

name?: pulumi.Input<string>;

Name of the database requiring a uniqueness check. It may consist of lower case letters, numbers, and underlines, and must start with a letter and have no more than 64 characters.

interface GetInstanceClassesArgs

interface GetInstanceClassesArgs

A collection of arguments for invoking getInstanceClasses.

property category

category?: undefined | string;

DB Instance category. the value like [Basic, HighAvailability, Finance], detail info.

property dbInstanceClass

dbInstanceClass?: undefined | string;

The DB instance class type by the user.

property engine

engine?: undefined | string;

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

property engineVersion

engineVersion?: undefined | string;

Database version required by the user. Value options can refer to the latest docs detail info EngineVersion.

property instanceChargeType

instanceChargeType?: undefined | string;

Filter the results by charge type. Valid values: PrePaid and PostPaid. Default to PostPaid.

property multiZone

multiZone?: undefined | false | true;

Whether to show multi available zone. Default false to not show multi availability zone.

property outputFile

outputFile?: undefined | string;

property sortedBy

sortedBy?: undefined | string;

property storageType

storageType?: undefined | string;

The DB instance storage space required by the user. Valid values: cloudSsd and localSsd.

property zoneId

zoneId?: undefined | string;

The Zone to launch the DB instance.

interface GetInstanceClassesResult

interface GetInstanceClassesResult

A collection of values returned by getInstanceClasses.

property category

category?: undefined | string;

property dbInstanceClass

dbInstanceClass?: undefined | string;

property engine

engine?: undefined | string;

property engineVersion

engineVersion?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

(Available in 1.60.0+) A list of Rds instance class codes.

property instanceChargeType

instanceChargeType?: undefined | string;

property instanceClasses

instanceClasses: GetInstanceClassesInstanceClass[];

A list of Rds available resource. Each element contains the following attributes:

property multiZone

multiZone?: undefined | false | true;

property outputFile

outputFile?: undefined | string;

property sortedBy

sortedBy?: undefined | string;

property storageType

storageType?: undefined | string;

property zoneId

zoneId?: undefined | string;

interface GetInstanceEnginesArgs

interface GetInstanceEnginesArgs

A collection of arguments for invoking getInstanceEngines.

property engine

engine?: undefined | string;

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

property engineVersion

engineVersion?: undefined | string;

Database version required by the user. Value options can refer to the latest docs detail info EngineVersion.

property instanceChargeType

instanceChargeType?: undefined | string;

Filter the results by charge type. Valid values: PrePaid and PostPaid. Default to PostPaid.

property multiZone

multiZone?: undefined | false | true;

Whether to show multi available zone. Default false to not show multi availability zone.

property outputFile

outputFile?: undefined | string;

property zoneId

zoneId?: undefined | string;

The Zone to launch the DB instance.

interface GetInstanceEnginesResult

interface GetInstanceEnginesResult

A collection of values returned by getInstanceEngines.

property engine

engine?: undefined | string;

Database type.

property engineVersion

engineVersion?: undefined | string;

DB Instance version.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property instanceChargeType

instanceChargeType?: undefined | string;

property instanceEngines

instanceEngines: GetInstanceEnginesInstanceEngine[];

A list of Rds available resource. Each element contains the following attributes:

property multiZone

multiZone?: undefined | false | true;

property outputFile

outputFile?: undefined | string;

property zoneId

zoneId?: undefined | string;

interface GetInstancesArgs

interface GetInstancesArgs

A collection of arguments for invoking getInstances.

property connectionMode

connectionMode?: undefined | string;

Standard for standard access mode and Safe for high security access mode.

property dbType

dbType?: undefined | string;

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

property engine

engine?: undefined | string;

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

property ids

ids?: string[];

A list of RDS instance IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter results by instance name.

property outputFile

outputFile?: undefined | string;

property status

status?: undefined | string;

Status of the instance.

property tags

tags?: undefined | {[key: string]: any};

A map of tags assigned to the DB instances. Note: Before 1.60.0, the value’s format is a json string which including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example "{\"key1\":\"value1\"}"

property vpcId

vpcId?: undefined | string;

Used to retrieve instances belong to specified VPC.

property vswitchId

vswitchId?: undefined | string;

Used to retrieve instances belong to specified vswitch resources.

interface GetInstancesResult

interface GetInstancesResult

A collection of values returned by getInstances.

property connectionMode

connectionMode?: undefined | string;

Standard for standard access mode and Safe for high security access mode.

property dbType

dbType?: undefined | string;

Primary for primary instance, Readonly for read-only instance, Guard for disaster recovery instance, and Temp for temporary instance.

property engine

engine?: undefined | string;

Database type. Options are MySQL, SQLServer, PostgreSQL and PPAS. If no value is specified, all types are returned.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of RDS instance IDs.

property instances

instances: GetInstancesInstance[];

A list of RDS instances. Each element contains the following attributes:

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of RDS instance names.

property outputFile

outputFile?: undefined | string;

property status

status?: undefined | string;

Status of the instance.

property tags

tags?: undefined | {[key: string]: any};

property vpcId

vpcId?: undefined | string;

ID of the VPC the instance belongs to.

property vswitchId

vswitchId?: undefined | string;

ID of the VSwitch the instance belongs to.

interface GetZonesArgs

interface GetZonesArgs

A collection of arguments for invoking getZones.

property instanceChargeType

instanceChargeType?: undefined | string;

Filter the results by a specific instance charge type. Valid values: PrePaid and PostPaid. Default to PostPaid.

property multi

multi?: undefined | false | true;

Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch RDS instances.

property outputFile

outputFile?: undefined | string;

interface GetZonesResult

interface GetZonesResult

A collection of values returned by getZones.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of zone IDs.

property instanceChargeType

instanceChargeType?: undefined | string;

property multi

multi?: undefined | false | true;

property outputFile

outputFile?: undefined | string;

property zones

zones: GetZonesZone[];

A list of availability zones. Each element contains the following attributes:

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property autoRenew

autoRenew?: pulumi.Input<boolean>;

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

property autoRenewPeriod

autoRenewPeriod?: pulumi.Input<number>;

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

property autoUpgradeMinorVersion

autoUpgradeMinorVersion?: pulumi.Input<string>;

property dbInstanceStorageType

dbInstanceStorageType?: pulumi.Input<string>;

property engine

engine: pulumi.Input<string>;

Database type. Value options: MySQL, SQLServer, PostgreSQL, and PPAS.

property engineVersion

engineVersion: pulumi.Input<string>;

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

property forceRestart

forceRestart?: pulumi.Input<boolean>;

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

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

Valid values are Prepaid, Postpaid, Default to Postpaid. Currently, the resource only supports PostPaid to PrePaid.

property instanceName

instanceName?: pulumi.Input<string>;

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

property instanceStorage

instanceStorage: pulumi.Input<number>;

property instanceType

instanceType: pulumi.Input<string>;

DB Instance type. For details, see Instance type table.

property maintainTime

maintainTime?: pulumi.Input<string>;

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

property monitoringPeriod

monitoringPeriod?: pulumi.Input<number>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<InstanceParameter>[]>;

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

property period

period?: pulumi.Input<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The ID of resource group which the DB instance belongs.

property securityGroupId

DEPRECATED Attribute security_group_id has been deprecated from 1.69.0 and use security_group_ids instead.

securityGroupId?: pulumi.Input<string>;

It has been deprecated from 1.69.0 and use securityGroupIds instead.

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

, Available in 1.69.0+) The list IDs to join ECS Security Group. At most supports three security groups.

property securityIpMode

securityIpMode?: pulumi.Input<string>;

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

property securityIps

securityIps?: pulumi.Input<pulumi.Input<string>[]>;

property sqlCollectorConfigValue

sqlCollectorConfigValue?: pulumi.Input<number>;

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

property sqlCollectorStatus

sqlCollectorStatus?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

property vswitchId

vswitchId?: pulumi.Input<string>;

The virtual switch ID to launch DB instances in one VPC.

property zoneId

zoneId?: pulumi.Input<string>;

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property autoRenew

autoRenew?: pulumi.Input<boolean>;

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

property autoRenewPeriod

autoRenewPeriod?: pulumi.Input<number>;

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

property autoUpgradeMinorVersion

autoUpgradeMinorVersion?: pulumi.Input<string>;

property connectionString

connectionString?: pulumi.Input<string>;

RDS database connection string.

property dbInstanceStorageType

dbInstanceStorageType?: pulumi.Input<string>;

property engine

engine?: pulumi.Input<string>;

Database type. Value options: MySQL, SQLServer, PostgreSQL, and PPAS.

property engineVersion

engineVersion?: pulumi.Input<string>;

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

property forceRestart

forceRestart?: pulumi.Input<boolean>;

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

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

Valid values are Prepaid, Postpaid, Default to Postpaid. Currently, the resource only supports PostPaid to PrePaid.

property instanceName

instanceName?: pulumi.Input<string>;

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

property instanceStorage

instanceStorage?: pulumi.Input<number>;

property instanceType

instanceType?: pulumi.Input<string>;

DB Instance type. For details, see Instance type table.

property maintainTime

maintainTime?: pulumi.Input<string>;

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

property monitoringPeriod

monitoringPeriod?: pulumi.Input<number>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<InstanceParameter>[]>;

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

property period

period?: pulumi.Input<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.

property port

port?: pulumi.Input<string>;

RDS database connection port.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The ID of resource group which the DB instance belongs.

property securityGroupId

DEPRECATED Attribute security_group_id has been deprecated from 1.69.0 and use security_group_ids instead.

securityGroupId?: pulumi.Input<string>;

It has been deprecated from 1.69.0 and use securityGroupIds instead.

property securityGroupIds

securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

, Available in 1.69.0+) The list IDs to join ECS Security Group. At most supports three security groups.

property securityIpMode

securityIpMode?: pulumi.Input<string>;

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

property securityIps

securityIps?: pulumi.Input<pulumi.Input<string>[]>;

property sqlCollectorConfigValue

sqlCollectorConfigValue?: pulumi.Input<number>;

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

property sqlCollectorStatus

sqlCollectorStatus?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

property vswitchId

vswitchId?: pulumi.Input<string>;

The virtual switch ID to launch DB instances in one VPC.

property zoneId

zoneId?: pulumi.Input<string>;

interface ReadOnlyInstanceArgs

interface ReadOnlyInstanceArgs

The set of arguments for constructing a ReadOnlyInstance resource.

property engineVersion

engineVersion: pulumi.Input<string>;

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

property instanceName

instanceName?: pulumi.Input<string>;

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

property instanceStorage

instanceStorage: pulumi.Input<number>;

User-defined DB instance storage space. Value range: [5, 2000] for MySQL/SQL Server HA dual node edition. Increase progressively at a rate of 5 GB. For details, see Instance type table.

property instanceType

instanceType: pulumi.Input<string>;

DB Instance type. For details, see Instance type table.

property masterDbInstanceId

masterDbInstanceId: pulumi.Input<string>;

ID of the master instance.

property parameters

parameters?: pulumi.Input<pulumi.Input<ReadOnlyInstanceParameter>[]>;

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

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The ID of resource group which the DB read-only instance belongs.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

property vswitchId

vswitchId?: pulumi.Input<string>;

The virtual switch ID to launch DB instances in one VPC.

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the DB instance.

interface ReadOnlyInstanceState

interface ReadOnlyInstanceState

Input properties used for looking up and filtering ReadOnlyInstance resources.

property connectionString

connectionString?: pulumi.Input<string>;

RDS database connection string.

property engine

engine?: pulumi.Input<string>;

Database type.

property engineVersion

engineVersion?: pulumi.Input<string>;

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

property instanceName

instanceName?: pulumi.Input<string>;

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

property instanceStorage

instanceStorage?: pulumi.Input<number>;

User-defined DB instance storage space. Value range: [5, 2000] for MySQL/SQL Server HA dual node edition. Increase progressively at a rate of 5 GB. For details, see Instance type table.

property instanceType

instanceType?: pulumi.Input<string>;

DB Instance type. For details, see Instance type table.

property masterDbInstanceId

masterDbInstanceId?: pulumi.Input<string>;

ID of the master instance.

property parameters

parameters?: pulumi.Input<pulumi.Input<ReadOnlyInstanceParameter>[]>;

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

property port

port?: pulumi.Input<string>;

RDS database connection port.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The ID of resource group which the DB read-only instance belongs.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

property vswitchId

vswitchId?: pulumi.Input<string>;

The virtual switch ID to launch DB instances in one VPC.

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the DB instance.

interface ReadWriteSplittingConnectionArgs

interface ReadWriteSplittingConnectionArgs

The set of arguments for constructing a ReadWriteSplittingConnection resource.

property connectionPrefix

connectionPrefix?: pulumi.Input<string>;

property distributionType

distributionType: pulumi.Input<string>;

Read weight distribution mode. Values are as follows: Standard indicates automatic weight distribution based on types, Custom indicates custom weight distribution.

property instanceId

instanceId: pulumi.Input<string>;

The Id of instance that can run database.

property maxDelayTime

maxDelayTime?: pulumi.Input<number>;

Delay threshold, in seconds. The value range is 0 to 7200. Default to 30. Read requests are not routed to the read-only instances with a delay greater than the threshold.

property port

port?: pulumi.Input<number>;

Intranet connection port. Valid value: [3001-3999]. Default to 3306.

property weight

weight?: pulumi.Input<{[key: string]: any}>;

interface ReadWriteSplittingConnectionState

interface ReadWriteSplittingConnectionState

Input properties used for looking up and filtering ReadWriteSplittingConnection resources.

property connectionPrefix

connectionPrefix?: pulumi.Input<string>;

property connectionString

connectionString?: pulumi.Input<string>;

Connection instance string.

property distributionType

distributionType?: pulumi.Input<string>;

Read weight distribution mode. Values are as follows: Standard indicates automatic weight distribution based on types, Custom indicates custom weight distribution.

property instanceId

instanceId?: pulumi.Input<string>;

The Id of instance that can run database.

property maxDelayTime

maxDelayTime?: pulumi.Input<number>;

Delay threshold, in seconds. The value range is 0 to 7200. Default to 30. Read requests are not routed to the read-only instances with a delay greater than the threshold.

property port

port?: pulumi.Input<number>;

Intranet connection port. Valid value: [3001-3999]. Default to 3306.

property weight

weight?: pulumi.Input<{[key: string]: any}>;

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module rds

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Create a RDS MySQL instance

Create a RDS MySQL instance with specific parameters

Example Usage

Example Usage