Module polardb

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

getAccounts
getClusters
getDatabases
getEndpoints
getNodeClasses
getZones

Others

Resources

Resource Account

class Account extends CustomResource

Provides a PolarDB account resource and used to manage databases.

NOTE: Available in v1.67.0+.

Example Usage

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

const config = new pulumi.Config();
const creation = config.get("creation") || "PolarDB";
const name = config.get("name") || "polardbaccountmysql";

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 cluster = new alicloud.polardb.Cluster("cluster", {
    dbNodeClass: "polar.mysql.x4.large",
    dbType: "MySQL",
    dbVersion: "8.0",
    description: name,
    payType: "PostPaid",
    vswitchId: defaultSwitch.id,
});
const account = new alicloud.rds.Account("account", {
    accountDescription: name,
    accountName: "tftestnormal",
    accountPassword: "Test12345",
    dbClusterId: alicloud_db_instance_cluster.id,
});

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 accountDescription

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

Account 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 accountName

public accountName: 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 accountPassword

public accountPassword: pulumi.Output<string>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

property accountType

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

Account type, Valid values are Normal, Super, Default to Normal.

property dbClusterId

public dbClusterId: pulumi.Output<string>;

The Id of cluster in which account belongs.

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 kmsEncryptedPassword

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

An KMS encrypts password used to a db account. If the accountPassword 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 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 accountPrivilege

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

The privilege of one account access database. Valid values: [“ReadOnly”, “ReadWrite”]. Default to “ReadOnly”.

property dbClusterId

public dbClusterId: pulumi.Output<string>;

The Id of cluster in which account belongs.

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 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

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 backupRetentionPeriod

public backupRetentionPeriod: pulumi.Output<string>;

Cluster backup retention days, Fixed for 7 days, not modified.

property dbClusterId

public dbClusterId: pulumi.Output<string>;

The Id of cluster that can run database.

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 preferredBackupPeriods

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

PolarDB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [“Tuesday”, “Thursday”, “Saturday”].

property preferredBackupTime

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

PolarDB Cluster 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 urn

urn: Output<URN>;

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

Resource Cluster

class Cluster extends CustomResource

Provides a PolarDB cluster resource. A PolarDB cluster is an isolated database environment in the cloud. A PolarDB cluster can contain multiple user-created databases.

NOTE: Available in v1.66.0+.

Example Usage

Create a PolarDB MySQL cluster

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

const config = new pulumi.Config();
const name = config.get("name") || "polardbClusterconfig";
const creation = config.get("creation") || "PolarDB";

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 defaultCluster = new alicloud.polardb.Cluster("default", {
    dbNodeClass: "rds.mysql.s2.large",
    dbType: "MySQL",
    dbVersion: "5.6",
    description: name,
    payType: "PostPaid",
    vswitchId: defaultSwitch.id,
});

constructor

new Cluster(name: string, args: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster 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?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster

Get an existing Cluster 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 Cluster

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

property autoRenewPeriod

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

Auto-renewal period of an cluster, in the unit of the month. It is valid when payType is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

property connectionString

public connectionString: pulumi.Output<string>;

(Available in 1.81.0+) PolarDB cluster connection string. When securityIps is configured, the address of cluster type endpoint will be returned, and if only “127.0.0.1” is configured, it will also be an empty string.

property dbNodeClass

public dbNodeClass: pulumi.Output<string>;

The dbNodeClass of cluster node.

property dbType

public dbType: pulumi.Output<string>;

Database type. Value options: MySQL, Oracle, PostgreSQL.

property dbVersion

public dbVersion: pulumi.Output<string>;

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

property description

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

The description of cluster.

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 maintainTime

public maintainTime: pulumi.Output<string>;

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

property modifyType

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

Use as dbNodeClass change class , define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

property parameters

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

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

property payType

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

Valid values are PrePaid, PostPaid, Default to PostPaid. Currently, the resource can not supports change pay type.

property period

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

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

property renewalStatus

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

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

property securityIps

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

List of IP addresses allowed to access all databases of an cluster. 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 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 cluster. it supports multiple zone.

Resource Database

class Database extends CustomResource

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

NOTE: Available in v1.66.0+.

Example Usage

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

const cluster = new alicloud.polardb.Cluster("cluster", {
    dbNodeClass: var_clusterclass,
    dbType: "MySQL",
    dbVersion: "8.0",
    description: "testDB",
    payType: "PostPaid",
    vswitchId: "polar.mysql.x4.large",
});
const defaultDatabase = new alicloud.polardb.Database("default", {
    dbClusterId: cluster.id,
    dbName: "tftestdatabase",
});

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 characterSetName

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

Character set. The value range is limited to the following: [ utf8, gbk, latin1, utf8mb4, Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, Chinese_PRC_BIN ], default is “utf8” (utf8mb4 only supports versions 5.5 and 5.6).

property dbClusterId

public dbClusterId: pulumi.Output<string>;

The Id of cluster that can run database.

property dbDescription

public dbDescription: 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 dbName

public dbName: 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 letterand have no more than 64 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 urn

urn: Output<URN>;

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

Resource Endpoint

class Endpoint extends CustomResource

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

NOTE: Available in v1.80.0+. Each PolarDB instance will allocate a intranet connection string automatically and its prefix is Cluster 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") || "PolarDB";
const name = config.get("name") || "polardbconnectionbasic";

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 defaultCluster = new alicloud.polardb.Cluster("default", {
    dbNodeClass: "polar.mysql.x4.large",
    dbType: "MySQL",
    dbVersion: "8.0",
    description: name,
    payType: "PostPaid",
    vswitchId: defaultSwitch.id,
});
const endpoint = new alicloud.PolardbEndpoints("endpoint", {
    dbClusterId: defaultCluster.id,
    endpointType: "Custom",
});

constructor

new Endpoint(name: string, args: EndpointArgs, opts?: pulumi.CustomResourceOptions)

Create a Endpoint 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?: EndpointState, opts?: pulumi.CustomResourceOptions): Endpoint

Get an existing Endpoint 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 Endpoint

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

property autoAddNewNodes

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

Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.

property dbClusterId

public dbClusterId: pulumi.Output<string>;

The Id of cluster that can run database.

property endpointConfig

public endpointConfig: pulumi.Output<{[key: string]: any}>;

Advanced configuration of the cluster address.

property endpointType

public endpointType: pulumi.Output<string>;

Type of endpoint. Valid value: Custom. Currently supported only Custom.

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 nodes

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

Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.

property readWriteMode

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

Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

property urn

urn: Output<URN>;

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

Resource EndpointAddress

class EndpointAddress extends CustomResource

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

NOTE: Available in v1.68.0+. Each PolarDB instance will allocate a intranet connection string automatically and its prefix is Cluster 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") || "PolarDB";
const name = config.get("name") || "polardbconnectionbasic";
const defaultZones = alicloud.getZones({
    availableResourceCreation: creation,
});
const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {cidrBlock: "172.16.0.0/16"});
const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
    vpcId: defaultNetwork.id,
    cidrBlock: "172.16.0.0/24",
    availabilityZone: defaultZones.then(defaultZones => defaultZones.zones[0].id),
});
const defaultCluster = new alicloud.polardb.Cluster("defaultCluster", {
    dbType: "MySQL",
    dbVersion: "8.0",
    payType: "PostPaid",
    dbNodeClass: "polar.mysql.x4.large",
    vswitchId: defaultSwitch.id,
    description: name,
});
const defaultEndpoints = defaultCluster.id.apply(id => alicloud.polardb.getEndpoints({
    dbClusterId: id,
}));
const endpoint = new alicloud.polardb.EndpointAddress("endpoint", {
    dbClusterId: defaultCluster.id,
    dbEndpointId: defaultEndpoints.endpoints[0].dbEndpointId,
    connectionPrefix: "testpolardbconn",
    netType: "Public",
});

constructor

new EndpointAddress(name: string, args: EndpointAddressArgs, opts?: pulumi.CustomResourceOptions)

Create a EndpointAddress 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?: EndpointAddressState, opts?: pulumi.CustomResourceOptions): EndpointAddress

Get an existing EndpointAddress 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 EndpointAddress

Returns true if the given object is an instance of EndpointAddress. 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 cluster or endpoint string.

property dbClusterId

public dbClusterId: pulumi.Output<string>;

The Id of cluster that can run database.

property dbEndpointId

public dbEndpointId: pulumi.Output<string>;

The Id of endpoint that can run database.

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 ipAddress

public ipAddress: pulumi.Output<string>;

The ip address of connection string.

property netType

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

Internet connection net type. Valid value: Public. Default to Public. Currently supported only Public.

property port

public port: pulumi.Output<string>;

Connection cluster or endpoint port.

property urn

urn: Output<URN>;

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

Functions

Function getAccounts

getAccounts(args: GetAccountsArgs, opts?: pulumi.InvokeOptions): Promise<GetAccountsResult>

The alicloud.polardb.getAccounts data source provides a collection of PolarDB cluster database account available in Alibaba Cloud account. Filters support regular expression for the account name, searches by clusterId.

NOTE: Available in v1.70.0+.

Example Usage

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

const polardbClustersDs = alicloud.polardb.getClusters({
    descriptionRegex: "pc-\\w+",
    status: "Running",
});
const default = polardbClustersDs.then(polardbClustersDs => alicloud.polardb.getAccounts({
    dbClusterId: polardbClustersDs.clusters[0].id,
}));
export const ends = _default.then(_default => _default.accounts[0].accountName);

Function getClusters

getClusters(args?: GetClustersArgs, opts?: pulumi.InvokeOptions): Promise<GetClustersResult>

The alicloud.polardb.getClusters data source provides a collection of PolarDB clusters available in Alibaba Cloud account. Filters support regular expression for the cluster description, searches by tags, and other filters which are listed below.

NOTE: Available in v1.66.0+.

Example Usage

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

const polardbClustersDs = pulumi.output(alicloud.polardb.getClusters({
    descriptionRegex: "pc-\\w+",
    status: "Running",
}, { async: true }));

export const firstPolardbClusterId = polardbClustersDs.clusters[0].id;

Function getDatabases

getDatabases(args: GetDatabasesArgs, opts?: pulumi.InvokeOptions): Promise<GetDatabasesResult>

The alicloud.polardb.getDatabases data source provides a collection of PolarDB cluster database available in Alibaba Cloud account. Filters support regular expression for the database name, searches by clusterId.

NOTE: Available in v1.70.0+.

Example Usage

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

const polardbClustersDs = alicloud.polardb.getClusters({
    descriptionRegex: "pc-\\w+",
    status: "Running",
});
const default = polardbClustersDs.then(polardbClustersDs => alicloud.polardb.getDatabases({
    dbClusterId: polardbClustersDs.clusters[0].id,
}));
export const ends = _default.then(_default => _default.databases[0].dbName);

Function getEndpoints

getEndpoints(args: GetEndpointsArgs, opts?: pulumi.InvokeOptions): Promise<GetEndpointsResult>

The alicloud.polardb.getEndpoints data source provides a collection of PolarDB endpoints available in Alibaba Cloud account. Filters support regular expression for the cluster name, searches by clusterId, and other filters which are listed below.

NOTE: Available in v1.68.0+.

Example Usage

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

const polardbClustersDs = alicloud.polardb.getClusters({
    descriptionRegex: "pc-\\w+",
    status: "Running",
});
const default = polardbClustersDs.then(polardbClustersDs => alicloud.polardb.getEndpoints({
    dbClusterId: polardbClustersDs.clusters[0].id,
}));
export const ends = _default.then(_default => _default.endpoints[0].dbEndpointId);

Function getNodeClasses

getNodeClasses(args: GetNodeClassesArgs, opts?: pulumi.InvokeOptions): Promise<GetNodeClassesResult>

This data source provides the PolarDB node classes resource available info of Alibaba Cloud.

NOTE: Available in v1.81.0+

Example Usage

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

const resourcesZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "PolarDB",
}, { async: true }));
const resourcesNodeClasses = resourcesZones.apply(resourcesZones => alicloud.polardb.getNodeClasses({
    dbType: "MySQL",
    dbVersion: "5.6",
    payType: "Postpaid",
    zoneId: resourcesZones.zones[0].id,
}, { async: true }));

export const firstPolardbNodeClass = resourcesNodeClasses.classes;

Function getZones

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

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

NOTE: Available in v1.74.0+.

Example Usage

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

// Declare the data source
const zonesIds = pulumi.output(alicloud.polardb.getZones({ async: true }));

Others

interface AccountArgs

interface AccountArgs

The set of arguments for constructing a Account resource.

property accountDescription

accountDescription?: pulumi.Input<string>;

property accountName

accountName: 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 accountPassword

accountPassword: pulumi.Input<string>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

property accountType

accountType?: pulumi.Input<string>;

Account type, Valid values are Normal, Super, Default to Normal.

property dbClusterId

dbClusterId: pulumi.Input<string>;

The Id of cluster in which account belongs.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

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

property kmsEncryptionContext

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

interface AccountPrivilegeArgs

interface AccountPrivilegeArgs

The set of arguments for constructing a AccountPrivilege resource.

property accountName

accountName: pulumi.Input<string>;

A specified account name.

property accountPrivilege

accountPrivilege?: pulumi.Input<string>;

The privilege of one account access database. Valid values: [“ReadOnly”, “ReadWrite”]. Default to “ReadOnly”.

property dbClusterId

dbClusterId: pulumi.Input<string>;

The Id of cluster in which account belongs.

property dbNames

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

List of specified database name.

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 accountPrivilege

accountPrivilege?: pulumi.Input<string>;

The privilege of one account access database. Valid values: [“ReadOnly”, “ReadWrite”]. Default to “ReadOnly”.

property dbClusterId

dbClusterId?: pulumi.Input<string>;

The Id of cluster in which account belongs.

property dbNames

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

List of specified database name.

interface AccountState

interface AccountState

Input properties used for looking up and filtering Account resources.

property accountDescription

accountDescription?: pulumi.Input<string>;

property accountName

accountName?: 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 accountPassword

accountPassword?: pulumi.Input<string>;

Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.

property accountType

accountType?: pulumi.Input<string>;

Account type, Valid values are Normal, Super, Default to Normal.

property dbClusterId

dbClusterId?: pulumi.Input<string>;

The Id of cluster in which account belongs.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

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

property kmsEncryptionContext

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

interface BackupPolicyArgs

interface BackupPolicyArgs

The set of arguments for constructing a BackupPolicy resource.

property dbClusterId

dbClusterId: pulumi.Input<string>;

The Id of cluster that can run database.

property preferredBackupPeriods

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

PolarDB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [“Tuesday”, “Thursday”, “Saturday”].

property preferredBackupTime

preferredBackupTime?: pulumi.Input<string>;

PolarDB Cluster 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.

interface BackupPolicyState

interface BackupPolicyState

Input properties used for looking up and filtering BackupPolicy resources.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<string>;

Cluster backup retention days, Fixed for 7 days, not modified.

property dbClusterId

dbClusterId?: pulumi.Input<string>;

The Id of cluster that can run database.

property preferredBackupPeriods

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

PolarDB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [“Tuesday”, “Thursday”, “Saturday”].

property preferredBackupTime

preferredBackupTime?: pulumi.Input<string>;

PolarDB Cluster 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.

interface ClusterArgs

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property autoRenewPeriod

autoRenewPeriod?: pulumi.Input<number>;

Auto-renewal period of an cluster, in the unit of the month. It is valid when payType is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

property dbNodeClass

dbNodeClass: pulumi.Input<string>;

The dbNodeClass of cluster node.

property dbType

dbType: pulumi.Input<string>;

Database type. Value options: MySQL, Oracle, PostgreSQL.

property dbVersion

dbVersion: pulumi.Input<string>;

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

property description

description?: pulumi.Input<string>;

The description of cluster.

property maintainTime

maintainTime?: pulumi.Input<string>;

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

property modifyType

modifyType?: pulumi.Input<string>;

Use as dbNodeClass change class , define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

property parameters

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

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

property payType

payType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid, Default to PostPaid. Currently, the resource can not supports change pay type.

property period

period?: pulumi.Input<number>;

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

property renewalStatus

renewalStatus?: pulumi.Input<string>;

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

property securityIps

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

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 cluster. it supports multiple zone.

interface ClusterState

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property autoRenewPeriod

autoRenewPeriod?: pulumi.Input<number>;

Auto-renewal period of an cluster, in the unit of the month. It is valid when payType is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

property connectionString

connectionString?: pulumi.Input<string>;

property dbNodeClass

dbNodeClass?: pulumi.Input<string>;

The dbNodeClass of cluster node.

property dbType

dbType?: pulumi.Input<string>;

Database type. Value options: MySQL, Oracle, PostgreSQL.

property dbVersion

dbVersion?: pulumi.Input<string>;

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

property description

description?: pulumi.Input<string>;

The description of cluster.

property maintainTime

maintainTime?: pulumi.Input<string>;

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

property modifyType

modifyType?: pulumi.Input<string>;

Use as dbNodeClass change class , define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

property parameters

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

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

property payType

payType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid, Default to PostPaid. Currently, the resource can not supports change pay type.

property period

period?: pulumi.Input<number>;

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

property renewalStatus

renewalStatus?: pulumi.Input<string>;

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

property securityIps

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

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 cluster. it supports multiple zone.

interface DatabaseArgs

interface DatabaseArgs

The set of arguments for constructing a Database resource.

property characterSetName

characterSetName?: pulumi.Input<string>;

property dbClusterId

dbClusterId: pulumi.Input<string>;

The Id of cluster that can run database.

property dbDescription

dbDescription?: pulumi.Input<string>;

property dbName

dbName: 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 letterand have no more than 64 characters.

interface DatabaseState

interface DatabaseState

Input properties used for looking up and filtering Database resources.

property characterSetName

characterSetName?: pulumi.Input<string>;

property dbClusterId

dbClusterId?: pulumi.Input<string>;

The Id of cluster that can run database.

property dbDescription

dbDescription?: pulumi.Input<string>;

property dbName

dbName?: 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 letterand have no more than 64 characters.

interface EndpointAddressArgs

interface EndpointAddressArgs

The set of arguments for constructing a EndpointAddress resource.

property connectionPrefix

connectionPrefix?: pulumi.Input<string>;

property dbClusterId

dbClusterId: pulumi.Input<string>;

The Id of cluster that can run database.

property dbEndpointId

dbEndpointId: pulumi.Input<string>;

The Id of endpoint that can run database.

property netType

netType?: pulumi.Input<string>;

Internet connection net type. Valid value: Public. Default to Public. Currently supported only Public.

interface EndpointAddressState

interface EndpointAddressState

Input properties used for looking up and filtering EndpointAddress resources.

property connectionPrefix

connectionPrefix?: pulumi.Input<string>;

property connectionString

connectionString?: pulumi.Input<string>;

Connection cluster or endpoint string.

property dbClusterId

dbClusterId?: pulumi.Input<string>;

The Id of cluster that can run database.

property dbEndpointId

dbEndpointId?: pulumi.Input<string>;

The Id of endpoint that can run database.

property ipAddress

ipAddress?: pulumi.Input<string>;

The ip address of connection string.

property netType

netType?: pulumi.Input<string>;

Internet connection net type. Valid value: Public. Default to Public. Currently supported only Public.

property port

port?: pulumi.Input<string>;

Connection cluster or endpoint port.

interface EndpointArgs

interface EndpointArgs

The set of arguments for constructing a Endpoint resource.

property autoAddNewNodes

autoAddNewNodes?: pulumi.Input<string>;

Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.

property dbClusterId

dbClusterId: pulumi.Input<string>;

The Id of cluster that can run database.

property endpointConfig

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

Advanced configuration of the cluster address.

property endpointType

endpointType: pulumi.Input<string>;

Type of endpoint. Valid value: Custom. Currently supported only Custom.

property nodes

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

Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.

property readWriteMode

readWriteMode?: pulumi.Input<string>;

Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

interface EndpointState

interface EndpointState

Input properties used for looking up and filtering Endpoint resources.

property autoAddNewNodes

autoAddNewNodes?: pulumi.Input<string>;

Whether the new node automatically joins the default cluster address. Valid values are Enable, Disable. Default to Disable.

property dbClusterId

dbClusterId?: pulumi.Input<string>;

The Id of cluster that can run database.

property endpointConfig

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

Advanced configuration of the cluster address.

property endpointType

endpointType?: pulumi.Input<string>;

Type of endpoint. Valid value: Custom. Currently supported only Custom.

property nodes

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

Node id list for endpoint configuration. At least 2 nodes if specified, or if the cluster has more than 3 nodes, read-only endpoint is allowed to mount only one node. Default is all nodes.

property readWriteMode

readWriteMode?: pulumi.Input<string>;

Read or write mode. Valid values are ReadWrite, ReadOnly. Default to ReadOnly.

interface GetAccountsArgs

interface GetAccountsArgs

A collection of arguments for invoking getAccounts.

property dbClusterId

dbClusterId: string;

The polarDB cluster ID.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter results by account name.

interface GetAccountsResult

interface GetAccountsResult

A collection of values returned by getAccounts.

property accounts

accounts: GetAccountsAccount[];

A list of PolarDB cluster accounts. Each element contains the following attributes:

property dbClusterId

dbClusterId: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

Account name of the cluster.

interface GetClustersArgs

interface GetClustersArgs

A collection of arguments for invoking getClusters.

property dbType

dbType?: undefined | string;

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

property descriptionRegex

descriptionRegex?: undefined | string;

A regex string to filter results by cluster description.

property ids

ids?: string[];

A list of PolarDB cluster IDs.

property outputFile

outputFile?: undefined | string;

property status

status?: undefined | string;

status of the cluster.

property tags

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

interface GetClustersResult

interface GetClustersResult

A collection of values returned by getClusters.

property clusters

clusters: GetClustersCluster[];

A list of PolarDB clusters. Each element contains the following attributes:

property dbType

dbType?: undefined | string;

Primary for primary cluster, ReadOnly for read-only cluster, Guard for disaster recovery cluster, and Temp for temporary cluster.

property descriptionRegex

descriptionRegex?: undefined | string;

property descriptions

descriptions: string[];

A list of RDS cluster descriptions.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of RDS cluster IDs.

property outputFile

outputFile?: undefined | string;

property status

status?: undefined | string;

Status of the cluster.

property tags

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

interface GetDatabasesArgs

interface GetDatabasesArgs

A collection of arguments for invoking getDatabases.

property dbClusterId

dbClusterId: string;

The polarDB cluster ID.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter results by database name.

interface GetDatabasesResult

interface GetDatabasesResult

A collection of values returned by getDatabases.

property databases

databases: GetDatabasesDatabase[];

A list of PolarDB cluster databases. Each element contains the following attributes:

property dbClusterId

dbClusterId: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

database name of the cluster.

interface GetEndpointsArgs

interface GetEndpointsArgs

A collection of arguments for invoking getEndpoints.

property dbClusterId

dbClusterId: string;

PolarDB cluster ID.

property dbEndpointId

dbEndpointId?: undefined | string;

endpoint of the cluster.

interface GetEndpointsResult

interface GetEndpointsResult

A collection of values returned by getEndpoints.

property dbClusterId

dbClusterId: string;

property dbEndpointId

dbEndpointId?: undefined | string;

The endpoint ID.

property endpoints

endpoints: GetEndpointsEndpoint[];

A list of PolarDB cluster endpoints. Each element contains the following attributes:

property id

id: string;

The provider-assigned unique ID for this managed resource.

interface GetNodeClassesArgs

interface GetNodeClassesArgs

A collection of arguments for invoking getNodeClasses.

property dbNodeClass

dbNodeClass?: undefined | string;

The PolarDB node class type by the user.

property dbType

dbType?: undefined | string;

Database type. Options are MySQL, PostgreSQL, Oracle. If dbType is set, dbVersion also needs to be set.

property dbVersion

dbVersion?: undefined | string;

Database version required by the user. Value options can refer to the latest docs detail info DBVersion. If dbVersion is set, dbType also needs to be set.