polardb

package
v3.55.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 30, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {
	pulumi.CustomResourceState

	// 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.
	AccountDescription pulumi.StringPtrOutput `pulumi:"accountDescription"`
	// 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.
	AccountName pulumi.StringOutput `pulumi:"accountName"`
	// Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
	AccountPassword pulumi.StringOutput `pulumi:"accountPassword"`
	// Account type, Valid values are `Normal`, `Super`, Default to `Normal`.
	AccountType pulumi.StringPtrOutput `pulumi:"accountType"`
	// The Id of cluster in which account belongs.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// An KMS encrypts password used to a db account. If the `accountPassword` is filled in, this field will be ignored.
	KmsEncryptedPassword pulumi.StringPtrOutput `pulumi:"kmsEncryptedPassword"`
	// An KMS encryption context used to decrypt `kmsEncryptedPassword` before creating or updating a db account with `kmsEncryptedPassword`. See [Encryption Context](https://www.alibabacloud.com/help/doc-detail/42975.htm). It is valid when `kmsEncryptedPassword` is set.
	KmsEncryptionContext pulumi.MapOutput `pulumi:"kmsEncryptionContext"`
}

Provides a PolarDB account resource and used to manage databases.

> **NOTE:** Available since v1.67.0.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
			Category:  pulumi.StringRef("Normal"),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewAccount(ctx, "default", &polardb.AccountArgs{
			DbClusterId:        defaultCluster.ID(),
			AccountName:        pulumi.String("terraform_example"),
			AccountPassword:    pulumi.String("Example1234"),
			AccountDescription: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

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

```sh $ pulumi import alicloud:polardb/account:Account example "pc-12345:tf_account" ```

func GetAccount 

func GetAccount(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccountState, opts ...pulumi.ResourceOption) (*Account, error)

GetAccount gets an existing Account resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccount 

func NewAccount(ctx *pulumi.Context,
	name string, args *AccountArgs, opts ...pulumi.ResourceOption) (*Account, error)

NewAccount registers a new resource with the given unique name, arguments, and options.

func (*Account) ElementType 

func (*Account) ElementType() reflect.Type

func (*Account) ToAccountOutput 

func (i *Account) ToAccountOutput() AccountOutput

func (*Account) ToAccountOutputWithContext 

func (i *Account) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountArgs 

type AccountArgs struct {
	// 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.
	AccountDescription pulumi.StringPtrInput
	// 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.
	AccountName pulumi.StringInput
	// Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
	AccountPassword pulumi.StringInput
	// Account type, Valid values are `Normal`, `Super`, Default to `Normal`.
	AccountType pulumi.StringPtrInput
	// The Id of cluster in which account belongs.
	DbClusterId pulumi.StringInput
	// An KMS encrypts password used to a db account. If the `accountPassword` is filled in, this field will be ignored.
	KmsEncryptedPassword pulumi.StringPtrInput
	// An KMS encryption context used to decrypt `kmsEncryptedPassword` before creating or updating a db account with `kmsEncryptedPassword`. See [Encryption Context](https://www.alibabacloud.com/help/doc-detail/42975.htm). It is valid when `kmsEncryptedPassword` is set.
	KmsEncryptionContext pulumi.MapInput
}

The set of arguments for constructing a Account resource.

func (AccountArgs) ElementType 

func (AccountArgs) ElementType() reflect.Type

type AccountArray 

type AccountArray []AccountInput

func (AccountArray) ElementType 

func (AccountArray) ElementType() reflect.Type

func (AccountArray) ToAccountArrayOutput 

func (i AccountArray) ToAccountArrayOutput() AccountArrayOutput

func (AccountArray) ToAccountArrayOutputWithContext 

func (i AccountArray) ToAccountArrayOutputWithContext(ctx context.Context) AccountArrayOutput

type AccountArrayInput 

type AccountArrayInput interface {
	pulumi.Input

	ToAccountArrayOutput() AccountArrayOutput
	ToAccountArrayOutputWithContext(context.Context) AccountArrayOutput
}

AccountArrayInput is an input type that accepts AccountArray and AccountArrayOutput values. You can construct a concrete instance of `AccountArrayInput` via: 

AccountArray{ AccountArgs{...} }

type AccountArrayOutput 

type AccountArrayOutput struct{ *pulumi.OutputState }

func (AccountArrayOutput) ElementType 

func (AccountArrayOutput) ElementType() reflect.Type

func (AccountArrayOutput) Index 

func (o AccountArrayOutput) Index(i pulumi.IntInput) AccountOutput

func (AccountArrayOutput) ToAccountArrayOutput 

func (o AccountArrayOutput) ToAccountArrayOutput() AccountArrayOutput

func (AccountArrayOutput) ToAccountArrayOutputWithContext 

func (o AccountArrayOutput) ToAccountArrayOutputWithContext(ctx context.Context) AccountArrayOutput

type AccountInput 

type AccountInput interface {
	pulumi.Input

	ToAccountOutput() AccountOutput
	ToAccountOutputWithContext(ctx context.Context) AccountOutput
}

type AccountMap 

type AccountMap map[string]AccountInput

func (AccountMap) ElementType 

func (AccountMap) ElementType() reflect.Type

func (AccountMap) ToAccountMapOutput 

func (i AccountMap) ToAccountMapOutput() AccountMapOutput

func (AccountMap) ToAccountMapOutputWithContext 

func (i AccountMap) ToAccountMapOutputWithContext(ctx context.Context) AccountMapOutput

type AccountMapInput 

type AccountMapInput interface {
	pulumi.Input

	ToAccountMapOutput() AccountMapOutput
	ToAccountMapOutputWithContext(context.Context) AccountMapOutput
}

AccountMapInput is an input type that accepts AccountMap and AccountMapOutput values. You can construct a concrete instance of `AccountMapInput` via: 

AccountMap{ "key": AccountArgs{...} }

type AccountMapOutput 

type AccountMapOutput struct{ *pulumi.OutputState }

func (AccountMapOutput) ElementType 

func (AccountMapOutput) ElementType() reflect.Type

func (AccountMapOutput) MapIndex 

func (o AccountMapOutput) MapIndex(k pulumi.StringInput) AccountOutput

func (AccountMapOutput) ToAccountMapOutput 

func (o AccountMapOutput) ToAccountMapOutput() AccountMapOutput

func (AccountMapOutput) ToAccountMapOutputWithContext 

func (o AccountMapOutput) ToAccountMapOutputWithContext(ctx context.Context) AccountMapOutput

type AccountOutput 

type AccountOutput struct{ *pulumi.OutputState }

func (AccountOutput) AccountDescription added in v3.27.0 

func (o AccountOutput) AccountDescription() pulumi.StringPtrOutput

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.

func (AccountOutput) AccountName added in v3.27.0 

func (o AccountOutput) AccountName() pulumi.StringOutput

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.

func (AccountOutput) AccountPassword added in v3.27.0 

func (o AccountOutput) AccountPassword() pulumi.StringOutput

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

func (AccountOutput) AccountType added in v3.27.0 

func (o AccountOutput) AccountType() pulumi.StringPtrOutput

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

func (AccountOutput) DbClusterId added in v3.27.0 

func (o AccountOutput) DbClusterId() pulumi.StringOutput

The Id of cluster in which account belongs.

func (AccountOutput) ElementType 

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) KmsEncryptedPassword added in v3.27.0 

func (o AccountOutput) KmsEncryptedPassword() pulumi.StringPtrOutput

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

func (AccountOutput) KmsEncryptionContext added in v3.27.0 

func (o AccountOutput) KmsEncryptionContext() pulumi.MapOutput

An KMS encryption context used to decrypt `kmsEncryptedPassword` before creating or updating a db account with `kmsEncryptedPassword`. See [Encryption Context](https://www.alibabacloud.com/help/doc-detail/42975.htm). It is valid when `kmsEncryptedPassword` is set.

func (AccountOutput) ToAccountOutput 

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext 

func (o AccountOutput) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountPrivilege 

type AccountPrivilege struct {
	pulumi.CustomResourceState

	// A specified account name.
	AccountName pulumi.StringOutput `pulumi:"accountName"`
	// The privilege of one account access database. Valid values: ["ReadOnly", "ReadWrite"], ["DMLOnly", "DDLOnly"] added since version v1.101.0. Default to "ReadOnly".
	AccountPrivilege pulumi.StringPtrOutput `pulumi:"accountPrivilege"`
	// The Id of cluster in which account belongs.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// List of specified database name.
	DbNames pulumi.StringArrayOutput `pulumi:"dbNames"`
}

Provides a PolarDB account privilege resource and used to grant several database some access privilege. A database can be granted by multiple account.

> **NOTE:** Available in v1.67.0+.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultAccount, err := polardb.NewAccount(ctx, "default", &polardb.AccountArgs{
			DbClusterId:        defaultCluster.ID(),
			AccountName:        pulumi.String("terraform_example"),
			AccountPassword:    pulumi.String("Example1234"),
			AccountDescription: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultDatabase, err := polardb.NewDatabase(ctx, "default", &polardb.DatabaseArgs{
			DbClusterId: defaultCluster.ID(),
			DbName:      pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewAccountPrivilege(ctx, "default", &polardb.AccountPrivilegeArgs{
			DbClusterId:      defaultCluster.ID(),
			AccountName:      defaultAccount.AccountName,
			AccountPrivilege: pulumi.String("ReadOnly"),
			DbNames: pulumi.StringArray{
				defaultDatabase.DbName,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

PolarDB account privilege can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/accountPrivilege:AccountPrivilege example "pc-12345:tf_account:ReadOnly" ```

func GetAccountPrivilege 

func GetAccountPrivilege(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccountPrivilegeState, opts ...pulumi.ResourceOption) (*AccountPrivilege, error)

GetAccountPrivilege gets an existing AccountPrivilege resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccountPrivilege 

func NewAccountPrivilege(ctx *pulumi.Context,
	name string, args *AccountPrivilegeArgs, opts ...pulumi.ResourceOption) (*AccountPrivilege, error)

NewAccountPrivilege registers a new resource with the given unique name, arguments, and options.

func (*AccountPrivilege) ElementType 

func (*AccountPrivilege) ElementType() reflect.Type

func (*AccountPrivilege) ToAccountPrivilegeOutput 

func (i *AccountPrivilege) ToAccountPrivilegeOutput() AccountPrivilegeOutput

func (*AccountPrivilege) ToAccountPrivilegeOutputWithContext 

func (i *AccountPrivilege) ToAccountPrivilegeOutputWithContext(ctx context.Context) AccountPrivilegeOutput

type AccountPrivilegeArgs 

type AccountPrivilegeArgs struct {
	// A specified account name.
	AccountName pulumi.StringInput
	// The privilege of one account access database. Valid values: ["ReadOnly", "ReadWrite"], ["DMLOnly", "DDLOnly"] added since version v1.101.0. Default to "ReadOnly".
	AccountPrivilege pulumi.StringPtrInput
	// The Id of cluster in which account belongs.
	DbClusterId pulumi.StringInput
	// List of specified database name.
	DbNames pulumi.StringArrayInput
}

The set of arguments for constructing a AccountPrivilege resource.

func (AccountPrivilegeArgs) ElementType 

func (AccountPrivilegeArgs) ElementType() reflect.Type

type AccountPrivilegeArray 

type AccountPrivilegeArray []AccountPrivilegeInput

func (AccountPrivilegeArray) ElementType 

func (AccountPrivilegeArray) ElementType() reflect.Type

func (AccountPrivilegeArray) ToAccountPrivilegeArrayOutput 

func (i AccountPrivilegeArray) ToAccountPrivilegeArrayOutput() AccountPrivilegeArrayOutput

func (AccountPrivilegeArray) ToAccountPrivilegeArrayOutputWithContext 

func (i AccountPrivilegeArray) ToAccountPrivilegeArrayOutputWithContext(ctx context.Context) AccountPrivilegeArrayOutput

type AccountPrivilegeArrayInput 

type AccountPrivilegeArrayInput interface {
	pulumi.Input

	ToAccountPrivilegeArrayOutput() AccountPrivilegeArrayOutput
	ToAccountPrivilegeArrayOutputWithContext(context.Context) AccountPrivilegeArrayOutput
}

AccountPrivilegeArrayInput is an input type that accepts AccountPrivilegeArray and AccountPrivilegeArrayOutput values. You can construct a concrete instance of `AccountPrivilegeArrayInput` via: 

AccountPrivilegeArray{ AccountPrivilegeArgs{...} }

type AccountPrivilegeArrayOutput 

type AccountPrivilegeArrayOutput struct{ *pulumi.OutputState }

func (AccountPrivilegeArrayOutput) ElementType 

func (AccountPrivilegeArrayOutput) ElementType() reflect.Type

func (AccountPrivilegeArrayOutput) Index 

func (o AccountPrivilegeArrayOutput) Index(i pulumi.IntInput) AccountPrivilegeOutput

func (AccountPrivilegeArrayOutput) ToAccountPrivilegeArrayOutput 

func (o AccountPrivilegeArrayOutput) ToAccountPrivilegeArrayOutput() AccountPrivilegeArrayOutput

func (AccountPrivilegeArrayOutput) ToAccountPrivilegeArrayOutputWithContext 

func (o AccountPrivilegeArrayOutput) ToAccountPrivilegeArrayOutputWithContext(ctx context.Context) AccountPrivilegeArrayOutput

type AccountPrivilegeInput 

type AccountPrivilegeInput interface {
	pulumi.Input

	ToAccountPrivilegeOutput() AccountPrivilegeOutput
	ToAccountPrivilegeOutputWithContext(ctx context.Context) AccountPrivilegeOutput
}

type AccountPrivilegeMap 

type AccountPrivilegeMap map[string]AccountPrivilegeInput

func (AccountPrivilegeMap) ElementType 

func (AccountPrivilegeMap) ElementType() reflect.Type

func (AccountPrivilegeMap) ToAccountPrivilegeMapOutput 

func (i AccountPrivilegeMap) ToAccountPrivilegeMapOutput() AccountPrivilegeMapOutput

func (AccountPrivilegeMap) ToAccountPrivilegeMapOutputWithContext 

func (i AccountPrivilegeMap) ToAccountPrivilegeMapOutputWithContext(ctx context.Context) AccountPrivilegeMapOutput

type AccountPrivilegeMapInput 

type AccountPrivilegeMapInput interface {
	pulumi.Input

	ToAccountPrivilegeMapOutput() AccountPrivilegeMapOutput
	ToAccountPrivilegeMapOutputWithContext(context.Context) AccountPrivilegeMapOutput
}

AccountPrivilegeMapInput is an input type that accepts AccountPrivilegeMap and AccountPrivilegeMapOutput values. You can construct a concrete instance of `AccountPrivilegeMapInput` via: 

AccountPrivilegeMap{ "key": AccountPrivilegeArgs{...} }

type AccountPrivilegeMapOutput 

type AccountPrivilegeMapOutput struct{ *pulumi.OutputState }

func (AccountPrivilegeMapOutput) ElementType 

func (AccountPrivilegeMapOutput) ElementType() reflect.Type

func (AccountPrivilegeMapOutput) MapIndex 

func (o AccountPrivilegeMapOutput) MapIndex(k pulumi.StringInput) AccountPrivilegeOutput

func (AccountPrivilegeMapOutput) ToAccountPrivilegeMapOutput 

func (o AccountPrivilegeMapOutput) ToAccountPrivilegeMapOutput() AccountPrivilegeMapOutput

func (AccountPrivilegeMapOutput) ToAccountPrivilegeMapOutputWithContext 

func (o AccountPrivilegeMapOutput) ToAccountPrivilegeMapOutputWithContext(ctx context.Context) AccountPrivilegeMapOutput

type AccountPrivilegeOutput 

type AccountPrivilegeOutput struct{ *pulumi.OutputState }

func (AccountPrivilegeOutput) AccountName added in v3.27.0 

func (o AccountPrivilegeOutput) AccountName() pulumi.StringOutput

A specified account name.

func (AccountPrivilegeOutput) AccountPrivilege added in v3.27.0 

func (o AccountPrivilegeOutput) AccountPrivilege() pulumi.StringPtrOutput

The privilege of one account access database. Valid values: ["ReadOnly", "ReadWrite"], ["DMLOnly", "DDLOnly"] added since version v1.101.0. Default to "ReadOnly".

func (AccountPrivilegeOutput) DbClusterId added in v3.27.0 

func (o AccountPrivilegeOutput) DbClusterId() pulumi.StringOutput

The Id of cluster in which account belongs.

func (AccountPrivilegeOutput) DbNames added in v3.27.0 

func (o AccountPrivilegeOutput) DbNames() pulumi.StringArrayOutput

List of specified database name.

func (AccountPrivilegeOutput) ElementType 

func (AccountPrivilegeOutput) ElementType() reflect.Type

func (AccountPrivilegeOutput) ToAccountPrivilegeOutput 

func (o AccountPrivilegeOutput) ToAccountPrivilegeOutput() AccountPrivilegeOutput

func (AccountPrivilegeOutput) ToAccountPrivilegeOutputWithContext 

func (o AccountPrivilegeOutput) ToAccountPrivilegeOutputWithContext(ctx context.Context) AccountPrivilegeOutput

type AccountPrivilegeState 

type AccountPrivilegeState struct {
	// A specified account name.
	AccountName pulumi.StringPtrInput
	// The privilege of one account access database. Valid values: ["ReadOnly", "ReadWrite"], ["DMLOnly", "DDLOnly"] added since version v1.101.0. Default to "ReadOnly".
	AccountPrivilege pulumi.StringPtrInput
	// The Id of cluster in which account belongs.
	DbClusterId pulumi.StringPtrInput
	// List of specified database name.
	DbNames pulumi.StringArrayInput
}

func (AccountPrivilegeState) ElementType 

func (AccountPrivilegeState) ElementType() reflect.Type

type AccountState 

type AccountState struct {
	// 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.
	AccountDescription pulumi.StringPtrInput
	// 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.
	AccountName pulumi.StringPtrInput
	// Operation password. It may consist of letters, digits, or underlines, with a length of 6 to 32 characters.
	AccountPassword pulumi.StringPtrInput
	// Account type, Valid values are `Normal`, `Super`, Default to `Normal`.
	AccountType pulumi.StringPtrInput
	// The Id of cluster in which account belongs.
	DbClusterId pulumi.StringPtrInput
	// An KMS encrypts password used to a db account. If the `accountPassword` is filled in, this field will be ignored.
	KmsEncryptedPassword pulumi.StringPtrInput
	// An KMS encryption context used to decrypt `kmsEncryptedPassword` before creating or updating a db account with `kmsEncryptedPassword`. See [Encryption Context](https://www.alibabacloud.com/help/doc-detail/42975.htm). It is valid when `kmsEncryptedPassword` is set.
	KmsEncryptionContext pulumi.MapInput
}

func (AccountState) ElementType 

func (AccountState) ElementType() reflect.Type

type BackupPolicy 

type BackupPolicy struct {
	pulumi.CustomResourceState

	// The backup frequency. Valid values are `Normal`, `2/24H`, `3/24H`, `4/24H`.Default to `Normal`.
	BackupFrequency pulumi.StringOutput `pulumi:"backupFrequency"`
	// Cluster backup retention days, Fixed for 7 days, not modified.
	BackupRetentionPeriod pulumi.StringOutput `pulumi:"backupRetentionPeriod"`
	// Specifies whether to retain backups when you delete a cluster. Valid values are `ALL`, `LATEST`, `NONE`. Default to `NONE`. Value options can refer to the latest docs [ModifyBackupPolicy](https://www.alibabacloud.com/help/en/polardb/latest/modifybackuppolicy)
	BackupRetentionPolicyOnClusterDeletion pulumi.StringOutput `pulumi:"backupRetentionPolicyOnClusterDeletion"`
	// The Id of cluster that can run database.The backup frequency. Valid values are `Normal`, `2/24H`, `3/24H`, `4/24H`.Default to `Normal`.
	DataLevel1BackupFrequency pulumi.StringOutput `pulumi:"dataLevel1BackupFrequency"`
	// PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	// > **NOTE:** Note Select at least two values. Separate multiple values with commas (,).
	DataLevel1BackupPeriods pulumi.StringArrayOutput `pulumi:"dataLevel1BackupPeriods"`
	// The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.
	DataLevel1BackupRetentionPeriod pulumi.IntOutput `pulumi:"dataLevel1BackupRetentionPeriod"`
	// The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.
	DataLevel1BackupTime pulumi.StringOutput `pulumi:"dataLevel1BackupTime"`
	// PolarDB Cluster of level-2 backup is a cross regional backup area.
	DataLevel2BackupAnotherRegionRegion pulumi.StringPtrOutput `pulumi:"dataLevel2BackupAnotherRegionRegion"`
	// PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are `0`, `30 to 7300`, `-1`. Default to `0`.
	DataLevel2BackupAnotherRegionRetentionPeriod pulumi.IntOutput `pulumi:"dataLevel2BackupAnotherRegionRetentionPeriod"`
	// PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	// > **NOTE:** Note Select at least two values. Separate multiple values with commas (,).
	DataLevel2BackupPeriods pulumi.StringArrayOutput `pulumi:"dataLevel2BackupPeriods"`
	// The retention period of level-2 backups. Valid values are `0`, `30 to 7300`, `-1`. Default to `0`.
	DataLevel2BackupRetentionPeriod pulumi.IntOutput `pulumi:"dataLevel2BackupRetentionPeriod"`
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// Indicates whether the log backup feature was enabled. Valid values are `0`, `1`. `1` By default, the log backup feature is enabled and cannot be disabled.
	EnableBackupLog pulumi.IntOutput `pulumi:"enableBackupLog"`
	// The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see [Overview.](https://www.alibabacloud.com/help/en/polardb/latest/backup-and-restoration-overview)
	LogBackupAnotherRegionRegion pulumi.StringPtrOutput `pulumi:"logBackupAnotherRegionRegion"`
	// The retention period of cross-region log backups. Default value: OFF. Valid values are `0`, `30 to 7300`, `-1`.
	// > **NOTE:** Note When you create a cluster, the default value of this parameter is 0.
	LogBackupAnotherRegionRetentionPeriod pulumi.IntPtrOutput `pulumi:"logBackupAnotherRegionRetentionPeriod"`
	// The retention period of the log backups. Valid values are `3 to 7300`, `-1`.
	LogBackupRetentionPeriod pulumi.IntOutput `pulumi:"logBackupRetentionPeriod"`
	// PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].
	PreferredBackupPeriods pulumi.StringArrayOutput `pulumi:"preferredBackupPeriods"`
	// 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.
	PreferredBackupTime pulumi.StringOutput `pulumi:"preferredBackupTime"`
}

## Import

PolarDB backup policy can be imported using the id or cluster id, e.g.

```sh $ pulumi import alicloud:polardb/backupPolicy:BackupPolicy example "rm-12345678" ```

func GetBackupPolicy 

func GetBackupPolicy(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BackupPolicyState, opts ...pulumi.ResourceOption) (*BackupPolicy, error)

GetBackupPolicy gets an existing BackupPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBackupPolicy 

func NewBackupPolicy(ctx *pulumi.Context,
	name string, args *BackupPolicyArgs, opts ...pulumi.ResourceOption) (*BackupPolicy, error)

NewBackupPolicy registers a new resource with the given unique name, arguments, and options.

func (*BackupPolicy) ElementType 

func (*BackupPolicy) ElementType() reflect.Type

func (*BackupPolicy) ToBackupPolicyOutput 

func (i *BackupPolicy) ToBackupPolicyOutput() BackupPolicyOutput

func (*BackupPolicy) ToBackupPolicyOutputWithContext 

func (i *BackupPolicy) ToBackupPolicyOutputWithContext(ctx context.Context) BackupPolicyOutput

type BackupPolicyArgs 

type BackupPolicyArgs struct {
	// The backup frequency. Valid values are `Normal`, `2/24H`, `3/24H`, `4/24H`.Default to `Normal`.
	BackupFrequency pulumi.StringPtrInput
	// Cluster backup retention days, Fixed for 7 days, not modified.
	BackupRetentionPeriod pulumi.StringPtrInput
	// Specifies whether to retain backups when you delete a cluster. Valid values are `ALL`, `LATEST`, `NONE`. Default to `NONE`. Value options can refer to the latest docs [ModifyBackupPolicy](https://www.alibabacloud.com/help/en/polardb/latest/modifybackuppolicy)
	BackupRetentionPolicyOnClusterDeletion pulumi.StringPtrInput
	// The Id of cluster that can run database.The backup frequency. Valid values are `Normal`, `2/24H`, `3/24H`, `4/24H`.Default to `Normal`.
	DataLevel1BackupFrequency pulumi.StringPtrInput
	// PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	// > **NOTE:** Note Select at least two values. Separate multiple values with commas (,).
	DataLevel1BackupPeriods pulumi.StringArrayInput
	// The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.
	DataLevel1BackupRetentionPeriod pulumi.IntPtrInput
	// The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.
	DataLevel1BackupTime pulumi.StringPtrInput
	// PolarDB Cluster of level-2 backup is a cross regional backup area.
	DataLevel2BackupAnotherRegionRegion pulumi.StringPtrInput
	// PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are `0`, `30 to 7300`, `-1`. Default to `0`.
	DataLevel2BackupAnotherRegionRetentionPeriod pulumi.IntPtrInput
	// PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	// > **NOTE:** Note Select at least two values. Separate multiple values with commas (,).
	DataLevel2BackupPeriods pulumi.StringArrayInput
	// The retention period of level-2 backups. Valid values are `0`, `30 to 7300`, `-1`. Default to `0`.
	DataLevel2BackupRetentionPeriod pulumi.IntPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringInput
	// The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see [Overview.](https://www.alibabacloud.com/help/en/polardb/latest/backup-and-restoration-overview)
	LogBackupAnotherRegionRegion pulumi.StringPtrInput
	// The retention period of cross-region log backups. Default value: OFF. Valid values are `0`, `30 to 7300`, `-1`.
	// > **NOTE:** Note When you create a cluster, the default value of this parameter is 0.
	LogBackupAnotherRegionRetentionPeriod pulumi.IntPtrInput
	// The retention period of the log backups. Valid values are `3 to 7300`, `-1`.
	LogBackupRetentionPeriod pulumi.IntPtrInput
	// PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].
	PreferredBackupPeriods pulumi.StringArrayInput
	// 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.
	PreferredBackupTime pulumi.StringPtrInput
}

The set of arguments for constructing a BackupPolicy resource.

func (BackupPolicyArgs) ElementType 

func (BackupPolicyArgs) ElementType() reflect.Type

type BackupPolicyArray 

type BackupPolicyArray []BackupPolicyInput

func (BackupPolicyArray) ElementType 

func (BackupPolicyArray) ElementType() reflect.Type

func (BackupPolicyArray) ToBackupPolicyArrayOutput 

func (i BackupPolicyArray) ToBackupPolicyArrayOutput() BackupPolicyArrayOutput

func (BackupPolicyArray) ToBackupPolicyArrayOutputWithContext 

func (i BackupPolicyArray) ToBackupPolicyArrayOutputWithContext(ctx context.Context) BackupPolicyArrayOutput

type BackupPolicyArrayInput 

type BackupPolicyArrayInput interface {
	pulumi.Input

	ToBackupPolicyArrayOutput() BackupPolicyArrayOutput
	ToBackupPolicyArrayOutputWithContext(context.Context) BackupPolicyArrayOutput
}

BackupPolicyArrayInput is an input type that accepts BackupPolicyArray and BackupPolicyArrayOutput values. You can construct a concrete instance of `BackupPolicyArrayInput` via: 

BackupPolicyArray{ BackupPolicyArgs{...} }

type BackupPolicyArrayOutput 

type BackupPolicyArrayOutput struct{ *pulumi.OutputState }

func (BackupPolicyArrayOutput) ElementType 

func (BackupPolicyArrayOutput) ElementType() reflect.Type

func (BackupPolicyArrayOutput) Index 

func (o BackupPolicyArrayOutput) Index(i pulumi.IntInput) BackupPolicyOutput

func (BackupPolicyArrayOutput) ToBackupPolicyArrayOutput 

func (o BackupPolicyArrayOutput) ToBackupPolicyArrayOutput() BackupPolicyArrayOutput

func (BackupPolicyArrayOutput) ToBackupPolicyArrayOutputWithContext 

func (o BackupPolicyArrayOutput) ToBackupPolicyArrayOutputWithContext(ctx context.Context) BackupPolicyArrayOutput

type BackupPolicyInput 

type BackupPolicyInput interface {
	pulumi.Input

	ToBackupPolicyOutput() BackupPolicyOutput
	ToBackupPolicyOutputWithContext(ctx context.Context) BackupPolicyOutput
}

type BackupPolicyMap 

type BackupPolicyMap map[string]BackupPolicyInput

func (BackupPolicyMap) ElementType 

func (BackupPolicyMap) ElementType() reflect.Type

func (BackupPolicyMap) ToBackupPolicyMapOutput 

func (i BackupPolicyMap) ToBackupPolicyMapOutput() BackupPolicyMapOutput

func (BackupPolicyMap) ToBackupPolicyMapOutputWithContext 

func (i BackupPolicyMap) ToBackupPolicyMapOutputWithContext(ctx context.Context) BackupPolicyMapOutput

type BackupPolicyMapInput 

type BackupPolicyMapInput interface {
	pulumi.Input

	ToBackupPolicyMapOutput() BackupPolicyMapOutput
	ToBackupPolicyMapOutputWithContext(context.Context) BackupPolicyMapOutput
}

BackupPolicyMapInput is an input type that accepts BackupPolicyMap and BackupPolicyMapOutput values. You can construct a concrete instance of `BackupPolicyMapInput` via: 

BackupPolicyMap{ "key": BackupPolicyArgs{...} }

type BackupPolicyMapOutput 

type BackupPolicyMapOutput struct{ *pulumi.OutputState }

func (BackupPolicyMapOutput) ElementType 

func (BackupPolicyMapOutput) ElementType() reflect.Type

func (BackupPolicyMapOutput) MapIndex 

func (o BackupPolicyMapOutput) MapIndex(k pulumi.StringInput) BackupPolicyOutput

func (BackupPolicyMapOutput) ToBackupPolicyMapOutput 

func (o BackupPolicyMapOutput) ToBackupPolicyMapOutput() BackupPolicyMapOutput

func (BackupPolicyMapOutput) ToBackupPolicyMapOutputWithContext 

func (o BackupPolicyMapOutput) ToBackupPolicyMapOutputWithContext(ctx context.Context) BackupPolicyMapOutput

type BackupPolicyOutput 

type BackupPolicyOutput struct{ *pulumi.OutputState }

func (BackupPolicyOutput) BackupFrequency added in v3.39.0 

func (o BackupPolicyOutput) BackupFrequency() pulumi.StringOutput

The backup frequency. Valid values are `Normal`, `2/24H`, `3/24H`, `4/24H`.Default to `Normal`.

func (BackupPolicyOutput) BackupRetentionPeriod added in v3.27.0 

func (o BackupPolicyOutput) BackupRetentionPeriod() pulumi.StringOutput

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

func (BackupPolicyOutput) BackupRetentionPolicyOnClusterDeletion added in v3.27.0 

func (o BackupPolicyOutput) BackupRetentionPolicyOnClusterDeletion() pulumi.StringOutput

Specifies whether to retain backups when you delete a cluster. Valid values are `ALL`, `LATEST`, `NONE`. Default to `NONE`. Value options can refer to the latest docs [ModifyBackupPolicy](https://www.alibabacloud.com/help/en/polardb/latest/modifybackuppolicy)

func (BackupPolicyOutput) DataLevel1BackupFrequency added in v3.39.0 

func (o BackupPolicyOutput) DataLevel1BackupFrequency() pulumi.StringOutput

The Id of cluster that can run database.The backup frequency. Valid values are `Normal`, `2/24H`, `3/24H`, `4/24H`.Default to `Normal`.

func (BackupPolicyOutput) DataLevel1BackupPeriods added in v3.39.0 

func (o BackupPolicyOutput) DataLevel1BackupPeriods() pulumi.StringArrayOutput

PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. > **NOTE:** Note Select at least two values. Separate multiple values with commas (,).

func (BackupPolicyOutput) DataLevel1BackupRetentionPeriod added in v3.39.0 

func (o BackupPolicyOutput) DataLevel1BackupRetentionPeriod() pulumi.IntOutput

The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.

func (BackupPolicyOutput) DataLevel1BackupTime added in v3.39.0 

func (o BackupPolicyOutput) DataLevel1BackupTime() pulumi.StringOutput

The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.

func (BackupPolicyOutput) DataLevel2BackupAnotherRegionRegion added in v3.39.0 

func (o BackupPolicyOutput) DataLevel2BackupAnotherRegionRegion() pulumi.StringPtrOutput

PolarDB Cluster of level-2 backup is a cross regional backup area.

func (BackupPolicyOutput) DataLevel2BackupAnotherRegionRetentionPeriod added in v3.39.0 

func (o BackupPolicyOutput) DataLevel2BackupAnotherRegionRetentionPeriod() pulumi.IntOutput

PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are `0`, `30 to 7300`, `-1`. Default to `0`.

func (BackupPolicyOutput) DataLevel2BackupPeriods added in v3.39.0 

func (o BackupPolicyOutput) DataLevel2BackupPeriods() pulumi.StringArrayOutput

PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. > **NOTE:** Note Select at least two values. Separate multiple values with commas (,).

func (BackupPolicyOutput) DataLevel2BackupRetentionPeriod added in v3.39.0 

func (o BackupPolicyOutput) DataLevel2BackupRetentionPeriod() pulumi.IntOutput

The retention period of level-2 backups. Valid values are `0`, `30 to 7300`, `-1`. Default to `0`.

func (BackupPolicyOutput) DbClusterId added in v3.27.0 

func (o BackupPolicyOutput) DbClusterId() pulumi.StringOutput

The Id of cluster that can run database.

func (BackupPolicyOutput) ElementType 

func (BackupPolicyOutput) ElementType() reflect.Type

func (BackupPolicyOutput) EnableBackupLog added in v3.39.0 

func (o BackupPolicyOutput) EnableBackupLog() pulumi.IntOutput

Indicates whether the log backup feature was enabled. Valid values are `0`, `1`. `1` By default, the log backup feature is enabled and cannot be disabled.

func (BackupPolicyOutput) LogBackupAnotherRegionRegion added in v3.39.0 

func (o BackupPolicyOutput) LogBackupAnotherRegionRegion() pulumi.StringPtrOutput

The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see [Overview.](https://www.alibabacloud.com/help/en/polardb/latest/backup-and-restoration-overview)

func (BackupPolicyOutput) LogBackupAnotherRegionRetentionPeriod added in v3.39.0 

func (o BackupPolicyOutput) LogBackupAnotherRegionRetentionPeriod() pulumi.IntPtrOutput

The retention period of cross-region log backups. Default value: OFF. Valid values are `0`, `30 to 7300`, `-1`. > **NOTE:** Note When you create a cluster, the default value of this parameter is 0.

func (BackupPolicyOutput) LogBackupRetentionPeriod added in v3.39.0 

func (o BackupPolicyOutput) LogBackupRetentionPeriod() pulumi.IntOutput

The retention period of the log backups. Valid values are `3 to 7300`, `-1`.

func (BackupPolicyOutput) PreferredBackupPeriods added in v3.27.0 

func (o BackupPolicyOutput) PreferredBackupPeriods() pulumi.StringArrayOutput

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

func (BackupPolicyOutput) PreferredBackupTime added in v3.27.0 

func (o BackupPolicyOutput) PreferredBackupTime() pulumi.StringOutput

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.

func (BackupPolicyOutput) ToBackupPolicyOutput 

func (o BackupPolicyOutput) ToBackupPolicyOutput() BackupPolicyOutput

func (BackupPolicyOutput) ToBackupPolicyOutputWithContext 

func (o BackupPolicyOutput) ToBackupPolicyOutputWithContext(ctx context.Context) BackupPolicyOutput

type BackupPolicyState 

type BackupPolicyState struct {
	// The backup frequency. Valid values are `Normal`, `2/24H`, `3/24H`, `4/24H`.Default to `Normal`.
	BackupFrequency pulumi.StringPtrInput
	// Cluster backup retention days, Fixed for 7 days, not modified.
	BackupRetentionPeriod pulumi.StringPtrInput
	// Specifies whether to retain backups when you delete a cluster. Valid values are `ALL`, `LATEST`, `NONE`. Default to `NONE`. Value options can refer to the latest docs [ModifyBackupPolicy](https://www.alibabacloud.com/help/en/polardb/latest/modifybackuppolicy)
	BackupRetentionPolicyOnClusterDeletion pulumi.StringPtrInput
	// The Id of cluster that can run database.The backup frequency. Valid values are `Normal`, `2/24H`, `3/24H`, `4/24H`.Default to `Normal`.
	DataLevel1BackupFrequency pulumi.StringPtrInput
	// PolarDB Cluster of level-1 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	// > **NOTE:** Note Select at least two values. Separate multiple values with commas (,).
	DataLevel1BackupPeriods pulumi.StringArrayInput
	// The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.
	DataLevel1BackupRetentionPeriod pulumi.IntPtrInput
	// The time period during which automatic backup is performed. The format is HH: MMZ HH: MMZ (UTC time), and the entered value must be an hour apart, such as 14:00z-15:00z.
	DataLevel1BackupTime pulumi.StringPtrInput
	// PolarDB Cluster of level-2 backup is a cross regional backup area.
	DataLevel2BackupAnotherRegionRegion pulumi.StringPtrInput
	// PolarDB Cluster of level-2 backup cross region backup retention period. Valid values are `0`, `30 to 7300`, `-1`. Default to `0`.
	DataLevel2BackupAnotherRegionRetentionPeriod pulumi.IntPtrInput
	// PolarDB Cluster of level-2 backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	// > **NOTE:** Note Select at least two values. Separate multiple values with commas (,).
	DataLevel2BackupPeriods pulumi.StringArrayInput
	// The retention period of level-2 backups. Valid values are `0`, `30 to 7300`, `-1`. Default to `0`.
	DataLevel2BackupRetentionPeriod pulumi.IntPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringPtrInput
	// Indicates whether the log backup feature was enabled. Valid values are `0`, `1`. `1` By default, the log backup feature is enabled and cannot be disabled.
	EnableBackupLog pulumi.IntPtrInput
	// The region in which you want to store cross-region log backups. For information about regions that support the cross-region backup feature, see [Overview.](https://www.alibabacloud.com/help/en/polardb/latest/backup-and-restoration-overview)
	LogBackupAnotherRegionRegion pulumi.StringPtrInput
	// The retention period of cross-region log backups. Default value: OFF. Valid values are `0`, `30 to 7300`, `-1`.
	// > **NOTE:** Note When you create a cluster, the default value of this parameter is 0.
	LogBackupAnotherRegionRetentionPeriod pulumi.IntPtrInput
	// The retention period of the log backups. Valid values are `3 to 7300`, `-1`.
	LogBackupRetentionPeriod pulumi.IntPtrInput
	// PolarDB Cluster backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]. Default to ["Tuesday", "Thursday", "Saturday"].
	PreferredBackupPeriods pulumi.StringArrayInput
	// 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.
	PreferredBackupTime pulumi.StringPtrInput
}

func (BackupPolicyState) ElementType 

func (BackupPolicyState) ElementType() reflect.Type

type Cluster 

type Cluster struct {
	pulumi.CustomResourceState

	// Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are `true`, `false`. This parameter is valid only for serverless clusters.
	AllowShutDown pulumi.StringPtrOutput `pulumi:"allowShutDown"`
	// 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.
	AutoRenewPeriod pulumi.IntPtrOutput `pulumi:"autoRenewPeriod"`
	// The retention policy for the backup sets when you delete the cluster.  Valid values are `ALL`, `LATEST`, `NONE`. Value options can refer to the latest docs [DeleteDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/deletedbcluster-1)
	BackupRetentionPolicyOnClusterDeletion pulumi.StringOutput `pulumi:"backupRetentionPolicyOnClusterDeletion"`
	// The time point of data to be cloned. Valid values are `LATEST`,`BackupID`,`Timestamp`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CloneDataPoint`.
	// > **NOTE:** If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
	CloneDataPoint pulumi.StringPtrOutput `pulumi:"cloneDataPoint"`
	// Specifies whether to enable or disable SQL data collector. Valid values are `Enable`, `Disabled`.
	CollectorStatus pulumi.StringOutput `pulumi:"collectorStatus"`
	// (Available since 1.81.0) PolarDB cluster connection string.
	ConnectionString pulumi.StringOutput `pulumi:"connectionString"`
	// (Available since 1.204.1) PolarDB cluster creation time.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// The edition of the PolarDB service. Valid values are `Normal`,`Basic`,`ArchiveNormal`,`NormalMultimaster`,`SENormal`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CreationCategory`.
	// > **NOTE:** You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, `creationCategory` can be set to `NormalMultimaster`. From version 1.203.0, `creationCategory` can be set to `SENormal`.
	CreationCategory pulumi.StringOutput `pulumi:"creationCategory"`
	// The method that is used to create a cluster. Valid values are `Normal`,`CloneFromPolarDB`,`CloneFromRDS`,`MigrationFromRDS`,`CreateGdnStandby`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CreationOption`.
	// > **NOTE:** The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.
	CreationOption pulumi.StringOutput `pulumi:"creationOption"`
	// db_cluster_ip_array defines how users can send requests to your API. See `dbClusterIpArray` below.
	DbClusterIpArrays ClusterDbClusterIpArrayArrayOutput `pulumi:"dbClusterIpArrays"`
	// The dbNodeClass of cluster node.
	// > **NOTE:** Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.
	// From version 1.204.0, If you need to create a Serverless cluster, `dbNodeClass` can be set to `polar.mysql.sl.small`.
	DbNodeClass pulumi.StringOutput `pulumi:"dbNodeClass"`
	// Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].
	// > **NOTE:** To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.
	DbNodeCount pulumi.IntOutput `pulumi:"dbNodeCount"`
	// The ID of the node or node subscript. Node subscript values: 1 to 15.
	DbNodeId pulumi.StringPtrOutput `pulumi:"dbNodeId"`
	// The number of Standard Edition nodes. Default value: `1`. Valid values are `1`, `2`.
	DbNodeNum pulumi.IntPtrOutput `pulumi:"dbNodeNum"`
	// (Available since v1.216.0) The dbRevisionVersionList supports the following:
	DbRevisionVersionLists ClusterDbRevisionVersionListArrayOutput `pulumi:"dbRevisionVersionLists"`
	// Database type. Value options: MySQL, Oracle, PostgreSQL.
	DbType pulumi.StringOutput `pulumi:"dbType"`
	// Database version. Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `DBVersion`.
	DbVersion pulumi.StringOutput `pulumi:"dbVersion"`
	// The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
	// > **NOTE:** This parameter is valid only when the DBType parameter is set to MySQL.
	DefaultTimeZone pulumi.StringOutput `pulumi:"defaultTimeZone"`
	// turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock
	// > **NOTE:**  Cannot modify after created when `payType` is `Prepaid` .`deletionLock` the cluster protection lock can be turned on or off when `payType` is `Postpaid`.
	DeletionLock pulumi.IntPtrOutput `pulumi:"deletionLock"`
	// The description of cluster.
	Description pulumi.StringOutput `pulumi:"description"`
	// turn on table auto encryption. Valid values are `ON`, `OFF`. Only MySQL 8.0 supports.
	// > **NOTE:** `encryptNewTables` Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.
	EncryptNewTables pulumi.StringPtrOutput `pulumi:"encryptNewTables"`
	// The ID of the custom key. `encryptionKey` cannot be modified after TDE is opened.
	EncryptionKey pulumi.StringPtrOutput `pulumi:"encryptionKey"`
	// Immediate or scheduled kernel version upgrade. Valid values are `true`, `false`. True means immediate execution, False means scheduled execution.
	FromTimeService pulumi.StringPtrOutput `pulumi:"fromTimeService"`
	// The ID of the global database network (GDN).
	// > **NOTE:** This parameter is required if CreationOption is set to CreateGdnStandby.
	GdnId pulumi.StringPtrOutput `pulumi:"gdnId"`
	// Indicates whether the hot standby feature is enabled. Valid values are `ON`, `OFF`. Only MySQL supports.
	HotReplicaMode pulumi.StringOutput `pulumi:"hotReplicaMode"`
	// Whether to enable the hot standby cluster. Valid values are `ON`, `OFF`. Only MySQL supports.
	HotStandbyCluster pulumi.StringOutput `pulumi:"hotStandbyCluster"`
	// Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are `ON`, `OFF`.
	// > **NOTE:**  Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above.
	// **NOTE:**  The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.
	ImciSwitch pulumi.StringOutput `pulumi:"imciSwitch"`
	// Enable the Binlog function. Default value: `OFF`. Valid values are `OFF`, `ON`.
	// > **NOTE:** This parameter is valid only MySQL Engine supports.
	LoosePolarLogBin pulumi.StringOutput `pulumi:"loosePolarLogBin"`
	// Specifies whether the table names are case-sensitive. Default value: `1`.  Valid values are `1`, `0`.
	// > **NOTE:** This parameter is valid only when the DBType parameter is set to MySQL.
	LowerCaseTableNames pulumi.IntOutput `pulumi:"lowerCaseTableNames"`
	// Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
	MaintainTime pulumi.StringOutput `pulumi:"maintainTime"`
	// Use as `dbNodeClass` change class, define upgrade or downgrade. Valid values are `Upgrade`, `Downgrade`, Default to `Upgrade`.
	ModifyType pulumi.StringPtrOutput `pulumi:"modifyType"`
	// The ID of the parameter template
	// > **NOTE:** You can call the [DescribeParameterGroups](https://www.alibabacloud.com/help/en/polardb/latest/describeparametergroups) operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
	ParameterGroupId pulumi.StringPtrOutput `pulumi:"parameterGroupId"`
	// Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs [View database parameter templates](https://www.alibabacloud.com/help/en/polardb/latest/modifydbclusterparameters) .See `parameters` below.
	Parameters ClusterParameterArrayOutput `pulumi:"parameters"`
	// Valid values are `PrePaid`, `PostPaid`, Default to `PostPaid`.
	PayType pulumi.StringPtrOutput `pulumi:"payType"`
	// The duration that you will buy DB cluster (in month). It is valid when payType is `PrePaid`. Valid values: [1~9], 12, 24, 36.
	// > **NOTE:** The attribute `period` is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running `pulumi up` will not effect the resource.
	Period pulumi.IntPtrOutput `pulumi:"period"`
	// The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
	// > **NOTE:** The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
	PlannedEndTime pulumi.StringPtrOutput `pulumi:"plannedEndTime"`
	// The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
	// > **NOTE:** The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
	PlannedStartTime pulumi.StringPtrOutput `pulumi:"plannedStartTime"`
	// (Available since 1.196.0) PolarDB cluster connection port.
	Port pulumi.StringOutput `pulumi:"port"`
	// The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `ProxyType`
	// > **NOTE:** This parameter is valid only for standard clusters.
	ProxyClass pulumi.StringPtrOutput `pulumi:"proxyClass"`
	// The type of PolarProxy. Default value: `OFF`. Valid values are `OFF`, `EXCLUSIVE` `GENERAL`.
	// > **NOTE:** This parameter is valid only for standard clusters.
	ProxyType pulumi.StringPtrOutput `pulumi:"proxyType"`
	// Valid values are `AutoRenewal`, `Normal`, `NotRenewal`, Default to `NotRenewal`.
	RenewalStatus pulumi.StringPtrOutput `pulumi:"renewalStatus"`
	// The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
	ResourceGroupId pulumi.StringOutput `pulumi:"resourceGroupId"`
	// The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see [RAM role overview](https://www.alibabacloud.com/help/en/resource-access-management/latest/ram-role-overview).
	RoleArn pulumi.StringOutput `pulumi:"roleArn"`
	// Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.
	ScaleApRoNumMax pulumi.IntOutput `pulumi:"scaleApRoNumMax"`
	// Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.
	ScaleApRoNumMin pulumi.IntOutput `pulumi:"scaleApRoNumMin"`
	// The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs. It is valid when serverlessType is `AgileServerless`. Valid values: 1 PCU to 8 PCUs.It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleMax pulumi.IntPtrOutput `pulumi:"scaleMax"`
	// The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs. It is valid when serverlessType is `AgileServerless`. Valid values: 1 PCU to 8 PCUs.It is valid when serverlessType is `SteadyServerless`.· This parameter is valid only for serverless clusters.
	ScaleMin pulumi.IntPtrOutput `pulumi:"scaleMin"`
	// The maximum number of read-only nodes for scaling. Valid values: 0 to 15. It is valid when serverlessType is `AgileServerless`. Valid values: 0 to 7. It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleRoNumMax pulumi.IntPtrOutput `pulumi:"scaleRoNumMax"`
	// The minimum number of read-only nodes for scaling. Valid values: 0 to 15 . It is valid when serverlessType is `AgileServerless`. Valid values: 0 to 7 .It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleRoNumMin pulumi.IntPtrOutput `pulumi:"scaleRoNumMin"`
	// The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds. This parameter is valid only for serverless clusters.
	SecondsUntilAutoPause pulumi.IntOutput `pulumi:"secondsUntilAutoPause"`
	// The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.
	// > **NOTE:** Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.
	SecurityGroupIds pulumi.StringArrayOutput `pulumi:"securityGroupIds"`
	// This attribute has been deprecated from v1.130.0 and using `dbClusterIpArray` sub-element `securityIps` instead.
	// Its value is same as `dbClusterIpArray` sub-element `securityIps` value and its dbClusterIpArrayName is "default".
	SecurityIps pulumi.StringArrayOutput `pulumi:"securityIps"`
	// Serverless steady-state switch. Valid values are `ON`, `OFF`. This parameter is valid only for serverless clusters.
	// > **NOTE:** When serverlessSteadySwitch is `ON` and serverlessType is `SteadyServerless`, parameters `scaleMin`, `scaleMax`, `scaleRoNumMin` and `scaleRoNumMax` are all required.
	ServerlessSteadySwitch pulumi.StringPtrOutput `pulumi:"serverlessSteadySwitch"`
	// The type of the serverless cluster. Valid values `AgileServerless`, `SteadyServerless`. This parameter is valid only for serverless clusters.
	ServerlessType pulumi.StringPtrOutput `pulumi:"serverlessType"`
	// The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `SourceResourceId`.
	SourceResourceId pulumi.StringPtrOutput `pulumi:"sourceResourceId"`
	// (Available since 1.204.1) PolarDB cluster status.
	Status pulumi.StringOutput `pulumi:"status"`
	// The billing method of the storage. Valid values `Postpaid`, `Prepaid`.
	StoragePayType pulumi.StringOutput `pulumi:"storagePayType"`
	// Storage space charged by space (monthly package). Unit: GB.
	// > **NOTE:**  Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when payType are `PrePaid` ,`PostPaid`.
	// **NOTE:**  Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when payType is `PrePaid`.
	StorageSpace pulumi.IntOutput `pulumi:"storageSpace"`
	// The storage type of the cluster. Enterprise storage type values are `PSL5`, `PSL4`. The standard version storage type values are `ESSDPL1`, `ESSDPL2`, `ESSDPL3`. The standard version only supports MySQL.
	// > **NOTE:** Serverless cluster does not support this parameter.
	StorageType pulumi.StringOutput `pulumi:"storageType"`
	// The category of the cluster. Valid values are `Exclusive`, `General`. Only MySQL supports.
	SubCategory pulumi.StringOutput `pulumi:"subCategory"`
	// 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.
	Tags pulumi.MapOutput `pulumi:"tags"`
	// The Version Code of the target version, whose parameter values can be obtained from the [DescribeDBClusterVersion](https://www.alibabacloud.com/help/en/polardb/latest/describedbclusterversion) interface.
	TargetDbRevisionVersionCode pulumi.StringPtrOutput `pulumi:"targetDbRevisionVersionCode"`
	// (Available since 1.200.0) The region where the TDE key resides.
	// > **NOTE:** TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified.
	// **NOTE:** You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.
	TdeRegion pulumi.StringOutput `pulumi:"tdeRegion"`
	// turn on TDE encryption. Valid values are `Enabled`, `Disabled`. Default to `Disabled`. TDE cannot be closed after it is turned on.
	// > **NOTE:** `tdeStatus` Cannot modify after created when `dbType` is `PostgreSQL` or `Oracle`.`tdeStatus` only support modification from `Disabled` to `Enabled` when `dbType` is `MySQL`.
	TdeStatus pulumi.StringPtrOutput `pulumi:"tdeStatus"`
	// Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
	UpgradeType pulumi.StringPtrOutput `pulumi:"upgradeType"`
	// The id of the VPC.
	VpcId pulumi.StringOutput `pulumi:"vpcId"`
	// The virtual switch ID to launch DB instances in one VPC.
	// > **NOTE:** If vswitchId is not specified, system will get a vswitch belongs to the user automatically.
	VswitchId pulumi.StringPtrOutput `pulumi:"vswitchId"`
	// The Zone to launch the DB cluster. it supports multiple zone.
	ZoneId pulumi.StringOutput `pulumi:"zoneId"`
}

## Import

PolarDB cluster can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/cluster:Cluster example pc-abc12345678 ```

func GetCluster 

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ClusterState, opts ...pulumi.ResourceOption) (*Cluster, error)

GetCluster gets an existing Cluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCluster 

func NewCluster(ctx *pulumi.Context,
	name string, args *ClusterArgs, opts ...pulumi.ResourceOption) (*Cluster, error)

NewCluster registers a new resource with the given unique name, arguments, and options.

func (*Cluster) ElementType 

func (*Cluster) ElementType() reflect.Type

func (*Cluster) ToClusterOutput 

func (i *Cluster) ToClusterOutput() ClusterOutput

func (*Cluster) ToClusterOutputWithContext 

func (i *Cluster) ToClusterOutputWithContext(ctx context.Context) ClusterOutput

type ClusterArgs 

type ClusterArgs struct {
	// Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are `true`, `false`. This parameter is valid only for serverless clusters.
	AllowShutDown pulumi.StringPtrInput
	// 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.
	AutoRenewPeriod pulumi.IntPtrInput
	// The retention policy for the backup sets when you delete the cluster.  Valid values are `ALL`, `LATEST`, `NONE`. Value options can refer to the latest docs [DeleteDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/deletedbcluster-1)
	BackupRetentionPolicyOnClusterDeletion pulumi.StringPtrInput
	// The time point of data to be cloned. Valid values are `LATEST`,`BackupID`,`Timestamp`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CloneDataPoint`.
	// > **NOTE:** If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
	CloneDataPoint pulumi.StringPtrInput
	// Specifies whether to enable or disable SQL data collector. Valid values are `Enable`, `Disabled`.
	CollectorStatus pulumi.StringPtrInput
	// The edition of the PolarDB service. Valid values are `Normal`,`Basic`,`ArchiveNormal`,`NormalMultimaster`,`SENormal`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CreationCategory`.
	// > **NOTE:** You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, `creationCategory` can be set to `NormalMultimaster`. From version 1.203.0, `creationCategory` can be set to `SENormal`.
	CreationCategory pulumi.StringPtrInput
	// The method that is used to create a cluster. Valid values are `Normal`,`CloneFromPolarDB`,`CloneFromRDS`,`MigrationFromRDS`,`CreateGdnStandby`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CreationOption`.
	// > **NOTE:** The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.
	CreationOption pulumi.StringPtrInput
	// db_cluster_ip_array defines how users can send requests to your API. See `dbClusterIpArray` below.
	DbClusterIpArrays ClusterDbClusterIpArrayArrayInput
	// The dbNodeClass of cluster node.
	// > **NOTE:** Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.
	// From version 1.204.0, If you need to create a Serverless cluster, `dbNodeClass` can be set to `polar.mysql.sl.small`.
	DbNodeClass pulumi.StringInput
	// Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].
	// > **NOTE:** To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.
	DbNodeCount pulumi.IntPtrInput
	// The ID of the node or node subscript. Node subscript values: 1 to 15.
	DbNodeId pulumi.StringPtrInput
	// The number of Standard Edition nodes. Default value: `1`. Valid values are `1`, `2`.
	DbNodeNum pulumi.IntPtrInput
	// Database type. Value options: MySQL, Oracle, PostgreSQL.
	DbType pulumi.StringInput
	// Database version. Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `DBVersion`.
	DbVersion pulumi.StringInput
	// The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
	// > **NOTE:** This parameter is valid only when the DBType parameter is set to MySQL.
	DefaultTimeZone pulumi.StringPtrInput
	// turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock
	// > **NOTE:**  Cannot modify after created when `payType` is `Prepaid` .`deletionLock` the cluster protection lock can be turned on or off when `payType` is `Postpaid`.
	DeletionLock pulumi.IntPtrInput
	// The description of cluster.
	Description pulumi.StringPtrInput
	// turn on table auto encryption. Valid values are `ON`, `OFF`. Only MySQL 8.0 supports.
	// > **NOTE:** `encryptNewTables` Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.
	EncryptNewTables pulumi.StringPtrInput
	// The ID of the custom key. `encryptionKey` cannot be modified after TDE is opened.
	EncryptionKey pulumi.StringPtrInput
	// Immediate or scheduled kernel version upgrade. Valid values are `true`, `false`. True means immediate execution, False means scheduled execution.
	FromTimeService pulumi.StringPtrInput
	// The ID of the global database network (GDN).
	// > **NOTE:** This parameter is required if CreationOption is set to CreateGdnStandby.
	GdnId pulumi.StringPtrInput
	// Indicates whether the hot standby feature is enabled. Valid values are `ON`, `OFF`. Only MySQL supports.
	HotReplicaMode pulumi.StringPtrInput
	// Whether to enable the hot standby cluster. Valid values are `ON`, `OFF`. Only MySQL supports.
	HotStandbyCluster pulumi.StringPtrInput
	// Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are `ON`, `OFF`.
	// > **NOTE:**  Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above.
	// **NOTE:**  The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.
	ImciSwitch pulumi.StringPtrInput
	// Enable the Binlog function. Default value: `OFF`. Valid values are `OFF`, `ON`.
	// > **NOTE:** This parameter is valid only MySQL Engine supports.
	LoosePolarLogBin pulumi.StringPtrInput
	// Specifies whether the table names are case-sensitive. Default value: `1`.  Valid values are `1`, `0`.
	// > **NOTE:** This parameter is valid only when the DBType parameter is set to MySQL.
	LowerCaseTableNames pulumi.IntPtrInput
	// Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
	MaintainTime pulumi.StringPtrInput
	// Use as `dbNodeClass` change class, define upgrade or downgrade. Valid values are `Upgrade`, `Downgrade`, Default to `Upgrade`.
	ModifyType pulumi.StringPtrInput
	// The ID of the parameter template
	// > **NOTE:** You can call the [DescribeParameterGroups](https://www.alibabacloud.com/help/en/polardb/latest/describeparametergroups) operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
	ParameterGroupId pulumi.StringPtrInput
	// Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs [View database parameter templates](https://www.alibabacloud.com/help/en/polardb/latest/modifydbclusterparameters) .See `parameters` below.
	Parameters ClusterParameterArrayInput
	// Valid values are `PrePaid`, `PostPaid`, Default to `PostPaid`.
	PayType pulumi.StringPtrInput
	// The duration that you will buy DB cluster (in month). It is valid when payType is `PrePaid`. Valid values: [1~9], 12, 24, 36.
	// > **NOTE:** The attribute `period` is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running `pulumi up` will not effect the resource.
	Period pulumi.IntPtrInput
	// The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
	// > **NOTE:** The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
	PlannedEndTime pulumi.StringPtrInput
	// The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
	// > **NOTE:** The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
	PlannedStartTime pulumi.StringPtrInput
	// The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `ProxyType`
	// > **NOTE:** This parameter is valid only for standard clusters.
	ProxyClass pulumi.StringPtrInput
	// The type of PolarProxy. Default value: `OFF`. Valid values are `OFF`, `EXCLUSIVE` `GENERAL`.
	// > **NOTE:** This parameter is valid only for standard clusters.
	ProxyType pulumi.StringPtrInput
	// Valid values are `AutoRenewal`, `Normal`, `NotRenewal`, Default to `NotRenewal`.
	RenewalStatus pulumi.StringPtrInput
	// The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
	ResourceGroupId pulumi.StringPtrInput
	// The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see [RAM role overview](https://www.alibabacloud.com/help/en/resource-access-management/latest/ram-role-overview).
	RoleArn pulumi.StringPtrInput
	// Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.
	ScaleApRoNumMax pulumi.IntPtrInput
	// Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.
	ScaleApRoNumMin pulumi.IntPtrInput
	// The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs. It is valid when serverlessType is `AgileServerless`. Valid values: 1 PCU to 8 PCUs.It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleMax pulumi.IntPtrInput
	// The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs. It is valid when serverlessType is `AgileServerless`. Valid values: 1 PCU to 8 PCUs.It is valid when serverlessType is `SteadyServerless`.· This parameter is valid only for serverless clusters.
	ScaleMin pulumi.IntPtrInput
	// The maximum number of read-only nodes for scaling. Valid values: 0 to 15. It is valid when serverlessType is `AgileServerless`. Valid values: 0 to 7. It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleRoNumMax pulumi.IntPtrInput
	// The minimum number of read-only nodes for scaling. Valid values: 0 to 15 . It is valid when serverlessType is `AgileServerless`. Valid values: 0 to 7 .It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleRoNumMin pulumi.IntPtrInput
	// The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds. This parameter is valid only for serverless clusters.
	SecondsUntilAutoPause pulumi.IntPtrInput
	// The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.
	// > **NOTE:** Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.
	SecurityGroupIds pulumi.StringArrayInput
	// This attribute has been deprecated from v1.130.0 and using `dbClusterIpArray` sub-element `securityIps` instead.
	// Its value is same as `dbClusterIpArray` sub-element `securityIps` value and its dbClusterIpArrayName is "default".
	SecurityIps pulumi.StringArrayInput
	// Serverless steady-state switch. Valid values are `ON`, `OFF`. This parameter is valid only for serverless clusters.
	// > **NOTE:** When serverlessSteadySwitch is `ON` and serverlessType is `SteadyServerless`, parameters `scaleMin`, `scaleMax`, `scaleRoNumMin` and `scaleRoNumMax` are all required.
	ServerlessSteadySwitch pulumi.StringPtrInput
	// The type of the serverless cluster. Valid values `AgileServerless`, `SteadyServerless`. This parameter is valid only for serverless clusters.
	ServerlessType pulumi.StringPtrInput
	// The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `SourceResourceId`.
	SourceResourceId pulumi.StringPtrInput
	// The billing method of the storage. Valid values `Postpaid`, `Prepaid`.
	StoragePayType pulumi.StringPtrInput
	// Storage space charged by space (monthly package). Unit: GB.
	// > **NOTE:**  Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when payType are `PrePaid` ,`PostPaid`.
	// **NOTE:**  Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when payType is `PrePaid`.
	StorageSpace pulumi.IntPtrInput
	// The storage type of the cluster. Enterprise storage type values are `PSL5`, `PSL4`. The standard version storage type values are `ESSDPL1`, `ESSDPL2`, `ESSDPL3`. The standard version only supports MySQL.
	// > **NOTE:** Serverless cluster does not support this parameter.
	StorageType pulumi.StringPtrInput
	// The category of the cluster. Valid values are `Exclusive`, `General`. Only MySQL supports.
	SubCategory pulumi.StringPtrInput
	// 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.
	Tags pulumi.MapInput
	// The Version Code of the target version, whose parameter values can be obtained from the [DescribeDBClusterVersion](https://www.alibabacloud.com/help/en/polardb/latest/describedbclusterversion) interface.
	TargetDbRevisionVersionCode pulumi.StringPtrInput
	// turn on TDE encryption. Valid values are `Enabled`, `Disabled`. Default to `Disabled`. TDE cannot be closed after it is turned on.
	// > **NOTE:** `tdeStatus` Cannot modify after created when `dbType` is `PostgreSQL` or `Oracle`.`tdeStatus` only support modification from `Disabled` to `Enabled` when `dbType` is `MySQL`.
	TdeStatus pulumi.StringPtrInput
	// Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
	UpgradeType pulumi.StringPtrInput
	// The id of the VPC.
	VpcId pulumi.StringPtrInput
	// The virtual switch ID to launch DB instances in one VPC.
	// > **NOTE:** If vswitchId is not specified, system will get a vswitch belongs to the user automatically.
	VswitchId pulumi.StringPtrInput
	// The Zone to launch the DB cluster. it supports multiple zone.
	ZoneId pulumi.StringPtrInput
}

The set of arguments for constructing a Cluster resource.

func (ClusterArgs) ElementType 

func (ClusterArgs) ElementType() reflect.Type

type ClusterArray 

type ClusterArray []ClusterInput

func (ClusterArray) ElementType 

func (ClusterArray) ElementType() reflect.Type

func (ClusterArray) ToClusterArrayOutput 

func (i ClusterArray) ToClusterArrayOutput() ClusterArrayOutput

func (ClusterArray) ToClusterArrayOutputWithContext 

func (i ClusterArray) ToClusterArrayOutputWithContext(ctx context.Context) ClusterArrayOutput

type ClusterArrayInput 

type ClusterArrayInput interface {
	pulumi.Input

	ToClusterArrayOutput() ClusterArrayOutput
	ToClusterArrayOutputWithContext(context.Context) ClusterArrayOutput
}

ClusterArrayInput is an input type that accepts ClusterArray and ClusterArrayOutput values. You can construct a concrete instance of `ClusterArrayInput` via: 

ClusterArray{ ClusterArgs{...} }

type ClusterArrayOutput 

type ClusterArrayOutput struct{ *pulumi.OutputState }

func (ClusterArrayOutput) ElementType 

func (ClusterArrayOutput) ElementType() reflect.Type

func (ClusterArrayOutput) Index 

func (o ClusterArrayOutput) Index(i pulumi.IntInput) ClusterOutput

func (ClusterArrayOutput) ToClusterArrayOutput 

func (o ClusterArrayOutput) ToClusterArrayOutput() ClusterArrayOutput

func (ClusterArrayOutput) ToClusterArrayOutputWithContext 

func (o ClusterArrayOutput) ToClusterArrayOutputWithContext(ctx context.Context) ClusterArrayOutput

type ClusterDbClusterIpArray added in v3.6.0 

type ClusterDbClusterIpArray struct {
	// The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit.
	// **NOTE:** If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.
	DbClusterIpArrayName *string `pulumi:"dbClusterIpArrayName"`
	// The method for modifying the IP whitelist. Valid values are `Cover`, `Append`, `Delete`.
	// **NOTE:** There does not recommend setting modifyMode to `Append` or `Delete` and it will bring a potential diff error.
	ModifyMode *string `pulumi:"modifyMode"`
	// List of IP addresses allowed to access all databases of a 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]).
	SecurityIps []string `pulumi:"securityIps"`
}

type ClusterDbClusterIpArrayArgs added in v3.6.0 

type ClusterDbClusterIpArrayArgs struct {
	// The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit.
	// **NOTE:** If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.
	DbClusterIpArrayName pulumi.StringPtrInput `pulumi:"dbClusterIpArrayName"`
	// The method for modifying the IP whitelist. Valid values are `Cover`, `Append`, `Delete`.
	// **NOTE:** There does not recommend setting modifyMode to `Append` or `Delete` and it will bring a potential diff error.
	ModifyMode pulumi.StringPtrInput `pulumi:"modifyMode"`
	// List of IP addresses allowed to access all databases of a 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]).
	SecurityIps pulumi.StringArrayInput `pulumi:"securityIps"`
}

func (ClusterDbClusterIpArrayArgs) ElementType added in v3.6.0 

func (ClusterDbClusterIpArrayArgs) ElementType() reflect.Type

func (ClusterDbClusterIpArrayArgs) ToClusterDbClusterIpArrayOutput added in v3.6.0 

func (i ClusterDbClusterIpArrayArgs) ToClusterDbClusterIpArrayOutput() ClusterDbClusterIpArrayOutput

func (ClusterDbClusterIpArrayArgs) ToClusterDbClusterIpArrayOutputWithContext added in v3.6.0 

func (i ClusterDbClusterIpArrayArgs) ToClusterDbClusterIpArrayOutputWithContext(ctx context.Context) ClusterDbClusterIpArrayOutput

type ClusterDbClusterIpArrayArray added in v3.6.0 

type ClusterDbClusterIpArrayArray []ClusterDbClusterIpArrayInput

func (ClusterDbClusterIpArrayArray) ElementType added in v3.6.0 

func (ClusterDbClusterIpArrayArray) ElementType() reflect.Type

func (ClusterDbClusterIpArrayArray) ToClusterDbClusterIpArrayArrayOutput added in v3.6.0 

func (i ClusterDbClusterIpArrayArray) ToClusterDbClusterIpArrayArrayOutput() ClusterDbClusterIpArrayArrayOutput

func (ClusterDbClusterIpArrayArray) ToClusterDbClusterIpArrayArrayOutputWithContext added in v3.6.0 

func (i ClusterDbClusterIpArrayArray) ToClusterDbClusterIpArrayArrayOutputWithContext(ctx context.Context) ClusterDbClusterIpArrayArrayOutput

type ClusterDbClusterIpArrayArrayInput added in v3.6.0 

type ClusterDbClusterIpArrayArrayInput interface {
	pulumi.Input

	ToClusterDbClusterIpArrayArrayOutput() ClusterDbClusterIpArrayArrayOutput
	ToClusterDbClusterIpArrayArrayOutputWithContext(context.Context) ClusterDbClusterIpArrayArrayOutput
}

ClusterDbClusterIpArrayArrayInput is an input type that accepts ClusterDbClusterIpArrayArray and ClusterDbClusterIpArrayArrayOutput values. You can construct a concrete instance of `ClusterDbClusterIpArrayArrayInput` via: 

ClusterDbClusterIpArrayArray{ ClusterDbClusterIpArrayArgs{...} }

type ClusterDbClusterIpArrayArrayOutput added in v3.6.0 

type ClusterDbClusterIpArrayArrayOutput struct{ *pulumi.OutputState }

func (ClusterDbClusterIpArrayArrayOutput) ElementType added in v3.6.0 

func (ClusterDbClusterIpArrayArrayOutput) ElementType() reflect.Type

func (ClusterDbClusterIpArrayArrayOutput) Index added in v3.6.0 

func (o ClusterDbClusterIpArrayArrayOutput) Index(i pulumi.IntInput) ClusterDbClusterIpArrayOutput

func (ClusterDbClusterIpArrayArrayOutput) ToClusterDbClusterIpArrayArrayOutput added in v3.6.0 

func (o ClusterDbClusterIpArrayArrayOutput) ToClusterDbClusterIpArrayArrayOutput() ClusterDbClusterIpArrayArrayOutput

func (ClusterDbClusterIpArrayArrayOutput) ToClusterDbClusterIpArrayArrayOutputWithContext added in v3.6.0 

func (o ClusterDbClusterIpArrayArrayOutput) ToClusterDbClusterIpArrayArrayOutputWithContext(ctx context.Context) ClusterDbClusterIpArrayArrayOutput

type ClusterDbClusterIpArrayInput added in v3.6.0 

type ClusterDbClusterIpArrayInput interface {
	pulumi.Input

	ToClusterDbClusterIpArrayOutput() ClusterDbClusterIpArrayOutput
	ToClusterDbClusterIpArrayOutputWithContext(context.Context) ClusterDbClusterIpArrayOutput
}

ClusterDbClusterIpArrayInput is an input type that accepts ClusterDbClusterIpArray and ClusterDbClusterIpArrayOutput values. You can construct a concrete instance of `ClusterDbClusterIpArrayInput` via: 

ClusterDbClusterIpArray{ ClusterDbClusterIpArgs{...} }

type ClusterDbClusterIpArrayOutput added in v3.6.0 

type ClusterDbClusterIpArrayOutput struct{ *pulumi.OutputState }

func (ClusterDbClusterIpArrayOutput) DbClusterIpArrayName added in v3.6.0 

func (o ClusterDbClusterIpArrayOutput) DbClusterIpArrayName() pulumi.StringPtrOutput

The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. **NOTE:** If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.

func (ClusterDbClusterIpArrayOutput) ElementType added in v3.6.0 

func (ClusterDbClusterIpArrayOutput) ElementType() reflect.Type

func (ClusterDbClusterIpArrayOutput) ModifyMode added in v3.6.0 

func (o ClusterDbClusterIpArrayOutput) ModifyMode() pulumi.StringPtrOutput

The method for modifying the IP whitelist. Valid values are `Cover`, `Append`, `Delete`. **NOTE:** There does not recommend setting modifyMode to `Append` or `Delete` and it will bring a potential diff error.

func (ClusterDbClusterIpArrayOutput) SecurityIps added in v3.6.0 

func (o ClusterDbClusterIpArrayOutput) SecurityIps() pulumi.StringArrayOutput

List of IP addresses allowed to access all databases of a 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]).

func (ClusterDbClusterIpArrayOutput) ToClusterDbClusterIpArrayOutput added in v3.6.0 

func (o ClusterDbClusterIpArrayOutput) ToClusterDbClusterIpArrayOutput() ClusterDbClusterIpArrayOutput

func (ClusterDbClusterIpArrayOutput) ToClusterDbClusterIpArrayOutputWithContext added in v3.6.0 

func (o ClusterDbClusterIpArrayOutput) ToClusterDbClusterIpArrayOutputWithContext(ctx context.Context) ClusterDbClusterIpArrayOutput

type ClusterDbRevisionVersionList added in v3.48.0 

type ClusterDbRevisionVersionList struct {
	// (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
	ReleaseNote *string `pulumi:"releaseNote"`
	// (Available since v1.216.0) Database version release status. Valid values are `Stable`, `Old`, `HighRisk`.
	ReleaseType *string `pulumi:"releaseType"`
	// (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
	RevisionVersionCode *string `pulumi:"revisionVersionCode"`
	// (Available since v1.216.0) The revision version number of the database engine.
	RevisionVersionName *string `pulumi:"revisionVersionName"`
}

type ClusterDbRevisionVersionListArgs added in v3.48.0 

type ClusterDbRevisionVersionListArgs struct {
	// (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
	ReleaseNote pulumi.StringPtrInput `pulumi:"releaseNote"`
	// (Available since v1.216.0) Database version release status. Valid values are `Stable`, `Old`, `HighRisk`.
	ReleaseType pulumi.StringPtrInput `pulumi:"releaseType"`
	// (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
	RevisionVersionCode pulumi.StringPtrInput `pulumi:"revisionVersionCode"`
	// (Available since v1.216.0) The revision version number of the database engine.
	RevisionVersionName pulumi.StringPtrInput `pulumi:"revisionVersionName"`
}

func (ClusterDbRevisionVersionListArgs) ElementType added in v3.48.0 

func (ClusterDbRevisionVersionListArgs) ElementType() reflect.Type

func (ClusterDbRevisionVersionListArgs) ToClusterDbRevisionVersionListOutput added in v3.48.0 

func (i ClusterDbRevisionVersionListArgs) ToClusterDbRevisionVersionListOutput() ClusterDbRevisionVersionListOutput

func (ClusterDbRevisionVersionListArgs) ToClusterDbRevisionVersionListOutputWithContext added in v3.48.0 

func (i ClusterDbRevisionVersionListArgs) ToClusterDbRevisionVersionListOutputWithContext(ctx context.Context) ClusterDbRevisionVersionListOutput

type ClusterDbRevisionVersionListArray added in v3.48.0 

type ClusterDbRevisionVersionListArray []ClusterDbRevisionVersionListInput

func (ClusterDbRevisionVersionListArray) ElementType added in v3.48.0 

func (ClusterDbRevisionVersionListArray) ElementType() reflect.Type

func (ClusterDbRevisionVersionListArray) ToClusterDbRevisionVersionListArrayOutput added in v3.48.0 

func (i ClusterDbRevisionVersionListArray) ToClusterDbRevisionVersionListArrayOutput() ClusterDbRevisionVersionListArrayOutput

func (ClusterDbRevisionVersionListArray) ToClusterDbRevisionVersionListArrayOutputWithContext added in v3.48.0 

func (i ClusterDbRevisionVersionListArray) ToClusterDbRevisionVersionListArrayOutputWithContext(ctx context.Context) ClusterDbRevisionVersionListArrayOutput

type ClusterDbRevisionVersionListArrayInput added in v3.48.0 

type ClusterDbRevisionVersionListArrayInput interface {
	pulumi.Input

	ToClusterDbRevisionVersionListArrayOutput() ClusterDbRevisionVersionListArrayOutput
	ToClusterDbRevisionVersionListArrayOutputWithContext(context.Context) ClusterDbRevisionVersionListArrayOutput
}

ClusterDbRevisionVersionListArrayInput is an input type that accepts ClusterDbRevisionVersionListArray and ClusterDbRevisionVersionListArrayOutput values. You can construct a concrete instance of `ClusterDbRevisionVersionListArrayInput` via: 

ClusterDbRevisionVersionListArray{ ClusterDbRevisionVersionListArgs{...} }

type ClusterDbRevisionVersionListArrayOutput added in v3.48.0 

type ClusterDbRevisionVersionListArrayOutput struct{ *pulumi.OutputState }

func (ClusterDbRevisionVersionListArrayOutput) ElementType added in v3.48.0 

func (ClusterDbRevisionVersionListArrayOutput) ElementType() reflect.Type

func (ClusterDbRevisionVersionListArrayOutput) Index added in v3.48.0 

func (o ClusterDbRevisionVersionListArrayOutput) Index(i pulumi.IntInput) ClusterDbRevisionVersionListOutput

func (ClusterDbRevisionVersionListArrayOutput) ToClusterDbRevisionVersionListArrayOutput added in v3.48.0 

func (o ClusterDbRevisionVersionListArrayOutput) ToClusterDbRevisionVersionListArrayOutput() ClusterDbRevisionVersionListArrayOutput

func (ClusterDbRevisionVersionListArrayOutput) ToClusterDbRevisionVersionListArrayOutputWithContext added in v3.48.0 

func (o ClusterDbRevisionVersionListArrayOutput) ToClusterDbRevisionVersionListArrayOutputWithContext(ctx context.Context) ClusterDbRevisionVersionListArrayOutput

type ClusterDbRevisionVersionListInput added in v3.48.0 

type ClusterDbRevisionVersionListInput interface {
	pulumi.Input

	ToClusterDbRevisionVersionListOutput() ClusterDbRevisionVersionListOutput
	ToClusterDbRevisionVersionListOutputWithContext(context.Context) ClusterDbRevisionVersionListOutput
}

ClusterDbRevisionVersionListInput is an input type that accepts ClusterDbRevisionVersionListArgs and ClusterDbRevisionVersionListOutput values. You can construct a concrete instance of `ClusterDbRevisionVersionListInput` via: 

ClusterDbRevisionVersionListArgs{...}

type ClusterDbRevisionVersionListOutput added in v3.48.0 

type ClusterDbRevisionVersionListOutput struct{ *pulumi.OutputState }

func (ClusterDbRevisionVersionListOutput) ElementType added in v3.48.0 

func (ClusterDbRevisionVersionListOutput) ElementType() reflect.Type

func (ClusterDbRevisionVersionListOutput) ReleaseNote added in v3.48.0 

func (o ClusterDbRevisionVersionListOutput) ReleaseNote() pulumi.StringPtrOutput

(Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.

func (ClusterDbRevisionVersionListOutput) ReleaseType added in v3.48.0 

func (o ClusterDbRevisionVersionListOutput) ReleaseType() pulumi.StringPtrOutput

(Available since v1.216.0) Database version release status. Valid values are `Stable`, `Old`, `HighRisk`.

func (ClusterDbRevisionVersionListOutput) RevisionVersionCode added in v3.48.0 

func (o ClusterDbRevisionVersionListOutput) RevisionVersionCode() pulumi.StringPtrOutput

(Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.

func (ClusterDbRevisionVersionListOutput) RevisionVersionName added in v3.48.0 

func (o ClusterDbRevisionVersionListOutput) RevisionVersionName() pulumi.StringPtrOutput

(Available since v1.216.0) The revision version number of the database engine.

func (ClusterDbRevisionVersionListOutput) ToClusterDbRevisionVersionListOutput added in v3.48.0 

func (o ClusterDbRevisionVersionListOutput) ToClusterDbRevisionVersionListOutput() ClusterDbRevisionVersionListOutput

func (ClusterDbRevisionVersionListOutput) ToClusterDbRevisionVersionListOutputWithContext added in v3.48.0 

func (o ClusterDbRevisionVersionListOutput) ToClusterDbRevisionVersionListOutputWithContext(ctx context.Context) ClusterDbRevisionVersionListOutput

type ClusterEndpoint added in v3.49.0 

type ClusterEndpoint struct {
	pulumi.CustomResourceState

	// Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.
	AutoAddNewNodes pulumi.StringOutput `pulumi:"autoAddNewNodes"`
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringOutput `pulumi:"connectionPrefix"`
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrOutput `pulumi:"dbEndpointDescription"`
	// The ID of the cluster endpoint.
	DbEndpointId pulumi.StringOutput `pulumi:"dbEndpointId"`
	// The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the [description of EndpointConfig in the Request parameters table for details](https://www.alibabacloud.com/help/doc-detail/116593.htm).
	EndpointConfig pulumi.MapOutput `pulumi:"endpointConfig"`
	// Type of endpoint.
	EndpointType pulumi.StringOutput `pulumi:"endpointType"`
	// The network type of the endpoint address.
	NetType pulumi.StringPtrOutput `pulumi:"netType"`
	// 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.
	Nodes pulumi.StringArrayOutput `pulumi:"nodes"`
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringOutput `pulumi:"port"`
	// Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.
	ReadWriteMode pulumi.StringOutput `pulumi:"readWriteMode"`
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	// **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm).
	// For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
	SslAutoRotate pulumi.StringPtrOutput `pulumi:"sslAutoRotate"`
	// The specifies SSL certificate download link.
	SslCertificateUrl pulumi.StringOutput `pulumi:"sslCertificateUrl"`
	// The SSL connection string.
	SslConnectionString pulumi.StringOutput `pulumi:"sslConnectionString"`
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrOutput `pulumi:"sslEnabled"`
	// The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	SslExpireTime pulumi.StringOutput `pulumi:"sslExpireTime"`
}

Provides a PolarDB endpoint resource to manage cluster endpoint of PolarDB cluster.

> **NOTE:** Available since v1.217.0

> **NOTE:** The default cluster endpoint can not be created or deleted manually.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
			Category:  pulumi.StringRef("Normal"),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewClusterEndpoint(ctx, "default", &polardb.ClusterEndpointArgs{
			DbClusterId: defaultCluster.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

PolarDB endpoint can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/clusterEndpoint:ClusterEndpoint example pc-abc123456:pe-abc123456 ```

func GetClusterEndpoint added in v3.49.0 

func GetClusterEndpoint(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ClusterEndpointState, opts ...pulumi.ResourceOption) (*ClusterEndpoint, error)

GetClusterEndpoint gets an existing ClusterEndpoint resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClusterEndpoint added in v3.49.0 

func NewClusterEndpoint(ctx *pulumi.Context,
	name string, args *ClusterEndpointArgs, opts ...pulumi.ResourceOption) (*ClusterEndpoint, error)

NewClusterEndpoint registers a new resource with the given unique name, arguments, and options.

func (*ClusterEndpoint) ElementType added in v3.49.0 

func (*ClusterEndpoint) ElementType() reflect.Type

func (*ClusterEndpoint) ToClusterEndpointOutput added in v3.49.0 

func (i *ClusterEndpoint) ToClusterEndpointOutput() ClusterEndpointOutput

func (*ClusterEndpoint) ToClusterEndpointOutputWithContext added in v3.49.0 

func (i *ClusterEndpoint) ToClusterEndpointOutputWithContext(ctx context.Context) ClusterEndpointOutput

type ClusterEndpointArgs added in v3.49.0 

type ClusterEndpointArgs struct {
	// Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.
	AutoAddNewNodes pulumi.StringPtrInput
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringInput
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrInput
	// The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the [description of EndpointConfig in the Request parameters table for details](https://www.alibabacloud.com/help/doc-detail/116593.htm).
	EndpointConfig pulumi.MapInput
	// The network type of the endpoint address.
	NetType pulumi.StringPtrInput
	// 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.
	Nodes pulumi.StringArrayInput
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringPtrInput
	// Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.
	ReadWriteMode pulumi.StringPtrInput
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	// **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm).
	// For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
	SslAutoRotate pulumi.StringPtrInput
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrInput
}

The set of arguments for constructing a ClusterEndpoint resource.

func (ClusterEndpointArgs) ElementType added in v3.49.0 

func (ClusterEndpointArgs) ElementType() reflect.Type

type ClusterEndpointArray added in v3.49.0 

type ClusterEndpointArray []ClusterEndpointInput

func (ClusterEndpointArray) ElementType added in v3.49.0 

func (ClusterEndpointArray) ElementType() reflect.Type

func (ClusterEndpointArray) ToClusterEndpointArrayOutput added in v3.49.0 

func (i ClusterEndpointArray) ToClusterEndpointArrayOutput() ClusterEndpointArrayOutput

func (ClusterEndpointArray) ToClusterEndpointArrayOutputWithContext added in v3.49.0 

func (i ClusterEndpointArray) ToClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterEndpointArrayOutput

type ClusterEndpointArrayInput added in v3.49.0 

type ClusterEndpointArrayInput interface {
	pulumi.Input

	ToClusterEndpointArrayOutput() ClusterEndpointArrayOutput
	ToClusterEndpointArrayOutputWithContext(context.Context) ClusterEndpointArrayOutput
}

ClusterEndpointArrayInput is an input type that accepts ClusterEndpointArray and ClusterEndpointArrayOutput values. You can construct a concrete instance of `ClusterEndpointArrayInput` via: 

ClusterEndpointArray{ ClusterEndpointArgs{...} }

type ClusterEndpointArrayOutput added in v3.49.0 

type ClusterEndpointArrayOutput struct{ *pulumi.OutputState }

func (ClusterEndpointArrayOutput) ElementType added in v3.49.0 

func (ClusterEndpointArrayOutput) ElementType() reflect.Type

func (ClusterEndpointArrayOutput) Index added in v3.49.0 

func (o ClusterEndpointArrayOutput) Index(i pulumi.IntInput) ClusterEndpointOutput

func (ClusterEndpointArrayOutput) ToClusterEndpointArrayOutput added in v3.49.0 

func (o ClusterEndpointArrayOutput) ToClusterEndpointArrayOutput() ClusterEndpointArrayOutput

func (ClusterEndpointArrayOutput) ToClusterEndpointArrayOutputWithContext added in v3.49.0 

func (o ClusterEndpointArrayOutput) ToClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterEndpointArrayOutput

type ClusterEndpointInput added in v3.49.0 

type ClusterEndpointInput interface {
	pulumi.Input

	ToClusterEndpointOutput() ClusterEndpointOutput
	ToClusterEndpointOutputWithContext(ctx context.Context) ClusterEndpointOutput
}

type ClusterEndpointMap added in v3.49.0 

type ClusterEndpointMap map[string]ClusterEndpointInput

func (ClusterEndpointMap) ElementType added in v3.49.0 

func (ClusterEndpointMap) ElementType() reflect.Type

func (ClusterEndpointMap) ToClusterEndpointMapOutput added in v3.49.0 

func (i ClusterEndpointMap) ToClusterEndpointMapOutput() ClusterEndpointMapOutput

func (ClusterEndpointMap) ToClusterEndpointMapOutputWithContext added in v3.49.0 

func (i ClusterEndpointMap) ToClusterEndpointMapOutputWithContext(ctx context.Context) ClusterEndpointMapOutput

type ClusterEndpointMapInput added in v3.49.0 

type ClusterEndpointMapInput interface {
	pulumi.Input

	ToClusterEndpointMapOutput() ClusterEndpointMapOutput
	ToClusterEndpointMapOutputWithContext(context.Context) ClusterEndpointMapOutput
}

ClusterEndpointMapInput is an input type that accepts ClusterEndpointMap and ClusterEndpointMapOutput values. You can construct a concrete instance of `ClusterEndpointMapInput` via: 

ClusterEndpointMap{ "key": ClusterEndpointArgs{...} }

type ClusterEndpointMapOutput added in v3.49.0 

type ClusterEndpointMapOutput struct{ *pulumi.OutputState }

func (ClusterEndpointMapOutput) ElementType added in v3.49.0 

func (ClusterEndpointMapOutput) ElementType() reflect.Type

func (ClusterEndpointMapOutput) MapIndex added in v3.49.0 

func (o ClusterEndpointMapOutput) MapIndex(k pulumi.StringInput) ClusterEndpointOutput

func (ClusterEndpointMapOutput) ToClusterEndpointMapOutput added in v3.49.0 

func (o ClusterEndpointMapOutput) ToClusterEndpointMapOutput() ClusterEndpointMapOutput

func (ClusterEndpointMapOutput) ToClusterEndpointMapOutputWithContext added in v3.49.0 

func (o ClusterEndpointMapOutput) ToClusterEndpointMapOutputWithContext(ctx context.Context) ClusterEndpointMapOutput

type ClusterEndpointOutput added in v3.49.0 

type ClusterEndpointOutput struct{ *pulumi.OutputState }

func (ClusterEndpointOutput) AutoAddNewNodes added in v3.49.0 

func (o ClusterEndpointOutput) AutoAddNewNodes() pulumi.StringOutput

Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.

func (ClusterEndpointOutput) ConnectionPrefix added in v3.49.0 

func (o ClusterEndpointOutput) ConnectionPrefix() pulumi.StringOutput

Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.

func (ClusterEndpointOutput) DbClusterId added in v3.49.0 

func (o ClusterEndpointOutput) DbClusterId() pulumi.StringOutput

The Id of cluster that can run database.

func (ClusterEndpointOutput) DbEndpointDescription added in v3.49.0 

func (o ClusterEndpointOutput) DbEndpointDescription() pulumi.StringPtrOutput

The name of the endpoint.

func (ClusterEndpointOutput) DbEndpointId added in v3.49.0 

func (o ClusterEndpointOutput) DbEndpointId() pulumi.StringOutput

The ID of the cluster endpoint.

func (ClusterEndpointOutput) ElementType added in v3.49.0 

func (ClusterEndpointOutput) ElementType() reflect.Type

func (ClusterEndpointOutput) EndpointConfig added in v3.49.0 

func (o ClusterEndpointOutput) EndpointConfig() pulumi.MapOutput

The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the [description of EndpointConfig in the Request parameters table for details](https://www.alibabacloud.com/help/doc-detail/116593.htm).

func (ClusterEndpointOutput) EndpointType added in v3.49.0 

func (o ClusterEndpointOutput) EndpointType() pulumi.StringOutput

Type of endpoint.

func (ClusterEndpointOutput) NetType added in v3.49.0 

func (o ClusterEndpointOutput) NetType() pulumi.StringPtrOutput

The network type of the endpoint address.

func (ClusterEndpointOutput) Nodes added in v3.49.0 

func (o ClusterEndpointOutput) Nodes() pulumi.StringArrayOutput

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.

func (ClusterEndpointOutput) Port added in v3.49.0 

func (o ClusterEndpointOutput) Port() pulumi.StringOutput

Port of the specified endpoint. Valid values: 3000 to 5999.

func (ClusterEndpointOutput) ReadWriteMode added in v3.49.0 

func (o ClusterEndpointOutput) ReadWriteMode() pulumi.StringOutput

Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.

func (ClusterEndpointOutput) SslAutoRotate added in v3.49.0 

func (o ClusterEndpointOutput) SslAutoRotate() pulumi.StringPtrOutput

Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`. **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm). For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.

func (ClusterEndpointOutput) SslCertificateUrl added in v3.49.0 

func (o ClusterEndpointOutput) SslCertificateUrl() pulumi.StringOutput

The specifies SSL certificate download link.

func (ClusterEndpointOutput) SslConnectionString added in v3.49.0 

func (o ClusterEndpointOutput) SslConnectionString() pulumi.StringOutput

The SSL connection string.

func (ClusterEndpointOutput) SslEnabled added in v3.49.0 

func (o ClusterEndpointOutput) SslEnabled() pulumi.StringPtrOutput

Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.

func (ClusterEndpointOutput) SslExpireTime added in v3.49.0 

func (o ClusterEndpointOutput) SslExpireTime() pulumi.StringOutput

The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

func (ClusterEndpointOutput) ToClusterEndpointOutput added in v3.49.0 

func (o ClusterEndpointOutput) ToClusterEndpointOutput() ClusterEndpointOutput

func (ClusterEndpointOutput) ToClusterEndpointOutputWithContext added in v3.49.0 

func (o ClusterEndpointOutput) ToClusterEndpointOutputWithContext(ctx context.Context) ClusterEndpointOutput

type ClusterEndpointState added in v3.49.0 

type ClusterEndpointState struct {
	// Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.
	AutoAddNewNodes pulumi.StringPtrInput
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringPtrInput
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrInput
	// The ID of the cluster endpoint.
	DbEndpointId pulumi.StringPtrInput
	// The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the [description of EndpointConfig in the Request parameters table for details](https://www.alibabacloud.com/help/doc-detail/116593.htm).
	EndpointConfig pulumi.MapInput
	// Type of endpoint.
	EndpointType pulumi.StringPtrInput
	// The network type of the endpoint address.
	NetType pulumi.StringPtrInput
	// 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.
	Nodes pulumi.StringArrayInput
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringPtrInput
	// Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.
	ReadWriteMode pulumi.StringPtrInput
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	// **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm).
	// For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
	SslAutoRotate pulumi.StringPtrInput
	// The specifies SSL certificate download link.
	SslCertificateUrl pulumi.StringPtrInput
	// The SSL connection string.
	SslConnectionString pulumi.StringPtrInput
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrInput
	// The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	SslExpireTime pulumi.StringPtrInput
}

func (ClusterEndpointState) ElementType added in v3.49.0 

func (ClusterEndpointState) ElementType() reflect.Type

type ClusterInput 

type ClusterInput interface {
	pulumi.Input

	ToClusterOutput() ClusterOutput
	ToClusterOutputWithContext(ctx context.Context) ClusterOutput
}

type ClusterMap 

type ClusterMap map[string]ClusterInput

func (ClusterMap) ElementType 

func (ClusterMap) ElementType() reflect.Type

func (ClusterMap) ToClusterMapOutput 

func (i ClusterMap) ToClusterMapOutput() ClusterMapOutput

func (ClusterMap) ToClusterMapOutputWithContext 

func (i ClusterMap) ToClusterMapOutputWithContext(ctx context.Context) ClusterMapOutput

type ClusterMapInput 

type ClusterMapInput interface {
	pulumi.Input

	ToClusterMapOutput() ClusterMapOutput
	ToClusterMapOutputWithContext(context.Context) ClusterMapOutput
}

ClusterMapInput is an input type that accepts ClusterMap and ClusterMapOutput values. You can construct a concrete instance of `ClusterMapInput` via: 

ClusterMap{ "key": ClusterArgs{...} }

type ClusterMapOutput 

type ClusterMapOutput struct{ *pulumi.OutputState }

func (ClusterMapOutput) ElementType 

func (ClusterMapOutput) ElementType() reflect.Type

func (ClusterMapOutput) MapIndex 

func (o ClusterMapOutput) MapIndex(k pulumi.StringInput) ClusterOutput

func (ClusterMapOutput) ToClusterMapOutput 

func (o ClusterMapOutput) ToClusterMapOutput() ClusterMapOutput

func (ClusterMapOutput) ToClusterMapOutputWithContext 

func (o ClusterMapOutput) ToClusterMapOutputWithContext(ctx context.Context) ClusterMapOutput

type ClusterOutput 

type ClusterOutput struct{ *pulumi.OutputState }

func (ClusterOutput) AllowShutDown added in v3.37.0 

func (o ClusterOutput) AllowShutDown() pulumi.StringPtrOutput

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are `true`, `false`. This parameter is valid only for serverless clusters.

func (ClusterOutput) AutoRenewPeriod added in v3.27.0 

func (o ClusterOutput) AutoRenewPeriod() pulumi.IntPtrOutput

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.

func (ClusterOutput) BackupRetentionPolicyOnClusterDeletion added in v3.27.0 

func (o ClusterOutput) BackupRetentionPolicyOnClusterDeletion() pulumi.StringOutput

The retention policy for the backup sets when you delete the cluster. Valid values are `ALL`, `LATEST`, `NONE`. Value options can refer to the latest docs [DeleteDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/deletedbcluster-1)

func (ClusterOutput) CloneDataPoint added in v3.27.0 

func (o ClusterOutput) CloneDataPoint() pulumi.StringPtrOutput

The time point of data to be cloned. Valid values are `LATEST`,`BackupID`,`Timestamp`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CloneDataPoint`. > **NOTE:** If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

func (ClusterOutput) CollectorStatus added in v3.27.0 

func (o ClusterOutput) CollectorStatus() pulumi.StringOutput

Specifies whether to enable or disable SQL data collector. Valid values are `Enable`, `Disabled`.

func (ClusterOutput) ConnectionString added in v3.27.0 

func (o ClusterOutput) ConnectionString() pulumi.StringOutput

(Available since 1.81.0) PolarDB cluster connection string.

func (ClusterOutput) CreateTime added in v3.37.0 

func (o ClusterOutput) CreateTime() pulumi.StringOutput

(Available since 1.204.1) PolarDB cluster creation time.

func (ClusterOutput) CreationCategory added in v3.27.0 

func (o ClusterOutput) CreationCategory() pulumi.StringOutput

The edition of the PolarDB service. Valid values are `Normal`,`Basic`,`ArchiveNormal`,`NormalMultimaster`,`SENormal`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CreationCategory`. > **NOTE:** You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, `creationCategory` can be set to `NormalMultimaster`. From version 1.203.0, `creationCategory` can be set to `SENormal`.

func (ClusterOutput) CreationOption added in v3.27.0 

func (o ClusterOutput) CreationOption() pulumi.StringOutput

The method that is used to create a cluster. Valid values are `Normal`,`CloneFromPolarDB`,`CloneFromRDS`,`MigrationFromRDS`,`CreateGdnStandby`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CreationOption`. > **NOTE:** The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

func (ClusterOutput) DbClusterIpArrays added in v3.27.0 

func (o ClusterOutput) DbClusterIpArrays() ClusterDbClusterIpArrayArrayOutput

db_cluster_ip_array defines how users can send requests to your API. See `dbClusterIpArray` below.

func (ClusterOutput) DbNodeClass added in v3.27.0 

func (o ClusterOutput) DbNodeClass() pulumi.StringOutput

The dbNodeClass of cluster node. > **NOTE:** Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, `dbNodeClass` can be set to `polar.mysql.sl.small`.

func (ClusterOutput) DbNodeCount added in v3.27.0 

func (o ClusterOutput) DbNodeCount() pulumi.IntOutput

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16]. > **NOTE:** To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

func (ClusterOutput) DbNodeId added in v3.44.1 

func (o ClusterOutput) DbNodeId() pulumi.StringPtrOutput

The ID of the node or node subscript. Node subscript values: 1 to 15.

func (ClusterOutput) DbNodeNum added in v3.44.0 

func (o ClusterOutput) DbNodeNum() pulumi.IntPtrOutput

The number of Standard Edition nodes. Default value: `1`. Valid values are `1`, `2`.

func (ClusterOutput) DbRevisionVersionLists added in v3.48.0 

func (o ClusterOutput) DbRevisionVersionLists() ClusterDbRevisionVersionListArrayOutput

(Available since v1.216.0) The dbRevisionVersionList supports the following:

func (ClusterOutput) DbType added in v3.27.0 

func (o ClusterOutput) DbType() pulumi.StringOutput

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

func (ClusterOutput) DbVersion added in v3.27.0 

func (o ClusterOutput) DbVersion() pulumi.StringOutput

Database version. Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `DBVersion`.

func (ClusterOutput) DefaultTimeZone added in v3.44.0 

func (o ClusterOutput) DefaultTimeZone() pulumi.StringOutput

The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region. > **NOTE:** This parameter is valid only when the DBType parameter is set to MySQL.

func (ClusterOutput) DeletionLock added in v3.27.0 

func (o ClusterOutput) DeletionLock() pulumi.IntPtrOutput

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock > **NOTE:** Cannot modify after created when `payType` is `Prepaid` .`deletionLock` the cluster protection lock can be turned on or off when `payType` is `Postpaid`.

func (ClusterOutput) Description added in v3.27.0 

func (o ClusterOutput) Description() pulumi.StringOutput

The description of cluster.

func (ClusterOutput) ElementType 

func (ClusterOutput) ElementType() reflect.Type

func (ClusterOutput) EncryptNewTables added in v3.27.0 

func (o ClusterOutput) EncryptNewTables() pulumi.StringPtrOutput

turn on table auto encryption. Valid values are `ON`, `OFF`. Only MySQL 8.0 supports. > **NOTE:** `encryptNewTables` Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

func (ClusterOutput) EncryptionKey added in v3.33.0 

func (o ClusterOutput) EncryptionKey() pulumi.StringPtrOutput

The ID of the custom key. `encryptionKey` cannot be modified after TDE is opened.

func (ClusterOutput) FromTimeService added in v3.42.0 

func (o ClusterOutput) FromTimeService() pulumi.StringPtrOutput

Immediate or scheduled kernel version upgrade. Valid values are `true`, `false`. True means immediate execution, False means scheduled execution.

func (ClusterOutput) GdnId added in v3.27.0 

func (o ClusterOutput) GdnId() pulumi.StringPtrOutput

The ID of the global database network (GDN). > **NOTE:** This parameter is required if CreationOption is set to CreateGdnStandby.

func (ClusterOutput) HotReplicaMode added in v3.44.1 

func (o ClusterOutput) HotReplicaMode() pulumi.StringOutput

Indicates whether the hot standby feature is enabled. Valid values are `ON`, `OFF`. Only MySQL supports.

func (ClusterOutput) HotStandbyCluster added in v3.36.0 

func (o ClusterOutput) HotStandbyCluster() pulumi.StringOutput

Whether to enable the hot standby cluster. Valid values are `ON`, `OFF`. Only MySQL supports.

func (ClusterOutput) ImciSwitch added in v3.27.0 

func (o ClusterOutput) ImciSwitch() pulumi.StringOutput

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are `ON`, `OFF`. > **NOTE:** Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. **NOTE:** The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

func (ClusterOutput) LoosePolarLogBin added in v3.44.0 

func (o ClusterOutput) LoosePolarLogBin() pulumi.StringOutput

Enable the Binlog function. Default value: `OFF`. Valid values are `OFF`, `ON`. > **NOTE:** This parameter is valid only MySQL Engine supports.

func (ClusterOutput) LowerCaseTableNames added in v3.44.0 

func (o ClusterOutput) LowerCaseTableNames() pulumi.IntOutput

Specifies whether the table names are case-sensitive. Default value: `1`. Valid values are `1`, `0`. > **NOTE:** This parameter is valid only when the DBType parameter is set to MySQL.

func (ClusterOutput) MaintainTime added in v3.27.0 

func (o ClusterOutput) MaintainTime() pulumi.StringOutput

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

func (ClusterOutput) ModifyType added in v3.27.0 

func (o ClusterOutput) ModifyType() pulumi.StringPtrOutput

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

func (ClusterOutput) ParameterGroupId added in v3.44.0 

func (o ClusterOutput) ParameterGroupId() pulumi.StringPtrOutput

The ID of the parameter template > **NOTE:** You can call the [DescribeParameterGroups](https://www.alibabacloud.com/help/en/polardb/latest/describeparametergroups) operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.

func (ClusterOutput) Parameters added in v3.27.0 

func (o ClusterOutput) Parameters() ClusterParameterArrayOutput

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs [View database parameter templates](https://www.alibabacloud.com/help/en/polardb/latest/modifydbclusterparameters) .See `parameters` below.

func (ClusterOutput) PayType added in v3.27.0 

func (o ClusterOutput) PayType() pulumi.StringPtrOutput

Valid values are `PrePaid`, `PostPaid`, Default to `PostPaid`.

func (ClusterOutput) Period added in v3.27.0 

func (o ClusterOutput) Period() pulumi.IntPtrOutput

The duration that you will buy DB cluster (in month). It is valid when payType is `PrePaid`. Valid values: [1~9], 12, 24, 36. > **NOTE:** The attribute `period` is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running `pulumi up` will not effect the resource.

func (ClusterOutput) PlannedEndTime added in v3.42.0 

func (o ClusterOutput) PlannedEndTime() pulumi.StringPtrOutput

The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC). > **NOTE:** The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.

func (ClusterOutput) PlannedStartTime added in v3.42.0 

func (o ClusterOutput) PlannedStartTime() pulumi.StringPtrOutput

The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC). > **NOTE:** The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.

func (ClusterOutput) Port added in v3.29.0 

func (o ClusterOutput) Port() pulumi.StringOutput

(Available since 1.196.0) PolarDB cluster connection port.

func (ClusterOutput) ProxyClass added in v3.44.0 

func (o ClusterOutput) ProxyClass() pulumi.StringPtrOutput

The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `ProxyType` > **NOTE:** This parameter is valid only for standard clusters.

func (ClusterOutput) ProxyType added in v3.44.0 

func (o ClusterOutput) ProxyType() pulumi.StringPtrOutput

The type of PolarProxy. Default value: `OFF`. Valid values are `OFF`, `EXCLUSIVE` `GENERAL`. > **NOTE:** This parameter is valid only for standard clusters.

func (ClusterOutput) RenewalStatus added in v3.27.0 

func (o ClusterOutput) RenewalStatus() pulumi.StringPtrOutput

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

func (ClusterOutput) ResourceGroupId added in v3.27.0 

func (o ClusterOutput) ResourceGroupId() pulumi.StringOutput

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

func (ClusterOutput) RoleArn added in v3.33.0 

func (o ClusterOutput) RoleArn() pulumi.StringOutput

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see [RAM role overview](https://www.alibabacloud.com/help/en/resource-access-management/latest/ram-role-overview).

func (ClusterOutput) ScaleApRoNumMax added in v3.44.1 

func (o ClusterOutput) ScaleApRoNumMax() pulumi.IntOutput

Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.

func (ClusterOutput) ScaleApRoNumMin added in v3.44.1 

func (o ClusterOutput) ScaleApRoNumMin() pulumi.IntOutput

Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.

func (ClusterOutput) ScaleMax added in v3.37.0 

func (o ClusterOutput) ScaleMax() pulumi.IntPtrOutput

The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs. It is valid when serverlessType is `AgileServerless`. Valid values: 1 PCU to 8 PCUs.It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.

func (ClusterOutput) ScaleMin added in v3.37.0 

func (o ClusterOutput) ScaleMin() pulumi.IntPtrOutput

The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs. It is valid when serverlessType is `AgileServerless`. Valid values: 1 PCU to 8 PCUs.It is valid when serverlessType is `SteadyServerless`.· This parameter is valid only for serverless clusters.

func (ClusterOutput) ScaleRoNumMax added in v3.37.0 

func (o ClusterOutput) ScaleRoNumMax() pulumi.IntPtrOutput

The maximum number of read-only nodes for scaling. Valid values: 0 to 15. It is valid when serverlessType is `AgileServerless`. Valid values: 0 to 7. It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.

func (ClusterOutput) ScaleRoNumMin added in v3.37.0 

func (o ClusterOutput) ScaleRoNumMin() pulumi.IntPtrOutput

The minimum number of read-only nodes for scaling. Valid values: 0 to 15 . It is valid when serverlessType is `AgileServerless`. Valid values: 0 to 7 .It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.

func (ClusterOutput) SecondsUntilAutoPause added in v3.37.0 

func (o ClusterOutput) SecondsUntilAutoPause() pulumi.IntOutput

The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds. This parameter is valid only for serverless clusters.

func (ClusterOutput) SecurityGroupIds added in v3.27.0 

func (o ClusterOutput) SecurityGroupIds() pulumi.StringArrayOutput

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster. > **NOTE:** Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

func (ClusterOutput) SecurityIps added in v3.27.0 

func (o ClusterOutput) SecurityIps() pulumi.StringArrayOutput

This attribute has been deprecated from v1.130.0 and using `dbClusterIpArray` sub-element `securityIps` instead. Its value is same as `dbClusterIpArray` sub-element `securityIps` value and its dbClusterIpArrayName is "default".

func (ClusterOutput) ServerlessSteadySwitch added in v3.44.1 

func (o ClusterOutput) ServerlessSteadySwitch() pulumi.StringPtrOutput

Serverless steady-state switch. Valid values are `ON`, `OFF`. This parameter is valid only for serverless clusters. > **NOTE:** When serverlessSteadySwitch is `ON` and serverlessType is `SteadyServerless`, parameters `scaleMin`, `scaleMax`, `scaleRoNumMin` and `scaleRoNumMax` are all required.

func (ClusterOutput) ServerlessType added in v3.37.0 

func (o ClusterOutput) ServerlessType() pulumi.StringPtrOutput

The type of the serverless cluster. Valid values `AgileServerless`, `SteadyServerless`. This parameter is valid only for serverless clusters.

func (ClusterOutput) SourceResourceId added in v3.27.0 

func (o ClusterOutput) SourceResourceId() pulumi.StringPtrOutput

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `SourceResourceId`.

func (ClusterOutput) Status added in v3.37.0 

func (o ClusterOutput) Status() pulumi.StringOutput

(Available since 1.204.1) PolarDB cluster status.

func (ClusterOutput) StoragePayType added in v3.44.0 

func (o ClusterOutput) StoragePayType() pulumi.StringOutput

The billing method of the storage. Valid values `Postpaid`, `Prepaid`.

func (ClusterOutput) StorageSpace added in v3.36.0 

func (o ClusterOutput) StorageSpace() pulumi.IntOutput

Storage space charged by space (monthly package). Unit: GB. > **NOTE:** Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when payType are `PrePaid` ,`PostPaid`. **NOTE:** Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when payType is `PrePaid`.

func (ClusterOutput) StorageType added in v3.36.0 

func (o ClusterOutput) StorageType() pulumi.StringOutput

The storage type of the cluster. Enterprise storage type values are `PSL5`, `PSL4`. The standard version storage type values are `ESSDPL1`, `ESSDPL2`, `ESSDPL3`. The standard version only supports MySQL. > **NOTE:** Serverless cluster does not support this parameter.

func (ClusterOutput) SubCategory added in v3.27.0 

func (o ClusterOutput) SubCategory() pulumi.StringOutput

The category of the cluster. Valid values are `Exclusive`, `General`. Only MySQL supports.

func (ClusterOutput) Tags added in v3.27.0 

func (o ClusterOutput) Tags() pulumi.MapOutput

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.

func (ClusterOutput) TargetDbRevisionVersionCode added in v3.48.0 

func (o ClusterOutput) TargetDbRevisionVersionCode() pulumi.StringPtrOutput

The Version Code of the target version, whose parameter values can be obtained from the [DescribeDBClusterVersion](https://www.alibabacloud.com/help/en/polardb/latest/describedbclusterversion) interface.

func (ClusterOutput) TdeRegion added in v3.33.0 

func (o ClusterOutput) TdeRegion() pulumi.StringOutput

(Available since 1.200.0) The region where the TDE key resides. > **NOTE:** TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. **NOTE:** You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

func (ClusterOutput) TdeStatus added in v3.27.0 

func (o ClusterOutput) TdeStatus() pulumi.StringPtrOutput

turn on TDE encryption. Valid values are `Enabled`, `Disabled`. Default to `Disabled`. TDE cannot be closed after it is turned on. > **NOTE:** `tdeStatus` Cannot modify after created when `dbType` is `PostgreSQL` or `Oracle`.`tdeStatus` only support modification from `Disabled` to `Enabled` when `dbType` is `MySQL`.

func (ClusterOutput) ToClusterOutput 

func (o ClusterOutput) ToClusterOutput() ClusterOutput

func (ClusterOutput) ToClusterOutputWithContext 

func (o ClusterOutput) ToClusterOutputWithContext(ctx context.Context) ClusterOutput

func (ClusterOutput) UpgradeType added in v3.42.0 

func (o ClusterOutput) UpgradeType() pulumi.StringPtrOutput

Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.

func (ClusterOutput) VpcId added in v3.29.0 

func (o ClusterOutput) VpcId() pulumi.StringOutput

The id of the VPC.

func (ClusterOutput) VswitchId added in v3.27.0 

func (o ClusterOutput) VswitchId() pulumi.StringPtrOutput

The virtual switch ID to launch DB instances in one VPC. > **NOTE:** If vswitchId is not specified, system will get a vswitch belongs to the user automatically.

func (ClusterOutput) ZoneId added in v3.27.0 

func (o ClusterOutput) ZoneId() pulumi.StringOutput

The Zone to launch the DB cluster. it supports multiple zone.

type ClusterParameter 

type ClusterParameter struct {
	// Kernel parameter name.
	Name string `pulumi:"name"`
	// Kernel parameter value.
	Value string `pulumi:"value"`
}

type ClusterParameterArgs 

type ClusterParameterArgs struct {
	// Kernel parameter name.
	Name pulumi.StringInput `pulumi:"name"`
	// Kernel parameter value.
	Value pulumi.StringInput `pulumi:"value"`
}

func (ClusterParameterArgs) ElementType 

func (ClusterParameterArgs) ElementType() reflect.Type

func (ClusterParameterArgs) ToClusterParameterOutput 

func (i ClusterParameterArgs) ToClusterParameterOutput() ClusterParameterOutput

func (ClusterParameterArgs) ToClusterParameterOutputWithContext 

func (i ClusterParameterArgs) ToClusterParameterOutputWithContext(ctx context.Context) ClusterParameterOutput

type ClusterParameterArray 

type ClusterParameterArray []ClusterParameterInput

func (ClusterParameterArray) ElementType 

func (ClusterParameterArray) ElementType() reflect.Type

func (ClusterParameterArray) ToClusterParameterArrayOutput 

func (i ClusterParameterArray) ToClusterParameterArrayOutput() ClusterParameterArrayOutput

func (ClusterParameterArray) ToClusterParameterArrayOutputWithContext 

func (i ClusterParameterArray) ToClusterParameterArrayOutputWithContext(ctx context.Context) ClusterParameterArrayOutput

type ClusterParameterArrayInput 

type ClusterParameterArrayInput interface {
	pulumi.Input

	ToClusterParameterArrayOutput() ClusterParameterArrayOutput
	ToClusterParameterArrayOutputWithContext(context.Context) ClusterParameterArrayOutput
}

ClusterParameterArrayInput is an input type that accepts ClusterParameterArray and ClusterParameterArrayOutput values. You can construct a concrete instance of `ClusterParameterArrayInput` via: 

ClusterParameterArray{ ClusterParameterArgs{...} }

type ClusterParameterArrayOutput 

type ClusterParameterArrayOutput struct{ *pulumi.OutputState }

func (ClusterParameterArrayOutput) ElementType 

func (ClusterParameterArrayOutput) ElementType() reflect.Type

func (ClusterParameterArrayOutput) Index 

func (o ClusterParameterArrayOutput) Index(i pulumi.IntInput) ClusterParameterOutput

func (ClusterParameterArrayOutput) ToClusterParameterArrayOutput 

func (o ClusterParameterArrayOutput) ToClusterParameterArrayOutput() ClusterParameterArrayOutput

func (ClusterParameterArrayOutput) ToClusterParameterArrayOutputWithContext 

func (o ClusterParameterArrayOutput) ToClusterParameterArrayOutputWithContext(ctx context.Context) ClusterParameterArrayOutput

type ClusterParameterInput 

type ClusterParameterInput interface {
	pulumi.Input

	ToClusterParameterOutput() ClusterParameterOutput
	ToClusterParameterOutputWithContext(context.Context) ClusterParameterOutput
}

ClusterParameterInput is an input type that accepts ClusterParameterArgs and ClusterParameterOutput values. You can construct a concrete instance of `ClusterParameterInput` via: 

ClusterParameterArgs{...}

type ClusterParameterOutput 

type ClusterParameterOutput struct{ *pulumi.OutputState }

func (ClusterParameterOutput) ElementType 

func (ClusterParameterOutput) ElementType() reflect.Type

func (ClusterParameterOutput) Name 

func (o ClusterParameterOutput) Name() pulumi.StringOutput

Kernel parameter name.

func (ClusterParameterOutput) ToClusterParameterOutput 

func (o ClusterParameterOutput) ToClusterParameterOutput() ClusterParameterOutput

func (ClusterParameterOutput) ToClusterParameterOutputWithContext 

func (o ClusterParameterOutput) ToClusterParameterOutputWithContext(ctx context.Context) ClusterParameterOutput

func (ClusterParameterOutput) Value 

func (o ClusterParameterOutput) Value() pulumi.StringOutput

Kernel parameter value.

type ClusterState 

type ClusterState struct {
	// Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are `true`, `false`. This parameter is valid only for serverless clusters.
	AllowShutDown pulumi.StringPtrInput
	// 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.
	AutoRenewPeriod pulumi.IntPtrInput
	// The retention policy for the backup sets when you delete the cluster.  Valid values are `ALL`, `LATEST`, `NONE`. Value options can refer to the latest docs [DeleteDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/deletedbcluster-1)
	BackupRetentionPolicyOnClusterDeletion pulumi.StringPtrInput
	// The time point of data to be cloned. Valid values are `LATEST`,`BackupID`,`Timestamp`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CloneDataPoint`.
	// > **NOTE:** If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
	CloneDataPoint pulumi.StringPtrInput
	// Specifies whether to enable or disable SQL data collector. Valid values are `Enable`, `Disabled`.
	CollectorStatus pulumi.StringPtrInput
	// (Available since 1.81.0) PolarDB cluster connection string.
	ConnectionString pulumi.StringPtrInput
	// (Available since 1.204.1) PolarDB cluster creation time.
	CreateTime pulumi.StringPtrInput
	// The edition of the PolarDB service. Valid values are `Normal`,`Basic`,`ArchiveNormal`,`NormalMultimaster`,`SENormal`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CreationCategory`.
	// > **NOTE:** You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, `creationCategory` can be set to `NormalMultimaster`. From version 1.203.0, `creationCategory` can be set to `SENormal`.
	CreationCategory pulumi.StringPtrInput
	// The method that is used to create a cluster. Valid values are `Normal`,`CloneFromPolarDB`,`CloneFromRDS`,`MigrationFromRDS`,`CreateGdnStandby`.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `CreationOption`.
	// > **NOTE:** The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.
	CreationOption pulumi.StringPtrInput
	// db_cluster_ip_array defines how users can send requests to your API. See `dbClusterIpArray` below.
	DbClusterIpArrays ClusterDbClusterIpArrayArrayInput
	// The dbNodeClass of cluster node.
	// > **NOTE:** Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.
	// From version 1.204.0, If you need to create a Serverless cluster, `dbNodeClass` can be set to `polar.mysql.sl.small`.
	DbNodeClass pulumi.StringPtrInput
	// Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].
	// > **NOTE:** To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.
	DbNodeCount pulumi.IntPtrInput
	// The ID of the node or node subscript. Node subscript values: 1 to 15.
	DbNodeId pulumi.StringPtrInput
	// The number of Standard Edition nodes. Default value: `1`. Valid values are `1`, `2`.
	DbNodeNum pulumi.IntPtrInput
	// (Available since v1.216.0) The dbRevisionVersionList supports the following:
	DbRevisionVersionLists ClusterDbRevisionVersionListArrayInput
	// Database type. Value options: MySQL, Oracle, PostgreSQL.
	DbType pulumi.StringPtrInput
	// Database version. Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `DBVersion`.
	DbVersion pulumi.StringPtrInput
	// The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
	// > **NOTE:** This parameter is valid only when the DBType parameter is set to MySQL.
	DefaultTimeZone pulumi.StringPtrInput
	// turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock
	// > **NOTE:**  Cannot modify after created when `payType` is `Prepaid` .`deletionLock` the cluster protection lock can be turned on or off when `payType` is `Postpaid`.
	DeletionLock pulumi.IntPtrInput
	// The description of cluster.
	Description pulumi.StringPtrInput
	// turn on table auto encryption. Valid values are `ON`, `OFF`. Only MySQL 8.0 supports.
	// > **NOTE:** `encryptNewTables` Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.
	EncryptNewTables pulumi.StringPtrInput
	// The ID of the custom key. `encryptionKey` cannot be modified after TDE is opened.
	EncryptionKey pulumi.StringPtrInput
	// Immediate or scheduled kernel version upgrade. Valid values are `true`, `false`. True means immediate execution, False means scheduled execution.
	FromTimeService pulumi.StringPtrInput
	// The ID of the global database network (GDN).
	// > **NOTE:** This parameter is required if CreationOption is set to CreateGdnStandby.
	GdnId pulumi.StringPtrInput
	// Indicates whether the hot standby feature is enabled. Valid values are `ON`, `OFF`. Only MySQL supports.
	HotReplicaMode pulumi.StringPtrInput
	// Whether to enable the hot standby cluster. Valid values are `ON`, `OFF`. Only MySQL supports.
	HotStandbyCluster pulumi.StringPtrInput
	// Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are `ON`, `OFF`.
	// > **NOTE:**  Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above.
	// **NOTE:**  The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.
	ImciSwitch pulumi.StringPtrInput
	// Enable the Binlog function. Default value: `OFF`. Valid values are `OFF`, `ON`.
	// > **NOTE:** This parameter is valid only MySQL Engine supports.
	LoosePolarLogBin pulumi.StringPtrInput
	// Specifies whether the table names are case-sensitive. Default value: `1`.  Valid values are `1`, `0`.
	// > **NOTE:** This parameter is valid only when the DBType parameter is set to MySQL.
	LowerCaseTableNames pulumi.IntPtrInput
	// Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
	MaintainTime pulumi.StringPtrInput
	// Use as `dbNodeClass` change class, define upgrade or downgrade. Valid values are `Upgrade`, `Downgrade`, Default to `Upgrade`.
	ModifyType pulumi.StringPtrInput
	// The ID of the parameter template
	// > **NOTE:** You can call the [DescribeParameterGroups](https://www.alibabacloud.com/help/en/polardb/latest/describeparametergroups) operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
	ParameterGroupId pulumi.StringPtrInput
	// Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs [View database parameter templates](https://www.alibabacloud.com/help/en/polardb/latest/modifydbclusterparameters) .See `parameters` below.
	Parameters ClusterParameterArrayInput
	// Valid values are `PrePaid`, `PostPaid`, Default to `PostPaid`.
	PayType pulumi.StringPtrInput
	// The duration that you will buy DB cluster (in month). It is valid when payType is `PrePaid`. Valid values: [1~9], 12, 24, 36.
	// > **NOTE:** The attribute `period` is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running `pulumi up` will not effect the resource.
	Period pulumi.IntPtrInput
	// The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
	// > **NOTE:** The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
	PlannedEndTime pulumi.StringPtrInput
	// The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
	// > **NOTE:** The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
	PlannedStartTime pulumi.StringPtrInput
	// (Available since 1.196.0) PolarDB cluster connection port.
	Port pulumi.StringPtrInput
	// The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `ProxyType`
	// > **NOTE:** This parameter is valid only for standard clusters.
	ProxyClass pulumi.StringPtrInput
	// The type of PolarProxy. Default value: `OFF`. Valid values are `OFF`, `EXCLUSIVE` `GENERAL`.
	// > **NOTE:** This parameter is valid only for standard clusters.
	ProxyType pulumi.StringPtrInput
	// Valid values are `AutoRenewal`, `Normal`, `NotRenewal`, Default to `NotRenewal`.
	RenewalStatus pulumi.StringPtrInput
	// The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
	ResourceGroupId pulumi.StringPtrInput
	// The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see [RAM role overview](https://www.alibabacloud.com/help/en/resource-access-management/latest/ram-role-overview).
	RoleArn pulumi.StringPtrInput
	// Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.
	ScaleApRoNumMax pulumi.IntPtrInput
	// Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.
	ScaleApRoNumMin pulumi.IntPtrInput
	// The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs. It is valid when serverlessType is `AgileServerless`. Valid values: 1 PCU to 8 PCUs.It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleMax pulumi.IntPtrInput
	// The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs. It is valid when serverlessType is `AgileServerless`. Valid values: 1 PCU to 8 PCUs.It is valid when serverlessType is `SteadyServerless`.· This parameter is valid only for serverless clusters.
	ScaleMin pulumi.IntPtrInput
	// The maximum number of read-only nodes for scaling. Valid values: 0 to 15. It is valid when serverlessType is `AgileServerless`. Valid values: 0 to 7. It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleRoNumMax pulumi.IntPtrInput
	// The minimum number of read-only nodes for scaling. Valid values: 0 to 15 . It is valid when serverlessType is `AgileServerless`. Valid values: 0 to 7 .It is valid when serverlessType is `SteadyServerless`. This parameter is valid only for serverless clusters.
	ScaleRoNumMin pulumi.IntPtrInput
	// The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds. This parameter is valid only for serverless clusters.
	SecondsUntilAutoPause pulumi.IntPtrInput
	// The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.
	// > **NOTE:** Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.
	SecurityGroupIds pulumi.StringArrayInput
	// This attribute has been deprecated from v1.130.0 and using `dbClusterIpArray` sub-element `securityIps` instead.
	// Its value is same as `dbClusterIpArray` sub-element `securityIps` value and its dbClusterIpArrayName is "default".
	SecurityIps pulumi.StringArrayInput
	// Serverless steady-state switch. Valid values are `ON`, `OFF`. This parameter is valid only for serverless clusters.
	// > **NOTE:** When serverlessSteadySwitch is `ON` and serverlessType is `SteadyServerless`, parameters `scaleMin`, `scaleMax`, `scaleRoNumMin` and `scaleRoNumMax` are all required.
	ServerlessSteadySwitch pulumi.StringPtrInput
	// The type of the serverless cluster. Valid values `AgileServerless`, `SteadyServerless`. This parameter is valid only for serverless clusters.
	ServerlessType pulumi.StringPtrInput
	// The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs [CreateDBCluster](https://www.alibabacloud.com/help/en/polardb/latest/createdbcluster-1) `SourceResourceId`.
	SourceResourceId pulumi.StringPtrInput
	// (Available since 1.204.1) PolarDB cluster status.
	Status pulumi.StringPtrInput
	// The billing method of the storage. Valid values `Postpaid`, `Prepaid`.
	StoragePayType pulumi.StringPtrInput
	// Storage space charged by space (monthly package). Unit: GB.
	// > **NOTE:**  Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when payType are `PrePaid` ,`PostPaid`.
	// **NOTE:**  Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when payType is `PrePaid`.
	StorageSpace pulumi.IntPtrInput
	// The storage type of the cluster. Enterprise storage type values are `PSL5`, `PSL4`. The standard version storage type values are `ESSDPL1`, `ESSDPL2`, `ESSDPL3`. The standard version only supports MySQL.
	// > **NOTE:** Serverless cluster does not support this parameter.
	StorageType pulumi.StringPtrInput
	// The category of the cluster. Valid values are `Exclusive`, `General`. Only MySQL supports.
	SubCategory pulumi.StringPtrInput
	// 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.
	Tags pulumi.MapInput
	// The Version Code of the target version, whose parameter values can be obtained from the [DescribeDBClusterVersion](https://www.alibabacloud.com/help/en/polardb/latest/describedbclusterversion) interface.
	TargetDbRevisionVersionCode pulumi.StringPtrInput
	// (Available since 1.200.0) The region where the TDE key resides.
	// > **NOTE:** TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified.
	// **NOTE:** You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.
	TdeRegion pulumi.StringPtrInput
	// turn on TDE encryption. Valid values are `Enabled`, `Disabled`. Default to `Disabled`. TDE cannot be closed after it is turned on.
	// > **NOTE:** `tdeStatus` Cannot modify after created when `dbType` is `PostgreSQL` or `Oracle`.`tdeStatus` only support modification from `Disabled` to `Enabled` when `dbType` is `MySQL`.
	TdeStatus pulumi.StringPtrInput
	// Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
	UpgradeType pulumi.StringPtrInput
	// The id of the VPC.
	VpcId pulumi.StringPtrInput
	// The virtual switch ID to launch DB instances in one VPC.
	// > **NOTE:** If vswitchId is not specified, system will get a vswitch belongs to the user automatically.
	VswitchId pulumi.StringPtrInput
	// The Zone to launch the DB cluster. it supports multiple zone.
	ZoneId pulumi.StringPtrInput
}

func (ClusterState) ElementType 

func (ClusterState) ElementType() reflect.Type

type Database 

type Database struct {
	pulumi.CustomResourceState

	// Account name authorized to access the database. Only supports PostgreSQL.
	AccountName pulumi.StringPtrOutput `pulumi:"accountName"`
	// 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\).
	CharacterSetName pulumi.StringPtrOutput `pulumi:"characterSetName"`
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// Database description. It must start with a Chinese character or English letter, cannot start with "http://" or "https://". It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length must be 2-256 characters.
	DbDescription pulumi.StringPtrOutput `pulumi:"dbDescription"`
	// 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.
	DbName pulumi.StringOutput `pulumi:"dbName"`
}

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

> **NOTE:** Available since v1.66.0.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
			Category:  pulumi.StringRef("Normal"),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewDatabase(ctx, "default", &polardb.DatabaseArgs{
			DbClusterId: defaultCluster.ID(),
			DbName:      pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

PolarDB database can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/database:Database example "pc-12345:tf_database" ```

func GetDatabase 

func GetDatabase(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DatabaseState, opts ...pulumi.ResourceOption) (*Database, error)

GetDatabase gets an existing Database resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDatabase 

func NewDatabase(ctx *pulumi.Context,
	name string, args *DatabaseArgs, opts ...pulumi.ResourceOption) (*Database, error)

NewDatabase registers a new resource with the given unique name, arguments, and options.

func (*Database) ElementType 

func (*Database) ElementType() reflect.Type

func (*Database) ToDatabaseOutput 

func (i *Database) ToDatabaseOutput() DatabaseOutput

func (*Database) ToDatabaseOutputWithContext 

func (i *Database) ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput

type DatabaseArgs 

type DatabaseArgs struct {
	// Account name authorized to access the database. Only supports PostgreSQL.
	AccountName pulumi.StringPtrInput
	// 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\).
	CharacterSetName pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringInput
	// Database description. It must start with a Chinese character or English letter, cannot start with "http://" or "https://". It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length must be 2-256 characters.
	DbDescription pulumi.StringPtrInput
	// 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.
	DbName pulumi.StringInput
}

The set of arguments for constructing a Database resource.

func (DatabaseArgs) ElementType 

func (DatabaseArgs) ElementType() reflect.Type

type DatabaseArray 

type DatabaseArray []DatabaseInput

func (DatabaseArray) ElementType 

func (DatabaseArray) ElementType() reflect.Type

func (DatabaseArray) ToDatabaseArrayOutput 

func (i DatabaseArray) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArray) ToDatabaseArrayOutputWithContext 

func (i DatabaseArray) ToDatabaseArrayOutputWithContext(ctx context.Context) DatabaseArrayOutput

type DatabaseArrayInput 

type DatabaseArrayInput interface {
	pulumi.Input

	ToDatabaseArrayOutput() DatabaseArrayOutput
	ToDatabaseArrayOutputWithContext(context.Context) DatabaseArrayOutput
}

DatabaseArrayInput is an input type that accepts DatabaseArray and DatabaseArrayOutput values. You can construct a concrete instance of `DatabaseArrayInput` via: 

DatabaseArray{ DatabaseArgs{...} }

type DatabaseArrayOutput 

type DatabaseArrayOutput struct{ *pulumi.OutputState }

func (DatabaseArrayOutput) ElementType 

func (DatabaseArrayOutput) ElementType() reflect.Type

func (DatabaseArrayOutput) Index 

func (o DatabaseArrayOutput) Index(i pulumi.IntInput) DatabaseOutput

func (DatabaseArrayOutput) ToDatabaseArrayOutput 

func (o DatabaseArrayOutput) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArrayOutput) ToDatabaseArrayOutputWithContext 

func (o DatabaseArrayOutput) ToDatabaseArrayOutputWithContext(ctx context.Context) DatabaseArrayOutput

type DatabaseInput 

type DatabaseInput interface {
	pulumi.Input

	ToDatabaseOutput() DatabaseOutput
	ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput
}

type DatabaseMap 

type DatabaseMap map[string]DatabaseInput

func (DatabaseMap) ElementType 

func (DatabaseMap) ElementType() reflect.Type

func (DatabaseMap) ToDatabaseMapOutput 

func (i DatabaseMap) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMap) ToDatabaseMapOutputWithContext 

func (i DatabaseMap) ToDatabaseMapOutputWithContext(ctx context.Context) DatabaseMapOutput

type DatabaseMapInput 

type DatabaseMapInput interface {
	pulumi.Input

	ToDatabaseMapOutput() DatabaseMapOutput
	ToDatabaseMapOutputWithContext(context.Context) DatabaseMapOutput
}

DatabaseMapInput is an input type that accepts DatabaseMap and DatabaseMapOutput values. You can construct a concrete instance of `DatabaseMapInput` via: 

DatabaseMap{ "key": DatabaseArgs{...} }

type DatabaseMapOutput 

type DatabaseMapOutput struct{ *pulumi.OutputState }

func (DatabaseMapOutput) ElementType 

func (DatabaseMapOutput) ElementType() reflect.Type

func (DatabaseMapOutput) MapIndex 

func (o DatabaseMapOutput) MapIndex(k pulumi.StringInput) DatabaseOutput

func (DatabaseMapOutput) ToDatabaseMapOutput 

func (o DatabaseMapOutput) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMapOutput) ToDatabaseMapOutputWithContext 

func (o DatabaseMapOutput) ToDatabaseMapOutputWithContext(ctx context.Context) DatabaseMapOutput

type DatabaseOutput 

type DatabaseOutput struct{ *pulumi.OutputState }

func (DatabaseOutput) AccountName added in v3.47.0 

func (o DatabaseOutput) AccountName() pulumi.StringPtrOutput

Account name authorized to access the database. Only supports PostgreSQL.

func (DatabaseOutput) CharacterSetName added in v3.27.0 

func (o DatabaseOutput) CharacterSetName() pulumi.StringPtrOutput

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

func (DatabaseOutput) DbClusterId added in v3.27.0 

func (o DatabaseOutput) DbClusterId() pulumi.StringOutput

The Id of cluster that can run database.

func (DatabaseOutput) DbDescription added in v3.27.0 

func (o DatabaseOutput) DbDescription() pulumi.StringPtrOutput

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

func (DatabaseOutput) DbName added in v3.27.0 

func (o DatabaseOutput) DbName() pulumi.StringOutput

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.

func (DatabaseOutput) ElementType 

func (DatabaseOutput) ElementType() reflect.Type

func (DatabaseOutput) ToDatabaseOutput 

func (o DatabaseOutput) ToDatabaseOutput() DatabaseOutput

func (DatabaseOutput) ToDatabaseOutputWithContext 

func (o DatabaseOutput) ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput

type DatabaseState 

type DatabaseState struct {
	// Account name authorized to access the database. Only supports PostgreSQL.
	AccountName pulumi.StringPtrInput
	// 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\).
	CharacterSetName pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringPtrInput
	// Database description. It must start with a Chinese character or English letter, cannot start with "http://" or "https://". It can include Chinese and English characters, underlines (_), hyphens (-), and numbers. The length must be 2-256 characters.
	DbDescription pulumi.StringPtrInput
	// 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.
	DbName pulumi.StringPtrInput
}

func (DatabaseState) ElementType 

func (DatabaseState) ElementType() reflect.Type

type Endpoint 

type Endpoint struct {
	pulumi.CustomResourceState

	// Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.
	AutoAddNewNodes pulumi.StringOutput `pulumi:"autoAddNewNodes"`
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringOutput `pulumi:"connectionPrefix"`
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrOutput `pulumi:"dbEndpointDescription"`
	// (Available since v1.161.0) The ID of the cluster endpoint.
	DbEndpointId pulumi.StringOutput `pulumi:"dbEndpointId"`
	// The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the [description of EndpointConfig in the Request parameters table for details](https://www.alibabacloud.com/help/doc-detail/116593.htm).
	EndpointConfig pulumi.MapOutput `pulumi:"endpointConfig"`
	// Type of the endpoint. Before v1.121.0, it only can be `Custom`. since v1.121.0, `Custom`, `Cluster`, `Primary` are valid, default to `Custom`. However when creating a new endpoint, it also only can be `Custom`.
	EndpointType pulumi.StringPtrOutput `pulumi:"endpointType"`
	// The network type of the endpoint address.
	NetType pulumi.StringPtrOutput `pulumi:"netType"`
	// 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.
	Nodes pulumi.StringArrayOutput `pulumi:"nodes"`
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringOutput `pulumi:"port"`
	// Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.
	ReadWriteMode pulumi.StringOutput `pulumi:"readWriteMode"`
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	SslAutoRotate pulumi.StringPtrOutput `pulumi:"sslAutoRotate"`
	// Specifies SSL certificate download link.\
	// **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm).
	// For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
	SslCertificateUrl pulumi.StringOutput `pulumi:"sslCertificateUrl"`
	// (Available since v1.121.0) The SSL connection string.
	SslConnectionString pulumi.StringOutput `pulumi:"sslConnectionString"`
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrOutput `pulumi:"sslEnabled"`
	// (Available since v1.121.0) The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	SslExpireTime pulumi.StringOutput `pulumi:"sslExpireTime"`
}

Provides a PolarDB endpoint resource to manage custom endpoint of PolarDB cluster.

> **NOTE:** Available since v1.80.0. **NOTE:** After v1.80.0 and before v1.121.0, you can only use this resource to manage the custom endpoint. Since v1.121.0, you also can import the primary endpoint and the cluster endpoint, to modify their ssl status and so on. **NOTE:** The primary endpoint and the default cluster endpoint can not be created or deleted manually.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
			Category:  pulumi.StringRef("Normal"),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewEndpoint(ctx, "default", &polardb.EndpointArgs{
			DbClusterId:  defaultCluster.ID(),
			EndpointType: pulumi.String("Custom"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

PolarDB endpoint can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/endpoint:Endpoint example pc-abc123456:pe-abc123456 ```

func GetEndpoint 

func GetEndpoint(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EndpointState, opts ...pulumi.ResourceOption) (*Endpoint, error)

GetEndpoint gets an existing Endpoint resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEndpoint 

func NewEndpoint(ctx *pulumi.Context,
	name string, args *EndpointArgs, opts ...pulumi.ResourceOption) (*Endpoint, error)

NewEndpoint registers a new resource with the given unique name, arguments, and options.

func (*Endpoint) ElementType 

func (*Endpoint) ElementType() reflect.Type

func (*Endpoint) ToEndpointOutput 

func (i *Endpoint) ToEndpointOutput() EndpointOutput

func (*Endpoint) ToEndpointOutputWithContext 

func (i *Endpoint) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput

type EndpointAddress 

type EndpointAddress struct {
	pulumi.CustomResourceState

	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringOutput `pulumi:"connectionPrefix"`
	// Connection cluster or endpoint string.
	ConnectionString pulumi.StringOutput `pulumi:"connectionString"`
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// The Id of endpoint that can run database.
	DbEndpointId pulumi.StringOutput `pulumi:"dbEndpointId"`
	// The ip address of connection string.
	IpAddress pulumi.StringOutput `pulumi:"ipAddress"`
	// Internet connection net type. Valid value: `Public`. Default to `Public`. Currently supported only `Public`.
	NetType pulumi.StringPtrOutput `pulumi:"netType"`
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringOutput `pulumi:"port"`
}

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

> **NOTE:** Available since 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

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
			Category:  pulumi.StringRef("Normal"),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultGetEndpoints := polardb.GetEndpointsOutput(ctx, polardb.GetEndpointsOutputArgs{
			DbClusterId: defaultCluster.ID(),
		}, nil)
		_, err = polardb.NewEndpointAddress(ctx, "default", &polardb.EndpointAddressArgs{
			DbClusterId: defaultCluster.ID(),
			DbEndpointId: defaultGetEndpoints.ApplyT(func(defaultGetEndpoints polardb.GetEndpointsResult) (*string, error) {
				return &defaultGetEndpoints.Endpoints[0].DbEndpointId, nil
			}).(pulumi.StringPtrOutput),
			ConnectionPrefix: pulumi.String("polardbexample"),
			NetType:          pulumi.String("Public"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

PolarDB endpoint address can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/endpointAddress:EndpointAddress example pc-abc123456:pe-abc123456 ```

func GetEndpointAddress 

func GetEndpointAddress(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *EndpointAddressState, opts ...pulumi.ResourceOption) (*EndpointAddress, error)

GetEndpointAddress gets an existing EndpointAddress resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEndpointAddress 

func NewEndpointAddress(ctx *pulumi.Context,
	name string, args *EndpointAddressArgs, opts ...pulumi.ResourceOption) (*EndpointAddress, error)

NewEndpointAddress registers a new resource with the given unique name, arguments, and options.

func (*EndpointAddress) ElementType 

func (*EndpointAddress) ElementType() reflect.Type

func (*EndpointAddress) ToEndpointAddressOutput 

func (i *EndpointAddress) ToEndpointAddressOutput() EndpointAddressOutput

func (*EndpointAddress) ToEndpointAddressOutputWithContext 

func (i *EndpointAddress) ToEndpointAddressOutputWithContext(ctx context.Context) EndpointAddressOutput

type EndpointAddressArgs 

type EndpointAddressArgs struct {
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringInput
	// The Id of endpoint that can run database.
	DbEndpointId pulumi.StringInput
	// Internet connection net type. Valid value: `Public`. Default to `Public`. Currently supported only `Public`.
	NetType pulumi.StringPtrInput
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringPtrInput
}

The set of arguments for constructing a EndpointAddress resource.

func (EndpointAddressArgs) ElementType 

func (EndpointAddressArgs) ElementType() reflect.Type

type EndpointAddressArray 

type EndpointAddressArray []EndpointAddressInput

func (EndpointAddressArray) ElementType 

func (EndpointAddressArray) ElementType() reflect.Type

func (EndpointAddressArray) ToEndpointAddressArrayOutput 

func (i EndpointAddressArray) ToEndpointAddressArrayOutput() EndpointAddressArrayOutput

func (EndpointAddressArray) ToEndpointAddressArrayOutputWithContext 

func (i EndpointAddressArray) ToEndpointAddressArrayOutputWithContext(ctx context.Context) EndpointAddressArrayOutput

type EndpointAddressArrayInput 

type EndpointAddressArrayInput interface {
	pulumi.Input

	ToEndpointAddressArrayOutput() EndpointAddressArrayOutput
	ToEndpointAddressArrayOutputWithContext(context.Context) EndpointAddressArrayOutput
}

EndpointAddressArrayInput is an input type that accepts EndpointAddressArray and EndpointAddressArrayOutput values. You can construct a concrete instance of `EndpointAddressArrayInput` via: 

EndpointAddressArray{ EndpointAddressArgs{...} }

type EndpointAddressArrayOutput 

type EndpointAddressArrayOutput struct{ *pulumi.OutputState }

func (EndpointAddressArrayOutput) ElementType 

func (EndpointAddressArrayOutput) ElementType() reflect.Type

func (EndpointAddressArrayOutput) Index 

func (o EndpointAddressArrayOutput) Index(i pulumi.IntInput) EndpointAddressOutput

func (EndpointAddressArrayOutput) ToEndpointAddressArrayOutput 

func (o EndpointAddressArrayOutput) ToEndpointAddressArrayOutput() EndpointAddressArrayOutput

func (EndpointAddressArrayOutput) ToEndpointAddressArrayOutputWithContext 

func (o EndpointAddressArrayOutput) ToEndpointAddressArrayOutputWithContext(ctx context.Context) EndpointAddressArrayOutput

type EndpointAddressInput 

type EndpointAddressInput interface {
	pulumi.Input

	ToEndpointAddressOutput() EndpointAddressOutput
	ToEndpointAddressOutputWithContext(ctx context.Context) EndpointAddressOutput
}

type EndpointAddressMap 

type EndpointAddressMap map[string]EndpointAddressInput

func (EndpointAddressMap) ElementType 

func (EndpointAddressMap) ElementType() reflect.Type

func (EndpointAddressMap) ToEndpointAddressMapOutput 

func (i EndpointAddressMap) ToEndpointAddressMapOutput() EndpointAddressMapOutput

func (EndpointAddressMap) ToEndpointAddressMapOutputWithContext 

func (i EndpointAddressMap) ToEndpointAddressMapOutputWithContext(ctx context.Context) EndpointAddressMapOutput

type EndpointAddressMapInput 

type EndpointAddressMapInput interface {
	pulumi.Input

	ToEndpointAddressMapOutput() EndpointAddressMapOutput
	ToEndpointAddressMapOutputWithContext(context.Context) EndpointAddressMapOutput
}

EndpointAddressMapInput is an input type that accepts EndpointAddressMap and EndpointAddressMapOutput values. You can construct a concrete instance of `EndpointAddressMapInput` via: 

EndpointAddressMap{ "key": EndpointAddressArgs{...} }

type EndpointAddressMapOutput 

type EndpointAddressMapOutput struct{ *pulumi.OutputState }

func (EndpointAddressMapOutput) ElementType 

func (EndpointAddressMapOutput) ElementType() reflect.Type

func (EndpointAddressMapOutput) MapIndex 

func (o EndpointAddressMapOutput) MapIndex(k pulumi.StringInput) EndpointAddressOutput

func (EndpointAddressMapOutput) ToEndpointAddressMapOutput 

func (o EndpointAddressMapOutput) ToEndpointAddressMapOutput() EndpointAddressMapOutput

func (EndpointAddressMapOutput) ToEndpointAddressMapOutputWithContext 

func (o EndpointAddressMapOutput) ToEndpointAddressMapOutputWithContext(ctx context.Context) EndpointAddressMapOutput

type EndpointAddressOutput 

type EndpointAddressOutput struct{ *pulumi.OutputState }

func (EndpointAddressOutput) ConnectionPrefix added in v3.27.0 

func (o EndpointAddressOutput) ConnectionPrefix() pulumi.StringOutput

Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.

func (EndpointAddressOutput) ConnectionString added in v3.27.0 

func (o EndpointAddressOutput) ConnectionString() pulumi.StringOutput

Connection cluster or endpoint string.

func (EndpointAddressOutput) DbClusterId added in v3.27.0 

func (o EndpointAddressOutput) DbClusterId() pulumi.StringOutput

The Id of cluster that can run database.

func (EndpointAddressOutput) DbEndpointId added in v3.27.0 

func (o EndpointAddressOutput) DbEndpointId() pulumi.StringOutput

The Id of endpoint that can run database.

func (EndpointAddressOutput) ElementType 

func (EndpointAddressOutput) ElementType() reflect.Type

func (EndpointAddressOutput) IpAddress added in v3.27.0 

func (o EndpointAddressOutput) IpAddress() pulumi.StringOutput

The ip address of connection string.

func (EndpointAddressOutput) NetType added in v3.27.0 

func (o EndpointAddressOutput) NetType() pulumi.StringPtrOutput

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

func (EndpointAddressOutput) Port added in v3.27.0 

func (o EndpointAddressOutput) Port() pulumi.StringOutput

Port of the specified endpoint. Valid values: 3000 to 5999.

func (EndpointAddressOutput) ToEndpointAddressOutput 

func (o EndpointAddressOutput) ToEndpointAddressOutput() EndpointAddressOutput

func (EndpointAddressOutput) ToEndpointAddressOutputWithContext 

func (o EndpointAddressOutput) ToEndpointAddressOutputWithContext(ctx context.Context) EndpointAddressOutput

type EndpointAddressState 

type EndpointAddressState struct {
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringPtrInput
	// Connection cluster or endpoint string.
	ConnectionString pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringPtrInput
	// The Id of endpoint that can run database.
	DbEndpointId pulumi.StringPtrInput
	// The ip address of connection string.
	IpAddress pulumi.StringPtrInput
	// Internet connection net type. Valid value: `Public`. Default to `Public`. Currently supported only `Public`.
	NetType pulumi.StringPtrInput
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringPtrInput
}

func (EndpointAddressState) ElementType 

func (EndpointAddressState) ElementType() reflect.Type

type EndpointArgs 

type EndpointArgs struct {
	// Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.
	AutoAddNewNodes pulumi.StringPtrInput
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringInput
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrInput
	// The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the [description of EndpointConfig in the Request parameters table for details](https://www.alibabacloud.com/help/doc-detail/116593.htm).
	EndpointConfig pulumi.MapInput
	// Type of the endpoint. Before v1.121.0, it only can be `Custom`. since v1.121.0, `Custom`, `Cluster`, `Primary` are valid, default to `Custom`. However when creating a new endpoint, it also only can be `Custom`.
	EndpointType pulumi.StringPtrInput
	// The network type of the endpoint address.
	NetType pulumi.StringPtrInput
	// 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.
	Nodes pulumi.StringArrayInput
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringPtrInput
	// Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.
	ReadWriteMode pulumi.StringPtrInput
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	SslAutoRotate pulumi.StringPtrInput
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrInput
}

The set of arguments for constructing a Endpoint resource.

func (EndpointArgs) ElementType 

func (EndpointArgs) ElementType() reflect.Type

type EndpointArray 

type EndpointArray []EndpointInput

func (EndpointArray) ElementType 

func (EndpointArray) ElementType() reflect.Type

func (EndpointArray) ToEndpointArrayOutput 

func (i EndpointArray) ToEndpointArrayOutput() EndpointArrayOutput

func (EndpointArray) ToEndpointArrayOutputWithContext 

func (i EndpointArray) ToEndpointArrayOutputWithContext(ctx context.Context) EndpointArrayOutput

type EndpointArrayInput 

type EndpointArrayInput interface {
	pulumi.Input

	ToEndpointArrayOutput() EndpointArrayOutput
	ToEndpointArrayOutputWithContext(context.Context) EndpointArrayOutput
}

EndpointArrayInput is an input type that accepts EndpointArray and EndpointArrayOutput values. You can construct a concrete instance of `EndpointArrayInput` via: 

EndpointArray{ EndpointArgs{...} }

type EndpointArrayOutput 

type EndpointArrayOutput struct{ *pulumi.OutputState }

func (EndpointArrayOutput) ElementType 

func (EndpointArrayOutput) ElementType() reflect.Type

func (EndpointArrayOutput) Index 

func (o EndpointArrayOutput) Index(i pulumi.IntInput) EndpointOutput

func (EndpointArrayOutput) ToEndpointArrayOutput 

func (o EndpointArrayOutput) ToEndpointArrayOutput() EndpointArrayOutput

func (EndpointArrayOutput) ToEndpointArrayOutputWithContext 

func (o EndpointArrayOutput) ToEndpointArrayOutputWithContext(ctx context.Context) EndpointArrayOutput

type EndpointInput 

type EndpointInput interface {
	pulumi.Input

	ToEndpointOutput() EndpointOutput
	ToEndpointOutputWithContext(ctx context.Context) EndpointOutput
}

type EndpointMap 

type EndpointMap map[string]EndpointInput

func (EndpointMap) ElementType 

func (EndpointMap) ElementType() reflect.Type

func (EndpointMap) ToEndpointMapOutput 

func (i EndpointMap) ToEndpointMapOutput() EndpointMapOutput

func (EndpointMap) ToEndpointMapOutputWithContext 

func (i EndpointMap) ToEndpointMapOutputWithContext(ctx context.Context) EndpointMapOutput

type EndpointMapInput 

type EndpointMapInput interface {
	pulumi.Input

	ToEndpointMapOutput() EndpointMapOutput
	ToEndpointMapOutputWithContext(context.Context) EndpointMapOutput
}

EndpointMapInput is an input type that accepts EndpointMap and EndpointMapOutput values. You can construct a concrete instance of `EndpointMapInput` via: 

EndpointMap{ "key": EndpointArgs{...} }

type EndpointMapOutput 

type EndpointMapOutput struct{ *pulumi.OutputState }

func (EndpointMapOutput) ElementType 

func (EndpointMapOutput) ElementType() reflect.Type

func (EndpointMapOutput) MapIndex 

func (o EndpointMapOutput) MapIndex(k pulumi.StringInput) EndpointOutput

func (EndpointMapOutput) ToEndpointMapOutput 

func (o EndpointMapOutput) ToEndpointMapOutput() EndpointMapOutput

func (EndpointMapOutput) ToEndpointMapOutputWithContext 

func (o EndpointMapOutput) ToEndpointMapOutputWithContext(ctx context.Context) EndpointMapOutput

type EndpointOutput 

type EndpointOutput struct{ *pulumi.OutputState }

func (EndpointOutput) AutoAddNewNodes added in v3.27.0 

func (o EndpointOutput) AutoAddNewNodes() pulumi.StringOutput

Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.

func (EndpointOutput) ConnectionPrefix added in v3.49.0 

func (o EndpointOutput) ConnectionPrefix() pulumi.StringOutput

Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.

func (EndpointOutput) DbClusterId added in v3.27.0 

func (o EndpointOutput) DbClusterId() pulumi.StringOutput

The Id of cluster that can run database.

func (EndpointOutput) DbEndpointDescription added in v3.34.0 

func (o EndpointOutput) DbEndpointDescription() pulumi.StringPtrOutput

The name of the endpoint.

func (EndpointOutput) DbEndpointId added in v3.27.0 

func (o EndpointOutput) DbEndpointId() pulumi.StringOutput

(Available since v1.161.0) The ID of the cluster endpoint.

func (EndpointOutput) ElementType 

func (EndpointOutput) ElementType() reflect.Type

func (EndpointOutput) EndpointConfig added in v3.27.0 

func (o EndpointOutput) EndpointConfig() pulumi.MapOutput

The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the [description of EndpointConfig in the Request parameters table for details](https://www.alibabacloud.com/help/doc-detail/116593.htm).

func (EndpointOutput) EndpointType added in v3.27.0 

func (o EndpointOutput) EndpointType() pulumi.StringPtrOutput

Type of the endpoint. Before v1.121.0, it only can be `Custom`. since v1.121.0, `Custom`, `Cluster`, `Primary` are valid, default to `Custom`. However when creating a new endpoint, it also only can be `Custom`.

func (EndpointOutput) NetType added in v3.27.0 

func (o EndpointOutput) NetType() pulumi.StringPtrOutput

The network type of the endpoint address.

func (EndpointOutput) Nodes added in v3.27.0 

func (o EndpointOutput) Nodes() pulumi.StringArrayOutput

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.

func (EndpointOutput) Port added in v3.49.0 

func (o EndpointOutput) Port() pulumi.StringOutput

Port of the specified endpoint. Valid values: 3000 to 5999.

func (EndpointOutput) ReadWriteMode added in v3.27.0 

func (o EndpointOutput) ReadWriteMode() pulumi.StringOutput

Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.

func (EndpointOutput) SslAutoRotate added in v3.27.0 

func (o EndpointOutput) SslAutoRotate() pulumi.StringPtrOutput

Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.

func (EndpointOutput) SslCertificateUrl added in v3.27.0 

func (o EndpointOutput) SslCertificateUrl() pulumi.StringOutput

Specifies SSL certificate download link.\ **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm). For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.

func (EndpointOutput) SslConnectionString added in v3.27.0 

func (o EndpointOutput) SslConnectionString() pulumi.StringOutput

(Available since v1.121.0) The SSL connection string.

func (EndpointOutput) SslEnabled added in v3.27.0 

func (o EndpointOutput) SslEnabled() pulumi.StringPtrOutput

Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.

func (EndpointOutput) SslExpireTime added in v3.27.0 

func (o EndpointOutput) SslExpireTime() pulumi.StringOutput

(Available since v1.121.0) The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

func (EndpointOutput) ToEndpointOutput 

func (o EndpointOutput) ToEndpointOutput() EndpointOutput

func (EndpointOutput) ToEndpointOutputWithContext 

func (o EndpointOutput) ToEndpointOutputWithContext(ctx context.Context) EndpointOutput

type EndpointState 

type EndpointState struct {
	// Whether the new node automatically joins the default cluster address. Valid values are `Enable`, `Disable`. When creating a new custom endpoint, default to `Disable`.
	AutoAddNewNodes pulumi.StringPtrInput
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringPtrInput
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrInput
	// (Available since v1.161.0) The ID of the cluster endpoint.
	DbEndpointId pulumi.StringPtrInput
	// The advanced settings of the endpoint of Apsara PolarDB clusters are in JSON format. Including the settings of consistency level, transaction splitting, connection pool, and offload reads from primary node. For more details, see the [description of EndpointConfig in the Request parameters table for details](https://www.alibabacloud.com/help/doc-detail/116593.htm).
	EndpointConfig pulumi.MapInput
	// Type of the endpoint. Before v1.121.0, it only can be `Custom`. since v1.121.0, `Custom`, `Cluster`, `Primary` are valid, default to `Custom`. However when creating a new endpoint, it also only can be `Custom`.
	EndpointType pulumi.StringPtrInput
	// The network type of the endpoint address.
	NetType pulumi.StringPtrInput
	// 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.
	Nodes pulumi.StringArrayInput
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringPtrInput
	// Read or write mode. Valid values are `ReadWrite`, `ReadOnly`. When creating a new custom endpoint, default to `ReadOnly`.
	ReadWriteMode pulumi.StringPtrInput
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	SslAutoRotate pulumi.StringPtrInput
	// Specifies SSL certificate download link.\
	// **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm).
	// For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
	SslCertificateUrl pulumi.StringPtrInput
	// (Available since v1.121.0) The SSL connection string.
	SslConnectionString pulumi.StringPtrInput
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrInput
	// (Available since v1.121.0) The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	SslExpireTime pulumi.StringPtrInput
}

func (EndpointState) ElementType 

func (EndpointState) ElementType() reflect.Type

type GetAccountsAccount 

type GetAccountsAccount struct {
	// Account description.
	AccountDescription string `pulumi:"accountDescription"`
	// Account lock state, Valid values are `Lock`, `UnLock`.
	AccountLockState string `pulumi:"accountLockState"`
	// Account name.
	AccountName string `pulumi:"accountName"`
	// Cluster address type.`Cluster`: the default address of the Cluster.`Primary`: Primary address.`Custom`: Custom cluster addresses.
	AccountStatus string `pulumi:"accountStatus"`
	// Account type, Valid values are `Normal`, `Super`.
	AccountType string `pulumi:"accountType"`
	// A list of database privilege. Each element contains the following attributes.
	DatabasePrivileges []GetAccountsAccountDatabasePrivilege `pulumi:"databasePrivileges"`
}

type GetAccountsAccountArgs 

type GetAccountsAccountArgs struct {
	// Account description.
	AccountDescription pulumi.StringInput `pulumi:"accountDescription"`
	// Account lock state, Valid values are `Lock`, `UnLock`.
	AccountLockState pulumi.StringInput `pulumi:"accountLockState"`
	// Account name.
	AccountName pulumi.StringInput `pulumi:"accountName"`
	// Cluster address type.`Cluster`: the default address of the Cluster.`Primary`: Primary address.`Custom`: Custom cluster addresses.
	AccountStatus pulumi.StringInput `pulumi:"accountStatus"`
	// Account type, Valid values are `Normal`, `Super`.
	AccountType pulumi.StringInput `pulumi:"accountType"`
	// A list of database privilege. Each element contains the following attributes.
	DatabasePrivileges GetAccountsAccountDatabasePrivilegeArrayInput `pulumi:"databasePrivileges"`
}

func (GetAccountsAccountArgs) ElementType 

func (GetAccountsAccountArgs) ElementType() reflect.Type

func (GetAccountsAccountArgs) ToGetAccountsAccountOutput 

func (i GetAccountsAccountArgs) ToGetAccountsAccountOutput() GetAccountsAccountOutput

func (GetAccountsAccountArgs) ToGetAccountsAccountOutputWithContext 

func (i GetAccountsAccountArgs) ToGetAccountsAccountOutputWithContext(ctx context.Context) GetAccountsAccountOutput

type GetAccountsAccountArray 

type GetAccountsAccountArray []GetAccountsAccountInput

func (GetAccountsAccountArray) ElementType 

func (GetAccountsAccountArray) ElementType() reflect.Type

func (GetAccountsAccountArray) ToGetAccountsAccountArrayOutput 

func (i GetAccountsAccountArray) ToGetAccountsAccountArrayOutput() GetAccountsAccountArrayOutput

func (GetAccountsAccountArray) ToGetAccountsAccountArrayOutputWithContext 

func (i GetAccountsAccountArray) ToGetAccountsAccountArrayOutputWithContext(ctx context.Context) GetAccountsAccountArrayOutput

type GetAccountsAccountArrayInput 

type GetAccountsAccountArrayInput interface {
	pulumi.Input

	ToGetAccountsAccountArrayOutput() GetAccountsAccountArrayOutput
	ToGetAccountsAccountArrayOutputWithContext(context.Context) GetAccountsAccountArrayOutput
}

GetAccountsAccountArrayInput is an input type that accepts GetAccountsAccountArray and GetAccountsAccountArrayOutput values. You can construct a concrete instance of `GetAccountsAccountArrayInput` via: 

GetAccountsAccountArray{ GetAccountsAccountArgs{...} }

type GetAccountsAccountArrayOutput 

type GetAccountsAccountArrayOutput struct{ *pulumi.OutputState }

func (GetAccountsAccountArrayOutput) ElementType 

func (GetAccountsAccountArrayOutput) ElementType() reflect.Type

func (GetAccountsAccountArrayOutput) Index 

func (o GetAccountsAccountArrayOutput) Index(i pulumi.IntInput) GetAccountsAccountOutput

func (GetAccountsAccountArrayOutput) ToGetAccountsAccountArrayOutput 

func (o GetAccountsAccountArrayOutput) ToGetAccountsAccountArrayOutput() GetAccountsAccountArrayOutput

func (GetAccountsAccountArrayOutput) ToGetAccountsAccountArrayOutputWithContext 

func (o GetAccountsAccountArrayOutput) ToGetAccountsAccountArrayOutputWithContext(ctx context.Context) GetAccountsAccountArrayOutput

type GetAccountsAccountDatabasePrivilege 

type GetAccountsAccountDatabasePrivilege struct {
	// Account privilege of database
	AccountPrivilege string `pulumi:"accountPrivilege"`
	// The account owned database name
	DbName string `pulumi:"dbName"`
}

type GetAccountsAccountDatabasePrivilegeArgs 

type GetAccountsAccountDatabasePrivilegeArgs struct {
	// Account privilege of database
	AccountPrivilege pulumi.StringInput `pulumi:"accountPrivilege"`
	// The account owned database name
	DbName pulumi.StringInput `pulumi:"dbName"`
}

func (GetAccountsAccountDatabasePrivilegeArgs) ElementType 

func (GetAccountsAccountDatabasePrivilegeArgs) ElementType() reflect.Type

func (GetAccountsAccountDatabasePrivilegeArgs) ToGetAccountsAccountDatabasePrivilegeOutput 

func (i GetAccountsAccountDatabasePrivilegeArgs) ToGetAccountsAccountDatabasePrivilegeOutput() GetAccountsAccountDatabasePrivilegeOutput

func (GetAccountsAccountDatabasePrivilegeArgs) ToGetAccountsAccountDatabasePrivilegeOutputWithContext 

func (i GetAccountsAccountDatabasePrivilegeArgs) ToGetAccountsAccountDatabasePrivilegeOutputWithContext(ctx context.Context) GetAccountsAccountDatabasePrivilegeOutput

type GetAccountsAccountDatabasePrivilegeArray 

type GetAccountsAccountDatabasePrivilegeArray []GetAccountsAccountDatabasePrivilegeInput

func (GetAccountsAccountDatabasePrivilegeArray) ElementType 

func (GetAccountsAccountDatabasePrivilegeArray) ElementType() reflect.Type

func (GetAccountsAccountDatabasePrivilegeArray) ToGetAccountsAccountDatabasePrivilegeArrayOutput 

func (i GetAccountsAccountDatabasePrivilegeArray) ToGetAccountsAccountDatabasePrivilegeArrayOutput() GetAccountsAccountDatabasePrivilegeArrayOutput

func (GetAccountsAccountDatabasePrivilegeArray) ToGetAccountsAccountDatabasePrivilegeArrayOutputWithContext 

func (i GetAccountsAccountDatabasePrivilegeArray) ToGetAccountsAccountDatabasePrivilegeArrayOutputWithContext(ctx context.Context) GetAccountsAccountDatabasePrivilegeArrayOutput

type GetAccountsAccountDatabasePrivilegeArrayInput 

type GetAccountsAccountDatabasePrivilegeArrayInput interface {
	pulumi.Input

	ToGetAccountsAccountDatabasePrivilegeArrayOutput() GetAccountsAccountDatabasePrivilegeArrayOutput
	ToGetAccountsAccountDatabasePrivilegeArrayOutputWithContext(context.Context) GetAccountsAccountDatabasePrivilegeArrayOutput
}

GetAccountsAccountDatabasePrivilegeArrayInput is an input type that accepts GetAccountsAccountDatabasePrivilegeArray and GetAccountsAccountDatabasePrivilegeArrayOutput values. You can construct a concrete instance of `GetAccountsAccountDatabasePrivilegeArrayInput` via: 

GetAccountsAccountDatabasePrivilegeArray{ GetAccountsAccountDatabasePrivilegeArgs{...} }

type GetAccountsAccountDatabasePrivilegeArrayOutput 

type GetAccountsAccountDatabasePrivilegeArrayOutput struct{ *pulumi.OutputState }

func (GetAccountsAccountDatabasePrivilegeArrayOutput) ElementType 

func (GetAccountsAccountDatabasePrivilegeArrayOutput) ElementType() reflect.Type

func (GetAccountsAccountDatabasePrivilegeArrayOutput) Index 

func (o GetAccountsAccountDatabasePrivilegeArrayOutput) Index(i pulumi.IntInput) GetAccountsAccountDatabasePrivilegeOutput

func (GetAccountsAccountDatabasePrivilegeArrayOutput) ToGetAccountsAccountDatabasePrivilegeArrayOutput 

func (o GetAccountsAccountDatabasePrivilegeArrayOutput) ToGetAccountsAccountDatabasePrivilegeArrayOutput() GetAccountsAccountDatabasePrivilegeArrayOutput

func (GetAccountsAccountDatabasePrivilegeArrayOutput) ToGetAccountsAccountDatabasePrivilegeArrayOutputWithContext 

func (o GetAccountsAccountDatabasePrivilegeArrayOutput) ToGetAccountsAccountDatabasePrivilegeArrayOutputWithContext(ctx context.Context) GetAccountsAccountDatabasePrivilegeArrayOutput

type GetAccountsAccountDatabasePrivilegeInput 

type GetAccountsAccountDatabasePrivilegeInput interface {
	pulumi.Input

	ToGetAccountsAccountDatabasePrivilegeOutput() GetAccountsAccountDatabasePrivilegeOutput
	ToGetAccountsAccountDatabasePrivilegeOutputWithContext(context.Context) GetAccountsAccountDatabasePrivilegeOutput
}

GetAccountsAccountDatabasePrivilegeInput is an input type that accepts GetAccountsAccountDatabasePrivilegeArgs and GetAccountsAccountDatabasePrivilegeOutput values. You can construct a concrete instance of `GetAccountsAccountDatabasePrivilegeInput` via: 

GetAccountsAccountDatabasePrivilegeArgs{...}

type GetAccountsAccountDatabasePrivilegeOutput 

type GetAccountsAccountDatabasePrivilegeOutput struct{ *pulumi.OutputState }

func (GetAccountsAccountDatabasePrivilegeOutput) AccountPrivilege 

func (o GetAccountsAccountDatabasePrivilegeOutput) AccountPrivilege() pulumi.StringOutput

Account privilege of database

func (GetAccountsAccountDatabasePrivilegeOutput) DbName 

func (o GetAccountsAccountDatabasePrivilegeOutput) DbName() pulumi.StringOutput

The account owned database name

func (GetAccountsAccountDatabasePrivilegeOutput) ElementType 

func (GetAccountsAccountDatabasePrivilegeOutput) ElementType() reflect.Type

func (GetAccountsAccountDatabasePrivilegeOutput) ToGetAccountsAccountDatabasePrivilegeOutput 

func (o GetAccountsAccountDatabasePrivilegeOutput) ToGetAccountsAccountDatabasePrivilegeOutput() GetAccountsAccountDatabasePrivilegeOutput

func (GetAccountsAccountDatabasePrivilegeOutput) ToGetAccountsAccountDatabasePrivilegeOutputWithContext 

func (o GetAccountsAccountDatabasePrivilegeOutput) ToGetAccountsAccountDatabasePrivilegeOutputWithContext(ctx context.Context) GetAccountsAccountDatabasePrivilegeOutput

type GetAccountsAccountInput 

type GetAccountsAccountInput interface {
	pulumi.Input

	ToGetAccountsAccountOutput() GetAccountsAccountOutput
	ToGetAccountsAccountOutputWithContext(context.Context) GetAccountsAccountOutput
}

GetAccountsAccountInput is an input type that accepts GetAccountsAccountArgs and GetAccountsAccountOutput values. You can construct a concrete instance of `GetAccountsAccountInput` via: 

GetAccountsAccountArgs{...}

type GetAccountsAccountOutput 

type GetAccountsAccountOutput struct{ *pulumi.OutputState }

func (GetAccountsAccountOutput) AccountDescription 

func (o GetAccountsAccountOutput) AccountDescription() pulumi.StringOutput

Account description.

func (GetAccountsAccountOutput) AccountLockState 

func (o GetAccountsAccountOutput) AccountLockState() pulumi.StringOutput

Account lock state, Valid values are `Lock`, `UnLock`.

func (GetAccountsAccountOutput) AccountName 

func (o GetAccountsAccountOutput) AccountName() pulumi.StringOutput

Account name.

func (GetAccountsAccountOutput) AccountStatus 

func (o GetAccountsAccountOutput) AccountStatus() pulumi.StringOutput

Cluster address type.`Cluster`: the default address of the Cluster.`Primary`: Primary address.`Custom`: Custom cluster addresses.

func (GetAccountsAccountOutput) AccountType 

func (o GetAccountsAccountOutput) AccountType() pulumi.StringOutput

Account type, Valid values are `Normal`, `Super`.

func (GetAccountsAccountOutput) DatabasePrivileges 

func (o GetAccountsAccountOutput) DatabasePrivileges() GetAccountsAccountDatabasePrivilegeArrayOutput

A list of database privilege. Each element contains the following attributes.

func (GetAccountsAccountOutput) ElementType 

func (GetAccountsAccountOutput) ElementType() reflect.Type

func (GetAccountsAccountOutput) ToGetAccountsAccountOutput 

func (o GetAccountsAccountOutput) ToGetAccountsAccountOutput() GetAccountsAccountOutput

func (GetAccountsAccountOutput) ToGetAccountsAccountOutputWithContext 

func (o GetAccountsAccountOutput) ToGetAccountsAccountOutputWithContext(ctx context.Context) GetAccountsAccountOutput

type GetAccountsArgs 

type GetAccountsArgs struct {
	// The polarDB cluster ID.
	DbClusterId string `pulumi:"dbClusterId"`
	// A regex string to filter results by account name.
	NameRegex *string `pulumi:"nameRegex"`
}

A collection of arguments for invoking getAccounts.

type GetAccountsOutputArgs added in v3.9.0 

type GetAccountsOutputArgs struct {
	// The polarDB cluster ID.
	DbClusterId pulumi.StringInput `pulumi:"dbClusterId"`
	// A regex string to filter results by account name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
}

A collection of arguments for invoking getAccounts.

func (GetAccountsOutputArgs) ElementType added in v3.9.0 

func (GetAccountsOutputArgs) ElementType() reflect.Type

type GetAccountsResult 

type GetAccountsResult struct {
	// A list of PolarDB cluster accounts. Each element contains the following attributes:
	Accounts    []GetAccountsAccount `pulumi:"accounts"`
	DbClusterId string               `pulumi:"dbClusterId"`
	// The provider-assigned unique ID for this managed resource.
	Id        string  `pulumi:"id"`
	NameRegex *string `pulumi:"nameRegex"`
	// Account name of the cluster.
	Names []string `pulumi:"names"`
}

A collection of values returned by getAccounts.

func GetAccounts 

func GetAccounts(ctx *pulumi.Context, args *GetAccountsArgs, opts ...pulumi.InvokeOption) (*GetAccountsResult, error)

The `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 since v1.70.0+.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { this, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{ DbType: pulumi.StringRef("MySQL"), DbVersion: pulumi.StringRef("8.0"), PayType: "PostPaid", Category: pulumi.StringRef("Normal"), }, nil); if err != nil { return err } defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{ VpcName: pulumi.String("terraform-example"), CidrBlock: pulumi.String("172.16.0.0/16"), }) if err != nil { return err } defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{ VpcId: defaultNetwork.ID(), CidrBlock: pulumi.String("172.16.0.0/24"), ZoneId: pulumi.String(this.Classes[0].ZoneId), VswitchName: pulumi.String("terraform-example"), }) if err != nil { return err } cluster, err := polardb.NewCluster(ctx, "cluster", &polardb.ClusterArgs{ DbType: pulumi.String("MySQL"), DbVersion: pulumi.String("8.0"), PayType: pulumi.String("PostPaid"), DbNodeCount: pulumi.Int(2), DbNodeClass: pulumi.String(this.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass), VswitchId: defaultSwitch.ID(), }) if err != nil { return err } polardbClustersDs := polardb.GetClustersOutput(ctx, polardb.GetClustersOutputArgs{ DescriptionRegex: cluster.Description, Status: pulumi.String("Running"), }, nil); account, err := polardb.NewAccount(ctx, "account", &polardb.AccountArgs{ DbClusterId: polardbClustersDs.ApplyT(func(polardbClustersDs polardb.GetClustersResult) (*string, error) { return &polardbClustersDs.Clusters[0].Id, nil }).(pulumi.StringPtrOutput), AccountName: pulumi.String("tfnormal_01"), AccountPassword: pulumi.String("Test12345"), AccountDescription: pulumi.String("tf_account_description"), AccountType: pulumi.String("Normal"), }) if err != nil { return err } _default := pulumi.All(polardbClustersDs,account.AccountName).ApplyT(func(_args []interface{}) (polardb.GetAccountsResult, error) { polardbClustersDs := _args[0].(polardb.GetClustersResult) accountName := _args[1].(string) return polardb.GetAccountsOutput(ctx, polardb.GetAccountsOutputArgs{ DbClusterId: polardbClustersDs.Clusters[0].Id, NameRegex: accountName, }, nil), nil }).(polardb.GetAccountsResultOutput) ctx.Export("account", _default.ApplyT(func(_default polardb.GetAccountsResult) (*string, error) { return &default.Accounts[0].AccountName, nil }).(pulumi.StringPtrOutput)) return nil }) } ```

type GetAccountsResultOutput added in v3.9.0 

type GetAccountsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAccounts.

func GetAccountsOutput added in v3.9.0 

func GetAccountsOutput(ctx *pulumi.Context, args GetAccountsOutputArgs, opts ...pulumi.InvokeOption) GetAccountsResultOutput

func (GetAccountsResultOutput) Accounts added in v3.9.0 

func (o GetAccountsResultOutput) Accounts() GetAccountsAccountArrayOutput

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

func (GetAccountsResultOutput) DbClusterId added in v3.9.0 

func (o GetAccountsResultOutput) DbClusterId() pulumi.StringOutput

func (GetAccountsResultOutput) ElementType added in v3.9.0 

func (GetAccountsResultOutput) ElementType() reflect.Type

func (GetAccountsResultOutput) Id added in v3.9.0 

func (o GetAccountsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetAccountsResultOutput) NameRegex added in v3.9.0 

func (o GetAccountsResultOutput) NameRegex() pulumi.StringPtrOutput

func (GetAccountsResultOutput) Names added in v3.9.0 

func (o GetAccountsResultOutput) Names() pulumi.StringArrayOutput

Account name of the cluster.

func (GetAccountsResultOutput) ToGetAccountsResultOutput added in v3.9.0 

func (o GetAccountsResultOutput) ToGetAccountsResultOutput() GetAccountsResultOutput

func (GetAccountsResultOutput) ToGetAccountsResultOutputWithContext added in v3.9.0 

func (o GetAccountsResultOutput) ToGetAccountsResultOutputWithContext(ctx context.Context) GetAccountsResultOutput

type GetClustersArgs 

type GetClustersArgs struct {
	// Database type. Options are `MySQL`, `Oracle` and `PostgreSQL`. If no value is specified, all types are returned.
	DbType *string `pulumi:"dbType"`
	// A regex string to filter results by cluster description.
	DescriptionRegex *string `pulumi:"descriptionRegex"`
	// A list of PolarDB cluster IDs.
	Ids []string `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// status of the cluster.
	Status *string `pulumi:"status"`
	// 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.
	Tags map[string]interface{} `pulumi:"tags"`
}

A collection of arguments for invoking getClusters.

type GetClustersCluster 

type GetClustersCluster struct {
	// Billing method. Value options: `PostPaid` for Pay-As-You-Go and `PrePaid` for subscription.
	ChargeType string `pulumi:"chargeType"`
	// PolarDB cluster connection string.
	ConnectionString string `pulumi:"connectionString"`
	// The createTime of the db_nodes.
	CreateTime string `pulumi:"createTime"`
	// The dbNodeClass of the db_nodes.
	DbNodeClass string `pulumi:"dbNodeClass"`
	// The DBNodeNumber of the PolarDB cluster.
	DbNodeNumber int `pulumi:"dbNodeNumber"`
	// The DBNodes of the PolarDB cluster.
	DbNodes []GetClustersClusterDbNode `pulumi:"dbNodes"`
	// Database type. Options are `MySQL`, `Oracle` and `PostgreSQL`. If no value is specified, all types are returned.
	DbType string `pulumi:"dbType"`
	// The DBVersion of the PolarDB cluster.
	DbVersion string `pulumi:"dbVersion"`
	// The DeleteLock of the PolarDB cluster.
	DeleteLock int `pulumi:"deleteLock"`
	// The description of the PolarDB cluster.
	Description string `pulumi:"description"`
	// Database type. Options are `MySQL`, `Oracle` and `PostgreSQL`. If no value is specified, all types are returned.
	Engine string `pulumi:"engine"`
	// Expiration time. Pay-As-You-Go clusters never expire.
	ExpireTime string `pulumi:"expireTime"`
	// The expired of the PolarDB cluster.
	Expired string `pulumi:"expired"`
	// The ID of the PolarDB cluster.
	Id string `pulumi:"id"`
	// The LockMode of the PolarDB cluster.
	LockMode string `pulumi:"lockMode"`
	// The DBClusterNetworkType of the PolarDB cluster.
	NetworkType string `pulumi:"networkType"`
	// PolarDB cluster connection port.
	Port string `pulumi:"port"`
	// The regionId of the db_nodes.
	RegionId string `pulumi:"regionId"`
	// status of the cluster.
	Status string `pulumi:"status"`
	// The StorageUsed of the PolarDB cluster.
	StorageUsed int `pulumi:"storageUsed"`
	// ID of the VPC the cluster belongs to.
	VpcId string `pulumi:"vpcId"`
	// The zoneId of the db_nodes.
	ZoneId string `pulumi:"zoneId"`
}

type GetClustersClusterArgs 

type GetClustersClusterArgs struct {
	// Billing method. Value options: `PostPaid` for Pay-As-You-Go and `PrePaid` for subscription.
	ChargeType pulumi.StringInput `pulumi:"chargeType"`
	// PolarDB cluster connection string.
	ConnectionString pulumi.StringInput `pulumi:"connectionString"`
	// The createTime of the db_nodes.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The dbNodeClass of the db_nodes.
	DbNodeClass pulumi.StringInput `pulumi:"dbNodeClass"`
	// The DBNodeNumber of the PolarDB cluster.
	DbNodeNumber pulumi.IntInput `pulumi:"dbNodeNumber"`
	// The DBNodes of the PolarDB cluster.
	DbNodes GetClustersClusterDbNodeArrayInput `pulumi:"dbNodes"`
	// Database type. Options are `MySQL`, `Oracle` and `PostgreSQL`. If no value is specified, all types are returned.
	DbType pulumi.StringInput `pulumi:"dbType"`
	// The DBVersion of the PolarDB cluster.
	DbVersion pulumi.StringInput `pulumi:"dbVersion"`
	// The DeleteLock of the PolarDB cluster.
	DeleteLock pulumi.IntInput `pulumi:"deleteLock"`
	// The description of the PolarDB cluster.
	Description pulumi.StringInput `pulumi:"description"`
	// Database type. Options are `MySQL`, `Oracle` and `PostgreSQL`. If no value is specified, all types are returned.
	Engine pulumi.StringInput `pulumi:"engine"`
	// Expiration time. Pay-As-You-Go clusters never expire.
	ExpireTime pulumi.StringInput `pulumi:"expireTime"`
	// The expired of the PolarDB cluster.
	Expired pulumi.StringInput `pulumi:"expired"`
	// The ID of the PolarDB cluster.
	Id pulumi.StringInput `pulumi:"id"`
	// The LockMode of the PolarDB cluster.
	LockMode pulumi.StringInput `pulumi:"lockMode"`
	// The DBClusterNetworkType of the PolarDB cluster.
	NetworkType pulumi.StringInput `pulumi:"networkType"`
	// PolarDB cluster connection port.
	Port pulumi.StringInput `pulumi:"port"`
	// The regionId of the db_nodes.
	RegionId pulumi.StringInput `pulumi:"regionId"`
	// status of the cluster.
	Status pulumi.StringInput `pulumi:"status"`
	// The StorageUsed of the PolarDB cluster.
	StorageUsed pulumi.IntInput `pulumi:"storageUsed"`
	// ID of the VPC the cluster belongs to.
	VpcId pulumi.StringInput `pulumi:"vpcId"`
	// The zoneId of the db_nodes.
	ZoneId pulumi.StringInput `pulumi:"zoneId"`
}

func (GetClustersClusterArgs) ElementType 

func (GetClustersClusterArgs) ElementType() reflect.Type

func (GetClustersClusterArgs) ToGetClustersClusterOutput 

func (i GetClustersClusterArgs) ToGetClustersClusterOutput() GetClustersClusterOutput

func (GetClustersClusterArgs) ToGetClustersClusterOutputWithContext 

func (i GetClustersClusterArgs) ToGetClustersClusterOutputWithContext(ctx context.Context) GetClustersClusterOutput

type GetClustersClusterArray 

type GetClustersClusterArray []GetClustersClusterInput

func (GetClustersClusterArray) ElementType 

func (GetClustersClusterArray) ElementType() reflect.Type

func (GetClustersClusterArray) ToGetClustersClusterArrayOutput 

func (i GetClustersClusterArray) ToGetClustersClusterArrayOutput() GetClustersClusterArrayOutput

func (GetClustersClusterArray) ToGetClustersClusterArrayOutputWithContext 

func (i GetClustersClusterArray) ToGetClustersClusterArrayOutputWithContext(ctx context.Context) GetClustersClusterArrayOutput

type GetClustersClusterArrayInput 

type GetClustersClusterArrayInput interface {
	pulumi.Input

	ToGetClustersClusterArrayOutput() GetClustersClusterArrayOutput
	ToGetClustersClusterArrayOutputWithContext(context.Context) GetClustersClusterArrayOutput
}

GetClustersClusterArrayInput is an input type that accepts GetClustersClusterArray and GetClustersClusterArrayOutput values. You can construct a concrete instance of `GetClustersClusterArrayInput` via: 

GetClustersClusterArray{ GetClustersClusterArgs{...} }

type GetClustersClusterArrayOutput 

type GetClustersClusterArrayOutput struct{ *pulumi.OutputState }

func (GetClustersClusterArrayOutput) ElementType 

func (GetClustersClusterArrayOutput) ElementType() reflect.Type

func (GetClustersClusterArrayOutput) Index 

func (o GetClustersClusterArrayOutput) Index(i pulumi.IntInput) GetClustersClusterOutput

func (GetClustersClusterArrayOutput) ToGetClustersClusterArrayOutput 

func (o GetClustersClusterArrayOutput) ToGetClustersClusterArrayOutput() GetClustersClusterArrayOutput

func (GetClustersClusterArrayOutput) ToGetClustersClusterArrayOutputWithContext 

func (o GetClustersClusterArrayOutput) ToGetClustersClusterArrayOutputWithContext(ctx context.Context) GetClustersClusterArrayOutput

type GetClustersClusterDbNode 

type GetClustersClusterDbNode struct {
	// The createTime of the db_nodes.
	CreateTime string `pulumi:"createTime"`
	// The dbNodeClass of the db_nodes.
	DbNodeClass string `pulumi:"dbNodeClass"`
	// The dbNodeId of the db_nodes.
	DbNodeId string `pulumi:"dbNodeId"`
	// The dbNodeRole of the db_nodes.
	DbNodeRole string `pulumi:"dbNodeRole"`
	// The dbNodeStatus of the db_nodes.
	DbNodeStatus string `pulumi:"dbNodeStatus"`
	// The maxConnections of the db_nodes.
	MaxConnections int `pulumi:"maxConnections"`
	// The maxIops of the db_nodes.
	MaxIops int `pulumi:"maxIops"`
	// The regionId of the db_nodes.
	RegionId string `pulumi:"regionId"`
	// The zoneId of the db_nodes.
	ZoneId string `pulumi:"zoneId"`
}

type GetClustersClusterDbNodeArgs 

type GetClustersClusterDbNodeArgs struct {
	// The createTime of the db_nodes.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The dbNodeClass of the db_nodes.
	DbNodeClass pulumi.StringInput `pulumi:"dbNodeClass"`
	// The dbNodeId of the db_nodes.
	DbNodeId pulumi.StringInput `pulumi:"dbNodeId"`
	// The dbNodeRole of the db_nodes.
	DbNodeRole pulumi.StringInput `pulumi:"dbNodeRole"`
	// The dbNodeStatus of the db_nodes.
	DbNodeStatus pulumi.StringInput `pulumi:"dbNodeStatus"`
	// The maxConnections of the db_nodes.
	MaxConnections pulumi.IntInput `pulumi:"maxConnections"`
	// The maxIops of the db_nodes.
	MaxIops pulumi.IntInput `pulumi:"maxIops"`
	// The regionId of the db_nodes.
	RegionId pulumi.StringInput `pulumi:"regionId"`
	// The zoneId of the db_nodes.
	ZoneId pulumi.StringInput `pulumi:"zoneId"`
}

func (GetClustersClusterDbNodeArgs) ElementType 

func (GetClustersClusterDbNodeArgs) ElementType() reflect.Type

func (GetClustersClusterDbNodeArgs) ToGetClustersClusterDbNodeOutput 

func (i GetClustersClusterDbNodeArgs) ToGetClustersClusterDbNodeOutput() GetClustersClusterDbNodeOutput

func (GetClustersClusterDbNodeArgs) ToGetClustersClusterDbNodeOutputWithContext 

func (i GetClustersClusterDbNodeArgs) ToGetClustersClusterDbNodeOutputWithContext(ctx context.Context) GetClustersClusterDbNodeOutput

type GetClustersClusterDbNodeArray 

type GetClustersClusterDbNodeArray []GetClustersClusterDbNodeInput

func (GetClustersClusterDbNodeArray) ElementType 

func (GetClustersClusterDbNodeArray) ElementType() reflect.Type

func (GetClustersClusterDbNodeArray) ToGetClustersClusterDbNodeArrayOutput 

func (i GetClustersClusterDbNodeArray) ToGetClustersClusterDbNodeArrayOutput() GetClustersClusterDbNodeArrayOutput

func (GetClustersClusterDbNodeArray) ToGetClustersClusterDbNodeArrayOutputWithContext 

func (i GetClustersClusterDbNodeArray) ToGetClustersClusterDbNodeArrayOutputWithContext(ctx context.Context) GetClustersClusterDbNodeArrayOutput

type GetClustersClusterDbNodeArrayInput 

type GetClustersClusterDbNodeArrayInput interface {
	pulumi.Input

	ToGetClustersClusterDbNodeArrayOutput() GetClustersClusterDbNodeArrayOutput
	ToGetClustersClusterDbNodeArrayOutputWithContext(context.Context) GetClustersClusterDbNodeArrayOutput
}

GetClustersClusterDbNodeArrayInput is an input type that accepts GetClustersClusterDbNodeArray and GetClustersClusterDbNodeArrayOutput values. You can construct a concrete instance of `GetClustersClusterDbNodeArrayInput` via: 

GetClustersClusterDbNodeArray{ GetClustersClusterDbNodeArgs{...} }

type GetClustersClusterDbNodeArrayOutput 

type GetClustersClusterDbNodeArrayOutput struct{ *pulumi.OutputState }

func (GetClustersClusterDbNodeArrayOutput) ElementType 

func (GetClustersClusterDbNodeArrayOutput) ElementType() reflect.Type

func (GetClustersClusterDbNodeArrayOutput) Index 

func (o GetClustersClusterDbNodeArrayOutput) Index(i pulumi.IntInput) GetClustersClusterDbNodeOutput

func (GetClustersClusterDbNodeArrayOutput) ToGetClustersClusterDbNodeArrayOutput 

func (o GetClustersClusterDbNodeArrayOutput) ToGetClustersClusterDbNodeArrayOutput() GetClustersClusterDbNodeArrayOutput

func (GetClustersClusterDbNodeArrayOutput) ToGetClustersClusterDbNodeArrayOutputWithContext 

func (o GetClustersClusterDbNodeArrayOutput) ToGetClustersClusterDbNodeArrayOutputWithContext(ctx context.Context) GetClustersClusterDbNodeArrayOutput

type GetClustersClusterDbNodeInput 

type GetClustersClusterDbNodeInput interface {
	pulumi.Input

	ToGetClustersClusterDbNodeOutput() GetClustersClusterDbNodeOutput
	ToGetClustersClusterDbNodeOutputWithContext(context.Context) GetClustersClusterDbNodeOutput
}

GetClustersClusterDbNodeInput is an input type that accepts GetClustersClusterDbNodeArgs and GetClustersClusterDbNodeOutput values. You can construct a concrete instance of `GetClustersClusterDbNodeInput` via: 

GetClustersClusterDbNodeArgs{...}

type GetClustersClusterDbNodeOutput 

type GetClustersClusterDbNodeOutput struct{ *pulumi.OutputState }

func (GetClustersClusterDbNodeOutput) CreateTime 

func (o GetClustersClusterDbNodeOutput) CreateTime() pulumi.StringOutput

The createTime of the db_nodes.

func (GetClustersClusterDbNodeOutput) DbNodeClass 

func (o GetClustersClusterDbNodeOutput) DbNodeClass() pulumi.StringOutput

The dbNodeClass of the db_nodes.

func (GetClustersClusterDbNodeOutput) DbNodeId 

func (o GetClustersClusterDbNodeOutput) DbNodeId() pulumi.StringOutput

The dbNodeId of the db_nodes.

func (GetClustersClusterDbNodeOutput) DbNodeRole 

func (o GetClustersClusterDbNodeOutput) DbNodeRole() pulumi.StringOutput

The dbNodeRole of the db_nodes.

func (GetClustersClusterDbNodeOutput) DbNodeStatus 

func (o GetClustersClusterDbNodeOutput) DbNodeStatus() pulumi.StringOutput

The dbNodeStatus of the db_nodes.

func (GetClustersClusterDbNodeOutput) ElementType 

func (GetClustersClusterDbNodeOutput) ElementType() reflect.Type

func (GetClustersClusterDbNodeOutput) MaxConnections 

func (o GetClustersClusterDbNodeOutput) MaxConnections() pulumi.IntOutput

The maxConnections of the db_nodes.

func (GetClustersClusterDbNodeOutput) MaxIops 

func (o GetClustersClusterDbNodeOutput) MaxIops() pulumi.IntOutput

The maxIops of the db_nodes.

func (GetClustersClusterDbNodeOutput) RegionId 

func (o GetClustersClusterDbNodeOutput) RegionId() pulumi.StringOutput

The regionId of the db_nodes.

func (GetClustersClusterDbNodeOutput) ToGetClustersClusterDbNodeOutput 

func (o GetClustersClusterDbNodeOutput) ToGetClustersClusterDbNodeOutput() GetClustersClusterDbNodeOutput

func (GetClustersClusterDbNodeOutput) ToGetClustersClusterDbNodeOutputWithContext 

func (o GetClustersClusterDbNodeOutput) ToGetClustersClusterDbNodeOutputWithContext(ctx context.Context) GetClustersClusterDbNodeOutput

func (GetClustersClusterDbNodeOutput) ZoneId 

func (o GetClustersClusterDbNodeOutput) ZoneId() pulumi.StringOutput

The zoneId of the db_nodes.

type GetClustersClusterInput 

type GetClustersClusterInput interface {
	pulumi.Input

	ToGetClustersClusterOutput() GetClustersClusterOutput
	ToGetClustersClusterOutputWithContext(context.Context) GetClustersClusterOutput
}

GetClustersClusterInput is an input type that accepts GetClustersClusterArgs and GetClustersClusterOutput values. You can construct a concrete instance of `GetClustersClusterInput` via: 

GetClustersClusterArgs{...}

type GetClustersClusterOutput 

type GetClustersClusterOutput struct{ *pulumi.OutputState }

func (GetClustersClusterOutput) ChargeType 

func (o GetClustersClusterOutput) ChargeType() pulumi.StringOutput

Billing method. Value options: `PostPaid` for Pay-As-You-Go and `PrePaid` for subscription.

func (GetClustersClusterOutput) ConnectionString added in v3.29.0 

func (o GetClustersClusterOutput) ConnectionString() pulumi.StringOutput

PolarDB cluster connection string.

func (GetClustersClusterOutput) CreateTime 

func (o GetClustersClusterOutput) CreateTime() pulumi.StringOutput

The createTime of the db_nodes.

func (GetClustersClusterOutput) DbNodeClass 

func (o GetClustersClusterOutput) DbNodeClass() pulumi.StringOutput

The dbNodeClass of the db_nodes.

func (GetClustersClusterOutput) DbNodeNumber 

func (o GetClustersClusterOutput) DbNodeNumber() pulumi.IntOutput

The DBNodeNumber of the PolarDB cluster.

func (GetClustersClusterOutput) DbNodes 

func (o GetClustersClusterOutput) DbNodes() GetClustersClusterDbNodeArrayOutput

The DBNodes of the PolarDB cluster.

func (GetClustersClusterOutput) DbType 

func (o GetClustersClusterOutput) DbType() pulumi.StringOutput

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

func (GetClustersClusterOutput) DbVersion 

func (o GetClustersClusterOutput) DbVersion() pulumi.StringOutput

The DBVersion of the PolarDB cluster.

func (GetClustersClusterOutput) DeleteLock 

func (o GetClustersClusterOutput) DeleteLock() pulumi.IntOutput

The DeleteLock of the PolarDB cluster.

func (GetClustersClusterOutput) Description 

func (o GetClustersClusterOutput) Description() pulumi.StringOutput

The description of the PolarDB cluster.

func (GetClustersClusterOutput) ElementType 

func (GetClustersClusterOutput) ElementType() reflect.Type

func (GetClustersClusterOutput) Engine 

func (o GetClustersClusterOutput) Engine() pulumi.StringOutput

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

func (GetClustersClusterOutput) ExpireTime 

func (o GetClustersClusterOutput) ExpireTime() pulumi.StringOutput

Expiration time. Pay-As-You-Go clusters never expire.

func (GetClustersClusterOutput) Expired 

func (o GetClustersClusterOutput) Expired() pulumi.StringOutput

The expired of the PolarDB cluster.

func (GetClustersClusterOutput) Id 

func (o GetClustersClusterOutput) Id() pulumi.StringOutput

The ID of the PolarDB cluster.

func (GetClustersClusterOutput) LockMode 

func (o GetClustersClusterOutput) LockMode() pulumi.StringOutput

The LockMode of the PolarDB cluster.

func (GetClustersClusterOutput) NetworkType 

func (o GetClustersClusterOutput) NetworkType() pulumi.StringOutput

The DBClusterNetworkType of the PolarDB cluster.

func (GetClustersClusterOutput) Port added in v3.29.0 

func (o GetClustersClusterOutput) Port() pulumi.StringOutput

PolarDB cluster connection port.

func (GetClustersClusterOutput) RegionId 

func (o GetClustersClusterOutput) RegionId() pulumi.StringOutput

The regionId of the db_nodes.

func (GetClustersClusterOutput) Status 

func (o GetClustersClusterOutput) Status() pulumi.StringOutput

status of the cluster.

func (GetClustersClusterOutput) StorageUsed 

func (o GetClustersClusterOutput) StorageUsed() pulumi.IntOutput

The StorageUsed of the PolarDB cluster.

func (GetClustersClusterOutput) ToGetClustersClusterOutput 

func (o GetClustersClusterOutput) ToGetClustersClusterOutput() GetClustersClusterOutput

func (GetClustersClusterOutput) ToGetClustersClusterOutputWithContext 

func (o GetClustersClusterOutput) ToGetClustersClusterOutputWithContext(ctx context.Context) GetClustersClusterOutput

func (GetClustersClusterOutput) VpcId 

func (o GetClustersClusterOutput) VpcId() pulumi.StringOutput

ID of the VPC the cluster belongs to.

func (GetClustersClusterOutput) ZoneId 

func (o GetClustersClusterOutput) ZoneId() pulumi.StringOutput

The zoneId of the db_nodes.

type GetClustersOutputArgs added in v3.9.0 

type GetClustersOutputArgs struct {
	// Database type. Options are `MySQL`, `Oracle` and `PostgreSQL`. If no value is specified, all types are returned.
	DbType pulumi.StringPtrInput `pulumi:"dbType"`
	// A regex string to filter results by cluster description.
	DescriptionRegex pulumi.StringPtrInput `pulumi:"descriptionRegex"`
	// A list of PolarDB cluster IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// status of the cluster.
	Status pulumi.StringPtrInput `pulumi:"status"`
	// 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.
	Tags pulumi.MapInput `pulumi:"tags"`
}

A collection of arguments for invoking getClusters.

func (GetClustersOutputArgs) ElementType added in v3.9.0 

func (GetClustersOutputArgs) ElementType() reflect.Type

type GetClustersResult 

type GetClustersResult struct {
	// A list of PolarDB clusters. Each element contains the following attributes:
	Clusters []GetClustersCluster `pulumi:"clusters"`
	// `Primary` for primary cluster, `ReadOnly` for read-only cluster, `Guard` for disaster recovery cluster, and `Temp` for temporary cluster.
	DbType           *string `pulumi:"dbType"`
	DescriptionRegex *string `pulumi:"descriptionRegex"`
	// A list of RDS cluster descriptions.
	Descriptions []string `pulumi:"descriptions"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of RDS cluster IDs.
	Ids        []string `pulumi:"ids"`
	OutputFile *string  `pulumi:"outputFile"`
	// Status of the cluster.
	Status *string                `pulumi:"status"`
	Tags   map[string]interface{} `pulumi:"tags"`
}

A collection of values returned by getClusters.

func GetClusters 

func GetClusters(ctx *pulumi.Context, args *GetClustersArgs, opts ...pulumi.InvokeOption) (*GetClustersResult, error)

The `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 since v1.66.0+.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
			Category:  pulumi.StringRef("Normal"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       _default.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(this.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		cluster, err := polardb.NewCluster(ctx, "cluster", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			PayType:     pulumi.String("PostPaid"),
			DbNodeCount: pulumi.Int(2),
			DbNodeClass: pulumi.String(this.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			VswitchId:   defaultSwitch.ID(),
		})
		if err != nil {
			return err
		}
		polardbClustersDs := polardb.GetClustersOutput(ctx, polardb.GetClustersOutputArgs{
			DescriptionRegex: cluster.ID(),
			Status:           pulumi.String("Running"),
		}, nil)
		ctx.Export("firstPolardbClusterId", polardbClustersDs.ApplyT(func(polardbClustersDs polardb.GetClustersResult) (*string, error) {
			return &polardbClustersDs.Clusters[0].Id, nil
		}).(pulumi.StringPtrOutput))
		return nil
	})
}

```

type GetClustersResultOutput added in v3.9.0 

type GetClustersResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getClusters.

func GetClustersOutput added in v3.9.0 

func GetClustersOutput(ctx *pulumi.Context, args GetClustersOutputArgs, opts ...pulumi.InvokeOption) GetClustersResultOutput

func (GetClustersResultOutput) Clusters added in v3.9.0 

func (o GetClustersResultOutput) Clusters() GetClustersClusterArrayOutput

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

func (GetClustersResultOutput) DbType added in v3.9.0 

func (o GetClustersResultOutput) DbType() pulumi.StringPtrOutput

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

func (GetClustersResultOutput) DescriptionRegex added in v3.9.0 

func (o GetClustersResultOutput) DescriptionRegex() pulumi.StringPtrOutput

func (GetClustersResultOutput) Descriptions added in v3.9.0 

func (o GetClustersResultOutput) Descriptions() pulumi.StringArrayOutput

A list of RDS cluster descriptions.

func (GetClustersResultOutput) ElementType added in v3.9.0 

func (GetClustersResultOutput) ElementType() reflect.Type

func (GetClustersResultOutput) Id added in v3.9.0 

func (o GetClustersResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetClustersResultOutput) Ids added in v3.9.0 

func (o GetClustersResultOutput) Ids() pulumi.StringArrayOutput

A list of RDS cluster IDs.

func (GetClustersResultOutput) OutputFile added in v3.9.0 

func (o GetClustersResultOutput) OutputFile() pulumi.StringPtrOutput

func (GetClustersResultOutput) Status added in v3.9.0 

func (o GetClustersResultOutput) Status() pulumi.StringPtrOutput

Status of the cluster.

func (GetClustersResultOutput) Tags added in v3.9.0 

func (o GetClustersResultOutput) Tags() pulumi.MapOutput

func (GetClustersResultOutput) ToGetClustersResultOutput added in v3.9.0 

func (o GetClustersResultOutput) ToGetClustersResultOutput() GetClustersResultOutput

func (GetClustersResultOutput) ToGetClustersResultOutputWithContext added in v3.9.0 

func (o GetClustersResultOutput) ToGetClustersResultOutputWithContext(ctx context.Context) GetClustersResultOutput

type GetDatabasesArgs 

type GetDatabasesArgs struct {
	// The polarDB cluster ID.
	DbClusterId string `pulumi:"dbClusterId"`
	// A regex string to filter results by database name.
	NameRegex *string `pulumi:"nameRegex"`
}

A collection of arguments for invoking getDatabases.

type GetDatabasesDatabase 

type GetDatabasesDatabase struct {
	// A list of accounts of database. Each element contains the following attributes.
	Accounts []GetDatabasesDatabaseAccount `pulumi:"accounts"`
	// The character set name of database.
	CharacterSetName string `pulumi:"characterSetName"`
	// Database description.
	DbDescription string `pulumi:"dbDescription"`
	// Database name.
	DbName string `pulumi:"dbName"`
	// The status of database.
	DbStatus string `pulumi:"dbStatus"`
	// The engine of database.
	Engine string `pulumi:"engine"`
}

type GetDatabasesDatabaseAccount 

type GetDatabasesDatabaseAccount struct {
	// Account name.
	AccountName string `pulumi:"accountName"`
	// Account status.
	AccountStatus string `pulumi:"accountStatus"`
	// The privilege status of account.
	PrivilegeStatus string `pulumi:"privilegeStatus"`
}

type GetDatabasesDatabaseAccountArgs 

type GetDatabasesDatabaseAccountArgs struct {
	// Account name.
	AccountName pulumi.StringInput `pulumi:"accountName"`
	// Account status.
	AccountStatus pulumi.StringInput `pulumi:"accountStatus"`
	// The privilege status of account.
	PrivilegeStatus pulumi.StringInput `pulumi:"privilegeStatus"`
}

func (GetDatabasesDatabaseAccountArgs) ElementType 

func (GetDatabasesDatabaseAccountArgs) ElementType() reflect.Type

func (GetDatabasesDatabaseAccountArgs) ToGetDatabasesDatabaseAccountOutput 

func (i GetDatabasesDatabaseAccountArgs) ToGetDatabasesDatabaseAccountOutput() GetDatabasesDatabaseAccountOutput

func (GetDatabasesDatabaseAccountArgs) ToGetDatabasesDatabaseAccountOutputWithContext 

func (i GetDatabasesDatabaseAccountArgs) ToGetDatabasesDatabaseAccountOutputWithContext(ctx context.Context) GetDatabasesDatabaseAccountOutput

type GetDatabasesDatabaseAccountArray 

type GetDatabasesDatabaseAccountArray []GetDatabasesDatabaseAccountInput

func (GetDatabasesDatabaseAccountArray) ElementType 

func (GetDatabasesDatabaseAccountArray) ElementType() reflect.Type

func (GetDatabasesDatabaseAccountArray) ToGetDatabasesDatabaseAccountArrayOutput 

func (i GetDatabasesDatabaseAccountArray) ToGetDatabasesDatabaseAccountArrayOutput() GetDatabasesDatabaseAccountArrayOutput

func (GetDatabasesDatabaseAccountArray) ToGetDatabasesDatabaseAccountArrayOutputWithContext 

func (i GetDatabasesDatabaseAccountArray) ToGetDatabasesDatabaseAccountArrayOutputWithContext(ctx context.Context) GetDatabasesDatabaseAccountArrayOutput

type GetDatabasesDatabaseAccountArrayInput 

type GetDatabasesDatabaseAccountArrayInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseAccountArrayOutput() GetDatabasesDatabaseAccountArrayOutput
	ToGetDatabasesDatabaseAccountArrayOutputWithContext(context.Context) GetDatabasesDatabaseAccountArrayOutput
}

GetDatabasesDatabaseAccountArrayInput is an input type that accepts GetDatabasesDatabaseAccountArray and GetDatabasesDatabaseAccountArrayOutput values. You can construct a concrete instance of `GetDatabasesDatabaseAccountArrayInput` via: 

GetDatabasesDatabaseAccountArray{ GetDatabasesDatabaseAccountArgs{...} }

type GetDatabasesDatabaseAccountArrayOutput 

type GetDatabasesDatabaseAccountArrayOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseAccountArrayOutput) ElementType 

func (GetDatabasesDatabaseAccountArrayOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseAccountArrayOutput) Index 

func (o GetDatabasesDatabaseAccountArrayOutput) Index(i pulumi.IntInput) GetDatabasesDatabaseAccountOutput

func (GetDatabasesDatabaseAccountArrayOutput) ToGetDatabasesDatabaseAccountArrayOutput 

func (o GetDatabasesDatabaseAccountArrayOutput) ToGetDatabasesDatabaseAccountArrayOutput() GetDatabasesDatabaseAccountArrayOutput

func (GetDatabasesDatabaseAccountArrayOutput) ToGetDatabasesDatabaseAccountArrayOutputWithContext 

func (o GetDatabasesDatabaseAccountArrayOutput) ToGetDatabasesDatabaseAccountArrayOutputWithContext(ctx context.Context) GetDatabasesDatabaseAccountArrayOutput

type GetDatabasesDatabaseAccountInput 

type GetDatabasesDatabaseAccountInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseAccountOutput() GetDatabasesDatabaseAccountOutput
	ToGetDatabasesDatabaseAccountOutputWithContext(context.Context) GetDatabasesDatabaseAccountOutput
}

GetDatabasesDatabaseAccountInput is an input type that accepts GetDatabasesDatabaseAccountArgs and GetDatabasesDatabaseAccountOutput values. You can construct a concrete instance of `GetDatabasesDatabaseAccountInput` via: 

GetDatabasesDatabaseAccountArgs{...}

type GetDatabasesDatabaseAccountOutput 

type GetDatabasesDatabaseAccountOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseAccountOutput) AccountName 

func (o GetDatabasesDatabaseAccountOutput) AccountName() pulumi.StringOutput

Account name.

func (GetDatabasesDatabaseAccountOutput) AccountStatus 

func (o GetDatabasesDatabaseAccountOutput) AccountStatus() pulumi.StringOutput

Account status.

func (GetDatabasesDatabaseAccountOutput) ElementType 

func (GetDatabasesDatabaseAccountOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseAccountOutput) PrivilegeStatus 

func (o GetDatabasesDatabaseAccountOutput) PrivilegeStatus() pulumi.StringOutput

The privilege status of account.

func (GetDatabasesDatabaseAccountOutput) ToGetDatabasesDatabaseAccountOutput 

func (o GetDatabasesDatabaseAccountOutput) ToGetDatabasesDatabaseAccountOutput() GetDatabasesDatabaseAccountOutput

func (GetDatabasesDatabaseAccountOutput) ToGetDatabasesDatabaseAccountOutputWithContext 

func (o GetDatabasesDatabaseAccountOutput) ToGetDatabasesDatabaseAccountOutputWithContext(ctx context.Context) GetDatabasesDatabaseAccountOutput

type GetDatabasesDatabaseArgs 

type GetDatabasesDatabaseArgs struct {
	// A list of accounts of database. Each element contains the following attributes.
	Accounts GetDatabasesDatabaseAccountArrayInput `pulumi:"accounts"`
	// The character set name of database.
	CharacterSetName pulumi.StringInput `pulumi:"characterSetName"`
	// Database description.
	DbDescription pulumi.StringInput `pulumi:"dbDescription"`
	// Database name.
	DbName pulumi.StringInput `pulumi:"dbName"`
	// The status of database.
	DbStatus pulumi.StringInput `pulumi:"dbStatus"`
	// The engine of database.
	Engine pulumi.StringInput `pulumi:"engine"`
}

func (GetDatabasesDatabaseArgs) ElementType 

func (GetDatabasesDatabaseArgs) ElementType() reflect.Type

func (GetDatabasesDatabaseArgs) ToGetDatabasesDatabaseOutput 

func (i GetDatabasesDatabaseArgs) ToGetDatabasesDatabaseOutput() GetDatabasesDatabaseOutput

func (GetDatabasesDatabaseArgs) ToGetDatabasesDatabaseOutputWithContext 

func (i GetDatabasesDatabaseArgs) ToGetDatabasesDatabaseOutputWithContext(ctx context.Context) GetDatabasesDatabaseOutput

type GetDatabasesDatabaseArray 

type GetDatabasesDatabaseArray []GetDatabasesDatabaseInput

func (GetDatabasesDatabaseArray) ElementType 

func (GetDatabasesDatabaseArray) ElementType() reflect.Type

func (GetDatabasesDatabaseArray) ToGetDatabasesDatabaseArrayOutput 

func (i GetDatabasesDatabaseArray) ToGetDatabasesDatabaseArrayOutput() GetDatabasesDatabaseArrayOutput

func (GetDatabasesDatabaseArray) ToGetDatabasesDatabaseArrayOutputWithContext 

func (i GetDatabasesDatabaseArray) ToGetDatabasesDatabaseArrayOutputWithContext(ctx context.Context) GetDatabasesDatabaseArrayOutput

type GetDatabasesDatabaseArrayInput 

type GetDatabasesDatabaseArrayInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseArrayOutput() GetDatabasesDatabaseArrayOutput
	ToGetDatabasesDatabaseArrayOutputWithContext(context.Context) GetDatabasesDatabaseArrayOutput
}

GetDatabasesDatabaseArrayInput is an input type that accepts GetDatabasesDatabaseArray and GetDatabasesDatabaseArrayOutput values. You can construct a concrete instance of `GetDatabasesDatabaseArrayInput` via: 

GetDatabasesDatabaseArray{ GetDatabasesDatabaseArgs{...} }

type GetDatabasesDatabaseArrayOutput 

type GetDatabasesDatabaseArrayOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseArrayOutput) ElementType 

func (GetDatabasesDatabaseArrayOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseArrayOutput) Index 

func (o GetDatabasesDatabaseArrayOutput) Index(i pulumi.IntInput) GetDatabasesDatabaseOutput

func (GetDatabasesDatabaseArrayOutput) ToGetDatabasesDatabaseArrayOutput 

func (o GetDatabasesDatabaseArrayOutput) ToGetDatabasesDatabaseArrayOutput() GetDatabasesDatabaseArrayOutput

func (GetDatabasesDatabaseArrayOutput) ToGetDatabasesDatabaseArrayOutputWithContext 

func (o GetDatabasesDatabaseArrayOutput) ToGetDatabasesDatabaseArrayOutputWithContext(ctx context.Context) GetDatabasesDatabaseArrayOutput

type GetDatabasesDatabaseInput 

type GetDatabasesDatabaseInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseOutput() GetDatabasesDatabaseOutput
	ToGetDatabasesDatabaseOutputWithContext(context.Context) GetDatabasesDatabaseOutput
}

GetDatabasesDatabaseInput is an input type that accepts GetDatabasesDatabaseArgs and GetDatabasesDatabaseOutput values. You can construct a concrete instance of `GetDatabasesDatabaseInput` via: 

GetDatabasesDatabaseArgs{...}

type GetDatabasesDatabaseOutput 

type GetDatabasesDatabaseOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseOutput) Accounts 

func (o GetDatabasesDatabaseOutput) Accounts() GetDatabasesDatabaseAccountArrayOutput

A list of accounts of database. Each element contains the following attributes.

func (GetDatabasesDatabaseOutput) CharacterSetName 

func (o GetDatabasesDatabaseOutput) CharacterSetName() pulumi.StringOutput

The character set name of database.

func (GetDatabasesDatabaseOutput) DbDescription 

func (o GetDatabasesDatabaseOutput) DbDescription() pulumi.StringOutput

Database description.

func (GetDatabasesDatabaseOutput) DbName 

func (o GetDatabasesDatabaseOutput) DbName() pulumi.StringOutput

Database name.

func (GetDatabasesDatabaseOutput) DbStatus 

func (o GetDatabasesDatabaseOutput) DbStatus() pulumi.StringOutput

The status of database.

func (GetDatabasesDatabaseOutput) ElementType 

func (GetDatabasesDatabaseOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseOutput) Engine 

func (o GetDatabasesDatabaseOutput) Engine() pulumi.StringOutput

The engine of database.

func (GetDatabasesDatabaseOutput) ToGetDatabasesDatabaseOutput 

func (o GetDatabasesDatabaseOutput) ToGetDatabasesDatabaseOutput() GetDatabasesDatabaseOutput

func (GetDatabasesDatabaseOutput) ToGetDatabasesDatabaseOutputWithContext 

func (o GetDatabasesDatabaseOutput) ToGetDatabasesDatabaseOutputWithContext(ctx context.Context) GetDatabasesDatabaseOutput

type GetDatabasesOutputArgs added in v3.9.0 

type GetDatabasesOutputArgs struct {
	// The polarDB cluster ID.
	DbClusterId pulumi.StringInput `pulumi:"dbClusterId"`
	// A regex string to filter results by database name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
}

A collection of arguments for invoking getDatabases.

func (GetDatabasesOutputArgs) ElementType added in v3.9.0 

func (GetDatabasesOutputArgs) ElementType() reflect.Type

type GetDatabasesResult 

type GetDatabasesResult struct {
	// A list of PolarDB cluster databases. Each element contains the following attributes:
	Databases   []GetDatabasesDatabase `pulumi:"databases"`
	DbClusterId string                 `pulumi:"dbClusterId"`
	// The provider-assigned unique ID for this managed resource.
	Id        string  `pulumi:"id"`
	NameRegex *string `pulumi:"nameRegex"`
	// database name of the cluster.
	Names []string `pulumi:"names"`
}

A collection of values returned by getDatabases.

func GetDatabases 

func GetDatabases(ctx *pulumi.Context, args *GetDatabasesArgs, opts ...pulumi.InvokeOption) (*GetDatabasesResult, error)

The `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 since v1.70.0+.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { this, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{ DbType: pulumi.StringRef("MySQL"), DbVersion: pulumi.StringRef("8.0"), PayType: "PostPaid", Category: pulumi.StringRef("Normal"), }, nil); if err != nil { return err } defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{ VpcName: pulumi.String("terraform-example"), CidrBlock: pulumi.String("172.16.0.0/16"), }) if err != nil { return err } defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{ VpcId: defaultNetwork.ID(), CidrBlock: pulumi.String("172.16.0.0/24"), ZoneId: pulumi.String(this.Classes[0].ZoneId), VswitchName: pulumi.String("terraform-example"), }) if err != nil { return err } cluster, err := polardb.NewCluster(ctx, "cluster", &polardb.ClusterArgs{ DbType: pulumi.String("MySQL"), DbVersion: pulumi.String("8.0"), PayType: pulumi.String("PostPaid"), DbNodeCount: pulumi.Int(2), DbNodeClass: pulumi.String(this.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass), VswitchId: defaultSwitch.ID(), }) if err != nil { return err } polardbClustersDs := polardb.GetClustersOutput(ctx, polardb.GetClustersOutputArgs{ DescriptionRegex: cluster.Description, Status: pulumi.String("Running"), }, nil); defaultDatabase, err := polardb.NewDatabase(ctx, "default", &polardb.DatabaseArgs{ DbClusterId: polardbClustersDs.ApplyT(func(polardbClustersDs polardb.GetClustersResult) (*string, error) { return &polardbClustersDs.Clusters[0].Id, nil }).(pulumi.StringPtrOutput), DbName: polardbClustersDs.ApplyT(func(polardbClustersDs polardb.GetClustersResult) (string, error) { return fmt.Sprintf("tfaccountpri_%v", polardbClustersDs.Clusters[0].Id), nil }).(pulumi.StringOutput), DbDescription: pulumi.String("from terraform"), }) if err != nil { return err } _default := pulumi.All(polardbClustersDs,defaultDatabase.DbName).ApplyT(func(_args []interface{}) (polardb.GetDatabasesResult, error) { polardbClustersDs := _args[0].(polardb.GetClustersResult) dbName := _args[1].(string) return polardb.GetDatabasesOutput(ctx, polardb.GetDatabasesOutputArgs{ DbClusterId: polardbClustersDs.Clusters[0].Id, NameRegex: dbName, }, nil), nil }).(polardb.GetDatabasesResultOutput) ctx.Export("database", _default.ApplyT(func(_default polardb.GetDatabasesResult) (*string, error) { return &default.Databases[0].DbName, nil }).(pulumi.StringPtrOutput)) return nil }) } ```

type GetDatabasesResultOutput added in v3.9.0 

type GetDatabasesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDatabases.

func GetDatabasesOutput added in v3.9.0 

func GetDatabasesOutput(ctx *pulumi.Context, args GetDatabasesOutputArgs, opts ...pulumi.InvokeOption) GetDatabasesResultOutput

func (GetDatabasesResultOutput) Databases added in v3.9.0 

func (o GetDatabasesResultOutput) Databases() GetDatabasesDatabaseArrayOutput

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

func (GetDatabasesResultOutput) DbClusterId added in v3.9.0 

func (o GetDatabasesResultOutput) DbClusterId() pulumi.StringOutput

func (GetDatabasesResultOutput) ElementType added in v3.9.0 

func (GetDatabasesResultOutput) ElementType() reflect.Type

func (GetDatabasesResultOutput) Id added in v3.9.0 

func (o GetDatabasesResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetDatabasesResultOutput) NameRegex added in v3.9.0 

func (o GetDatabasesResultOutput) NameRegex() pulumi.StringPtrOutput

func (GetDatabasesResultOutput) Names added in v3.9.0 

func (o GetDatabasesResultOutput) Names() pulumi.StringArrayOutput

database name of the cluster.

func (GetDatabasesResultOutput) ToGetDatabasesResultOutput added in v3.9.0 

func (o GetDatabasesResultOutput) ToGetDatabasesResultOutput() GetDatabasesResultOutput

func (GetDatabasesResultOutput) ToGetDatabasesResultOutputWithContext added in v3.9.0 

func (o GetDatabasesResultOutput) ToGetDatabasesResultOutputWithContext(ctx context.Context) GetDatabasesResultOutput

type GetEndpointsArgs 

type GetEndpointsArgs struct {
	// PolarDB cluster ID.
	DbClusterId string `pulumi:"dbClusterId"`
	// endpoint of the cluster.
	DbEndpointId *string `pulumi:"dbEndpointId"`
}

A collection of arguments for invoking getEndpoints.

type GetEndpointsEndpoint 

type GetEndpointsEndpoint struct {
	// A list of endpoint addresses. Each element contains the following attributes.
	AddressItems []GetEndpointsEndpointAddressItem `pulumi:"addressItems"`
	// Whether the new node is automatically added to the default cluster address.Options are `Enable` and `Disable`.
	AutoAddNewNodes string `pulumi:"autoAddNewNodes"`
	// endpoint of the cluster.
	DbEndpointId string `pulumi:"dbEndpointId"`
	// The Endpoint configuration. `ConsistLevel`: session consistency level, value:`0`: final consistency,`1`: session consistency;`LoadBalanceStrategy`: load balancing strategy. Based on the automatic scheduling of load, the value is: `load`.
	EndpointConfig string `pulumi:"endpointConfig"`
	// Cluster address type.`Cluster`: the default address of the Cluster.`Primary`: Primary address.`Custom`: Custom cluster addresses.
	EndpointType string `pulumi:"endpointType"`
	// A list of nodes that connect to the address configuration.
	Nodes string `pulumi:"nodes"`
	// Read-write mode:`ReadWrite`: readable and writable (automatic read-write separation).`ReadOnly`: ReadOnly.
	ReadWriteMode string `pulumi:"readWriteMode"`
}

type GetEndpointsEndpointAddressItem 

type GetEndpointsEndpointAddressItem struct {
	// Connection instance string.
	ConnectionString string `pulumi:"connectionString"`
	// The ip address of connection string.
	IpAddress string `pulumi:"ipAddress"`
	// IP network type:`Public` or `Private`.
	NetType string `pulumi:"netType"`
	// Intranet connection port.
	Port string `pulumi:"port"`
	// ID of the VPC the instance belongs to.
	VpcId string `pulumi:"vpcId"`
	// ID of the VSwitch the cluster belongs to.
	VswitchId string `pulumi:"vswitchId"`
}

type GetEndpointsEndpointAddressItemArgs 

type GetEndpointsEndpointAddressItemArgs struct {
	// Connection instance string.
	ConnectionString pulumi.StringInput `pulumi:"connectionString"`
	// The ip address of connection string.
	IpAddress pulumi.StringInput `pulumi:"ipAddress"`
	// IP network type:`Public` or `Private`.
	NetType pulumi.StringInput `pulumi:"netType"`
	// Intranet connection port.
	Port pulumi.StringInput `pulumi:"port"`
	// ID of the VPC the instance belongs to.
	VpcId pulumi.StringInput `pulumi:"vpcId"`
	// ID of the VSwitch the cluster belongs to.
	VswitchId pulumi.StringInput `pulumi:"vswitchId"`
}

func (GetEndpointsEndpointAddressItemArgs) ElementType 

func (GetEndpointsEndpointAddressItemArgs) ElementType() reflect.Type

func (GetEndpointsEndpointAddressItemArgs) ToGetEndpointsEndpointAddressItemOutput 

func (i GetEndpointsEndpointAddressItemArgs) ToGetEndpointsEndpointAddressItemOutput() GetEndpointsEndpointAddressItemOutput

func (GetEndpointsEndpointAddressItemArgs) ToGetEndpointsEndpointAddressItemOutputWithContext 

func (i GetEndpointsEndpointAddressItemArgs) ToGetEndpointsEndpointAddressItemOutputWithContext(ctx context.Context) GetEndpointsEndpointAddressItemOutput

type GetEndpointsEndpointAddressItemArray 

type GetEndpointsEndpointAddressItemArray []GetEndpointsEndpointAddressItemInput

func (GetEndpointsEndpointAddressItemArray) ElementType 

func (GetEndpointsEndpointAddressItemArray) ElementType() reflect.Type

func (GetEndpointsEndpointAddressItemArray) ToGetEndpointsEndpointAddressItemArrayOutput 

func (i GetEndpointsEndpointAddressItemArray) ToGetEndpointsEndpointAddressItemArrayOutput() GetEndpointsEndpointAddressItemArrayOutput

func (GetEndpointsEndpointAddressItemArray) ToGetEndpointsEndpointAddressItemArrayOutputWithContext 

func (i GetEndpointsEndpointAddressItemArray) ToGetEndpointsEndpointAddressItemArrayOutputWithContext(ctx context.Context) GetEndpointsEndpointAddressItemArrayOutput

type GetEndpointsEndpointAddressItemArrayInput 

type GetEndpointsEndpointAddressItemArrayInput interface {
	pulumi.Input

	ToGetEndpointsEndpointAddressItemArrayOutput() GetEndpointsEndpointAddressItemArrayOutput
	ToGetEndpointsEndpointAddressItemArrayOutputWithContext(context.Context) GetEndpointsEndpointAddressItemArrayOutput
}

GetEndpointsEndpointAddressItemArrayInput is an input type that accepts GetEndpointsEndpointAddressItemArray and GetEndpointsEndpointAddressItemArrayOutput values. You can construct a concrete instance of `GetEndpointsEndpointAddressItemArrayInput` via: 

GetEndpointsEndpointAddressItemArray{ GetEndpointsEndpointAddressItemArgs{...} }

type GetEndpointsEndpointAddressItemArrayOutput 

type GetEndpointsEndpointAddressItemArrayOutput struct{ *pulumi.OutputState }

func (GetEndpointsEndpointAddressItemArrayOutput) ElementType 

func (GetEndpointsEndpointAddressItemArrayOutput) ElementType() reflect.Type

func (GetEndpointsEndpointAddressItemArrayOutput) Index 

func (o GetEndpointsEndpointAddressItemArrayOutput) Index(i pulumi.IntInput) GetEndpointsEndpointAddressItemOutput

func (GetEndpointsEndpointAddressItemArrayOutput) ToGetEndpointsEndpointAddressItemArrayOutput 

func (o GetEndpointsEndpointAddressItemArrayOutput) ToGetEndpointsEndpointAddressItemArrayOutput() GetEndpointsEndpointAddressItemArrayOutput

func (GetEndpointsEndpointAddressItemArrayOutput) ToGetEndpointsEndpointAddressItemArrayOutputWithContext 

func (o GetEndpointsEndpointAddressItemArrayOutput) ToGetEndpointsEndpointAddressItemArrayOutputWithContext(ctx context.Context) GetEndpointsEndpointAddressItemArrayOutput

type GetEndpointsEndpointAddressItemInput 

type GetEndpointsEndpointAddressItemInput interface {
	pulumi.Input

	ToGetEndpointsEndpointAddressItemOutput() GetEndpointsEndpointAddressItemOutput
	ToGetEndpointsEndpointAddressItemOutputWithContext(context.Context) GetEndpointsEndpointAddressItemOutput
}

GetEndpointsEndpointAddressItemInput is an input type that accepts GetEndpointsEndpointAddressItemArgs and GetEndpointsEndpointAddressItemOutput values. You can construct a concrete instance of `GetEndpointsEndpointAddressItemInput` via: 

GetEndpointsEndpointAddressItemArgs{...}

type GetEndpointsEndpointAddressItemOutput 

type GetEndpointsEndpointAddressItemOutput struct{ *pulumi.OutputState }

func (GetEndpointsEndpointAddressItemOutput) ConnectionString 

func (o GetEndpointsEndpointAddressItemOutput) ConnectionString() pulumi.StringOutput

Connection instance string.

func (GetEndpointsEndpointAddressItemOutput) ElementType 

func (GetEndpointsEndpointAddressItemOutput) ElementType() reflect.Type

func (GetEndpointsEndpointAddressItemOutput) IpAddress 

func (o GetEndpointsEndpointAddressItemOutput) IpAddress() pulumi.StringOutput

The ip address of connection string.

func (GetEndpointsEndpointAddressItemOutput) NetType 

func (o GetEndpointsEndpointAddressItemOutput) NetType() pulumi.StringOutput

IP network type:`Public` or `Private`.

func (GetEndpointsEndpointAddressItemOutput) Port 

func (o GetEndpointsEndpointAddressItemOutput) Port() pulumi.StringOutput

Intranet connection port.

func (GetEndpointsEndpointAddressItemOutput) ToGetEndpointsEndpointAddressItemOutput 

func (o GetEndpointsEndpointAddressItemOutput) ToGetEndpointsEndpointAddressItemOutput() GetEndpointsEndpointAddressItemOutput

func (GetEndpointsEndpointAddressItemOutput) ToGetEndpointsEndpointAddressItemOutputWithContext 

func (o GetEndpointsEndpointAddressItemOutput) ToGetEndpointsEndpointAddressItemOutputWithContext(ctx context.Context) GetEndpointsEndpointAddressItemOutput

func (GetEndpointsEndpointAddressItemOutput) VpcId 

func (o GetEndpointsEndpointAddressItemOutput) VpcId() pulumi.StringOutput

ID of the VPC the instance belongs to.

func (GetEndpointsEndpointAddressItemOutput) VswitchId 

func (o GetEndpointsEndpointAddressItemOutput) VswitchId() pulumi.StringOutput

ID of the VSwitch the cluster belongs to.

type GetEndpointsEndpointArgs 

type GetEndpointsEndpointArgs struct {
	// A list of endpoint addresses. Each element contains the following attributes.
	AddressItems GetEndpointsEndpointAddressItemArrayInput `pulumi:"addressItems"`
	// Whether the new node is automatically added to the default cluster address.Options are `Enable` and `Disable`.
	AutoAddNewNodes pulumi.StringInput `pulumi:"autoAddNewNodes"`
	// endpoint of the cluster.
	DbEndpointId pulumi.StringInput `pulumi:"dbEndpointId"`
	// The Endpoint configuration. `ConsistLevel`: session consistency level, value:`0`: final consistency,`1`: session consistency;`LoadBalanceStrategy`: load balancing strategy. Based on the automatic scheduling of load, the value is: `load`.
	EndpointConfig pulumi.StringInput `pulumi:"endpointConfig"`
	// Cluster address type.`Cluster`: the default address of the Cluster.`Primary`: Primary address.`Custom`: Custom cluster addresses.
	EndpointType pulumi.StringInput `pulumi:"endpointType"`
	// A list of nodes that connect to the address configuration.
	Nodes pulumi.StringInput `pulumi:"nodes"`
	// Read-write mode:`ReadWrite`: readable and writable (automatic read-write separation).`ReadOnly`: ReadOnly.
	ReadWriteMode pulumi.StringInput `pulumi:"readWriteMode"`
}

func (GetEndpointsEndpointArgs) ElementType 

func (GetEndpointsEndpointArgs) ElementType() reflect.Type

func (GetEndpointsEndpointArgs) ToGetEndpointsEndpointOutput 

func (i GetEndpointsEndpointArgs) ToGetEndpointsEndpointOutput() GetEndpointsEndpointOutput

func (GetEndpointsEndpointArgs) ToGetEndpointsEndpointOutputWithContext 

func (i GetEndpointsEndpointArgs) ToGetEndpointsEndpointOutputWithContext(ctx context.Context) GetEndpointsEndpointOutput

type GetEndpointsEndpointArray 

type GetEndpointsEndpointArray []GetEndpointsEndpointInput

func (GetEndpointsEndpointArray) ElementType 

func (GetEndpointsEndpointArray) ElementType() reflect.Type

func (GetEndpointsEndpointArray) ToGetEndpointsEndpointArrayOutput 

func (i GetEndpointsEndpointArray) ToGetEndpointsEndpointArrayOutput() GetEndpointsEndpointArrayOutput

func (GetEndpointsEndpointArray) ToGetEndpointsEndpointArrayOutputWithContext 

func (i GetEndpointsEndpointArray) ToGetEndpointsEndpointArrayOutputWithContext(ctx context.Context) GetEndpointsEndpointArrayOutput

type GetEndpointsEndpointArrayInput 

type GetEndpointsEndpointArrayInput interface {
	pulumi.Input

	ToGetEndpointsEndpointArrayOutput() GetEndpointsEndpointArrayOutput
	ToGetEndpointsEndpointArrayOutputWithContext(context.Context) GetEndpointsEndpointArrayOutput
}

GetEndpointsEndpointArrayInput is an input type that accepts GetEndpointsEndpointArray and GetEndpointsEndpointArrayOutput values. You can construct a concrete instance of `GetEndpointsEndpointArrayInput` via: 

GetEndpointsEndpointArray{ GetEndpointsEndpointArgs{...} }

type GetEndpointsEndpointArrayOutput 

type GetEndpointsEndpointArrayOutput struct{ *pulumi.OutputState }

func (GetEndpointsEndpointArrayOutput) ElementType 

func (GetEndpointsEndpointArrayOutput) ElementType() reflect.Type

func (GetEndpointsEndpointArrayOutput) Index 

func (o GetEndpointsEndpointArrayOutput) Index(i pulumi.IntInput) GetEndpointsEndpointOutput

func (GetEndpointsEndpointArrayOutput) ToGetEndpointsEndpointArrayOutput 

func (o GetEndpointsEndpointArrayOutput) ToGetEndpointsEndpointArrayOutput() GetEndpointsEndpointArrayOutput

func (GetEndpointsEndpointArrayOutput) ToGetEndpointsEndpointArrayOutputWithContext 

func (o GetEndpointsEndpointArrayOutput) ToGetEndpointsEndpointArrayOutputWithContext(ctx context.Context) GetEndpointsEndpointArrayOutput

type GetEndpointsEndpointInput 

type GetEndpointsEndpointInput interface {
	pulumi.Input

	ToGetEndpointsEndpointOutput() GetEndpointsEndpointOutput
	ToGetEndpointsEndpointOutputWithContext(context.Context) GetEndpointsEndpointOutput
}

GetEndpointsEndpointInput is an input type that accepts GetEndpointsEndpointArgs and GetEndpointsEndpointOutput values. You can construct a concrete instance of `GetEndpointsEndpointInput` via: 

GetEndpointsEndpointArgs{...}

type GetEndpointsEndpointOutput 

type GetEndpointsEndpointOutput struct{ *pulumi.OutputState }

func (GetEndpointsEndpointOutput) AddressItems 

func (o GetEndpointsEndpointOutput) AddressItems() GetEndpointsEndpointAddressItemArrayOutput

A list of endpoint addresses. Each element contains the following attributes.

func (GetEndpointsEndpointOutput) AutoAddNewNodes 

func (o GetEndpointsEndpointOutput) AutoAddNewNodes() pulumi.StringOutput

Whether the new node is automatically added to the default cluster address.Options are `Enable` and `Disable`.

func (GetEndpointsEndpointOutput) DbEndpointId 

func (o GetEndpointsEndpointOutput) DbEndpointId() pulumi.StringOutput

endpoint of the cluster.

func (GetEndpointsEndpointOutput) ElementType 

func (GetEndpointsEndpointOutput) ElementType() reflect.Type

func (GetEndpointsEndpointOutput) EndpointConfig 

func (o GetEndpointsEndpointOutput) EndpointConfig() pulumi.StringOutput

The Endpoint configuration. `ConsistLevel`: session consistency level, value:`0`: final consistency,`1`: session consistency;`LoadBalanceStrategy`: load balancing strategy. Based on the automatic scheduling of load, the value is: `load`.

func (GetEndpointsEndpointOutput) EndpointType 

func (o GetEndpointsEndpointOutput) EndpointType() pulumi.StringOutput

Cluster address type.`Cluster`: the default address of the Cluster.`Primary`: Primary address.`Custom`: Custom cluster addresses.

func (GetEndpointsEndpointOutput) Nodes 

func (o GetEndpointsEndpointOutput) Nodes() pulumi.StringOutput

A list of nodes that connect to the address configuration.

func (GetEndpointsEndpointOutput) ReadWriteMode 

func (o GetEndpointsEndpointOutput) ReadWriteMode() pulumi.StringOutput

Read-write mode:`ReadWrite`: readable and writable (automatic read-write separation).`ReadOnly`: ReadOnly.

func (GetEndpointsEndpointOutput) ToGetEndpointsEndpointOutput 

func (o GetEndpointsEndpointOutput) ToGetEndpointsEndpointOutput() GetEndpointsEndpointOutput

func (GetEndpointsEndpointOutput) ToGetEndpointsEndpointOutputWithContext 

func (o GetEndpointsEndpointOutput) ToGetEndpointsEndpointOutputWithContext(ctx context.Context) GetEndpointsEndpointOutput

type GetEndpointsOutputArgs added in v3.9.0 

type GetEndpointsOutputArgs struct {
	// PolarDB cluster ID.
	DbClusterId pulumi.StringInput `pulumi:"dbClusterId"`
	// endpoint of the cluster.
	DbEndpointId pulumi.StringPtrInput `pulumi:"dbEndpointId"`
}

A collection of arguments for invoking getEndpoints.

func (GetEndpointsOutputArgs) ElementType added in v3.9.0 

func (GetEndpointsOutputArgs) ElementType() reflect.Type

type GetEndpointsResult 

type GetEndpointsResult struct {
	DbClusterId string `pulumi:"dbClusterId"`
	// The endpoint ID.
	DbEndpointId *string `pulumi:"dbEndpointId"`
	// A list of PolarDB cluster endpoints. Each element contains the following attributes:
	Endpoints []GetEndpointsEndpoint `pulumi:"endpoints"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
}

A collection of values returned by getEndpoints.

func GetEndpoints 

func GetEndpoints(ctx *pulumi.Context, args *GetEndpointsArgs, opts ...pulumi.InvokeOption) (*GetEndpointsResult, error)

The `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 since v1.68.0+.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { this, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{ DbType: pulumi.StringRef("MySQL"), DbVersion: pulumi.StringRef("8.0"), PayType: "PostPaid", Category: pulumi.StringRef("Normal"), }, nil); if err != nil { return err } defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{ VpcName: pulumi.String("terraform-example"), CidrBlock: pulumi.String("172.16.0.0/16"), }) if err != nil { return err } defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{ VpcId: defaultNetwork.ID(), CidrBlock: pulumi.String("172.16.0.0/24"), ZoneId: pulumi.String(this.Classes[0].ZoneId), VswitchName: pulumi.String("terraform-example"), }) if err != nil { return err } cluster, err := polardb.NewCluster(ctx, "cluster", &polardb.ClusterArgs{ DbType: pulumi.String("MySQL"), DbVersion: pulumi.String("8.0"), PayType: pulumi.String("PostPaid"), DbNodeCount: pulumi.Int(2), DbNodeClass: pulumi.String(this.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass), VswitchId: defaultSwitch.ID(), }) if err != nil { return err } polardbClustersDs := polardb.GetClustersOutput(ctx, polardb.GetClustersOutputArgs{ DescriptionRegex: cluster.Description, Status: pulumi.String("Running"), }, nil); _default := polardbClustersDs.ApplyT(func(polardbClustersDs polardb.GetClustersResult) (polardb.GetEndpointsResult, error) { return polardb.GetEndpointsOutput(ctx, polardb.GetEndpointsOutputArgs{ DbClusterId: polardbClustersDs.Clusters[0].Id, }, nil), nil }).(polardb.GetEndpointsResultOutput) ctx.Export("endpoint", _default.ApplyT(func(_default polardb.GetEndpointsResult) (*string, error) { return &default.Endpoints[0].DbEndpointId, nil }).(pulumi.StringPtrOutput)) return nil }) } ```

type GetEndpointsResultOutput added in v3.9.0 

type GetEndpointsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getEndpoints.

func GetEndpointsOutput added in v3.9.0 

func GetEndpointsOutput(ctx *pulumi.Context, args GetEndpointsOutputArgs, opts ...pulumi.InvokeOption) GetEndpointsResultOutput

func (GetEndpointsResultOutput) DbClusterId added in v3.9.0 

func (o GetEndpointsResultOutput) DbClusterId() pulumi.StringOutput

func (GetEndpointsResultOutput) DbEndpointId added in v3.9.0 

func (o GetEndpointsResultOutput) DbEndpointId() pulumi.StringPtrOutput

The endpoint ID.

func (GetEndpointsResultOutput) ElementType added in v3.9.0 

func (GetEndpointsResultOutput) ElementType() reflect.Type

func (GetEndpointsResultOutput) Endpoints added in v3.9.0 

func (o GetEndpointsResultOutput) Endpoints() GetEndpointsEndpointArrayOutput

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

func (GetEndpointsResultOutput) Id added in v3.9.0 

func (o GetEndpointsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetEndpointsResultOutput) ToGetEndpointsResultOutput added in v3.9.0 

func (o GetEndpointsResultOutput) ToGetEndpointsResultOutput() GetEndpointsResultOutput

func (GetEndpointsResultOutput) ToGetEndpointsResultOutputWithContext added in v3.9.0 

func (o GetEndpointsResultOutput) ToGetEndpointsResultOutputWithContext(ctx context.Context) GetEndpointsResultOutput

type GetGlobalDatabaseNetworksArgs added in v3.28.0 

type GetGlobalDatabaseNetworksArgs struct {
	// The ID of the cluster.
	DbClusterId *string `pulumi:"dbClusterId"`
	// The description of the Global Database Network.
	Description *string `pulumi:"description"`
	// The ID of the Global Database Network.
	GdnId *string `pulumi:"gdnId"`
	// A list of Global Database Network IDs.
	Ids []string `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	PageNumber *int    `pulumi:"pageNumber"`
	PageSize   *int    `pulumi:"pageSize"`
	// The status of the Global Database Network. Valid values:
	Status *string `pulumi:"status"`
}

A collection of arguments for invoking getGlobalDatabaseNetworks.

type GetGlobalDatabaseNetworksNetwork added in v3.28.0 

type GetGlobalDatabaseNetworksNetwork struct {
	// The time when the Global Database Network was created. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
	CreateTime string `pulumi:"createTime"`
	// The details of each cluster in the Global Database Network.
	DbClusters []GetGlobalDatabaseNetworksNetworkDbCluster `pulumi:"dbClusters"`
	// The type of the database engine. Only MySQL is supported.
	DbType string `pulumi:"dbType"`
	// The version number of the database engine. Only the 8.0 version is supported.
	DbVersion string `pulumi:"dbVersion"`
	// The description of the Global Database Network.
	Description string `pulumi:"description"`
	// The ID of the Global Database Network.
	GdnId string `pulumi:"gdnId"`
	// The ID of the Global Database Network.
	Id string `pulumi:"id"`
	// The status of the Global Database Network. Valid values:
	Status string `pulumi:"status"`
}

type GetGlobalDatabaseNetworksNetworkArgs added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkArgs struct {
	// The time when the Global Database Network was created. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The details of each cluster in the Global Database Network.
	DbClusters GetGlobalDatabaseNetworksNetworkDbClusterArrayInput `pulumi:"dbClusters"`
	// The type of the database engine. Only MySQL is supported.
	DbType pulumi.StringInput `pulumi:"dbType"`
	// The version number of the database engine. Only the 8.0 version is supported.
	DbVersion pulumi.StringInput `pulumi:"dbVersion"`
	// The description of the Global Database Network.
	Description pulumi.StringInput `pulumi:"description"`
	// The ID of the Global Database Network.
	GdnId pulumi.StringInput `pulumi:"gdnId"`
	// The ID of the Global Database Network.
	Id pulumi.StringInput `pulumi:"id"`
	// The status of the Global Database Network. Valid values:
	Status pulumi.StringInput `pulumi:"status"`
}

func (GetGlobalDatabaseNetworksNetworkArgs) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksNetworkArgs) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksNetworkArgs) ToGetGlobalDatabaseNetworksNetworkOutput added in v3.28.0 

func (i GetGlobalDatabaseNetworksNetworkArgs) ToGetGlobalDatabaseNetworksNetworkOutput() GetGlobalDatabaseNetworksNetworkOutput

func (GetGlobalDatabaseNetworksNetworkArgs) ToGetGlobalDatabaseNetworksNetworkOutputWithContext added in v3.28.0 

func (i GetGlobalDatabaseNetworksNetworkArgs) ToGetGlobalDatabaseNetworksNetworkOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksNetworkOutput

type GetGlobalDatabaseNetworksNetworkArray added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkArray []GetGlobalDatabaseNetworksNetworkInput

func (GetGlobalDatabaseNetworksNetworkArray) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksNetworkArray) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksNetworkArray) ToGetGlobalDatabaseNetworksNetworkArrayOutput added in v3.28.0 

func (i GetGlobalDatabaseNetworksNetworkArray) ToGetGlobalDatabaseNetworksNetworkArrayOutput() GetGlobalDatabaseNetworksNetworkArrayOutput

func (GetGlobalDatabaseNetworksNetworkArray) ToGetGlobalDatabaseNetworksNetworkArrayOutputWithContext added in v3.28.0 

func (i GetGlobalDatabaseNetworksNetworkArray) ToGetGlobalDatabaseNetworksNetworkArrayOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksNetworkArrayOutput

type GetGlobalDatabaseNetworksNetworkArrayInput added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkArrayInput interface {
	pulumi.Input

	ToGetGlobalDatabaseNetworksNetworkArrayOutput() GetGlobalDatabaseNetworksNetworkArrayOutput
	ToGetGlobalDatabaseNetworksNetworkArrayOutputWithContext(context.Context) GetGlobalDatabaseNetworksNetworkArrayOutput
}

GetGlobalDatabaseNetworksNetworkArrayInput is an input type that accepts GetGlobalDatabaseNetworksNetworkArray and GetGlobalDatabaseNetworksNetworkArrayOutput values. You can construct a concrete instance of `GetGlobalDatabaseNetworksNetworkArrayInput` via: 

GetGlobalDatabaseNetworksNetworkArray{ GetGlobalDatabaseNetworksNetworkArgs{...} }

type GetGlobalDatabaseNetworksNetworkArrayOutput added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkArrayOutput struct{ *pulumi.OutputState }

func (GetGlobalDatabaseNetworksNetworkArrayOutput) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksNetworkArrayOutput) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksNetworkArrayOutput) Index added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkArrayOutput) Index(i pulumi.IntInput) GetGlobalDatabaseNetworksNetworkOutput

func (GetGlobalDatabaseNetworksNetworkArrayOutput) ToGetGlobalDatabaseNetworksNetworkArrayOutput added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkArrayOutput) ToGetGlobalDatabaseNetworksNetworkArrayOutput() GetGlobalDatabaseNetworksNetworkArrayOutput

func (GetGlobalDatabaseNetworksNetworkArrayOutput) ToGetGlobalDatabaseNetworksNetworkArrayOutputWithContext added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkArrayOutput) ToGetGlobalDatabaseNetworksNetworkArrayOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksNetworkArrayOutput

type GetGlobalDatabaseNetworksNetworkDbCluster added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkDbCluster struct {
	// The ID of the cluster.
	DbClusterId string `pulumi:"dbClusterId"`
	// The region ID of the cluster.
	RegionId string `pulumi:"regionId"`
	// The role of the cluster.
	Role string `pulumi:"role"`
}

type GetGlobalDatabaseNetworksNetworkDbClusterArgs added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkDbClusterArgs struct {
	// The ID of the cluster.
	DbClusterId pulumi.StringInput `pulumi:"dbClusterId"`
	// The region ID of the cluster.
	RegionId pulumi.StringInput `pulumi:"regionId"`
	// The role of the cluster.
	Role pulumi.StringInput `pulumi:"role"`
}

func (GetGlobalDatabaseNetworksNetworkDbClusterArgs) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksNetworkDbClusterArgs) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksNetworkDbClusterArgs) ToGetGlobalDatabaseNetworksNetworkDbClusterOutput added in v3.28.0 

func (i GetGlobalDatabaseNetworksNetworkDbClusterArgs) ToGetGlobalDatabaseNetworksNetworkDbClusterOutput() GetGlobalDatabaseNetworksNetworkDbClusterOutput

func (GetGlobalDatabaseNetworksNetworkDbClusterArgs) ToGetGlobalDatabaseNetworksNetworkDbClusterOutputWithContext added in v3.28.0 

func (i GetGlobalDatabaseNetworksNetworkDbClusterArgs) ToGetGlobalDatabaseNetworksNetworkDbClusterOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksNetworkDbClusterOutput

type GetGlobalDatabaseNetworksNetworkDbClusterArray added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkDbClusterArray []GetGlobalDatabaseNetworksNetworkDbClusterInput

func (GetGlobalDatabaseNetworksNetworkDbClusterArray) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksNetworkDbClusterArray) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksNetworkDbClusterArray) ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutput added in v3.28.0 

func (i GetGlobalDatabaseNetworksNetworkDbClusterArray) ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutput() GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput

func (GetGlobalDatabaseNetworksNetworkDbClusterArray) ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutputWithContext added in v3.28.0 

func (i GetGlobalDatabaseNetworksNetworkDbClusterArray) ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput

type GetGlobalDatabaseNetworksNetworkDbClusterArrayInput added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkDbClusterArrayInput interface {
	pulumi.Input

	ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutput() GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput
	ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutputWithContext(context.Context) GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput
}

GetGlobalDatabaseNetworksNetworkDbClusterArrayInput is an input type that accepts GetGlobalDatabaseNetworksNetworkDbClusterArray and GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput values. You can construct a concrete instance of `GetGlobalDatabaseNetworksNetworkDbClusterArrayInput` via: 

GetGlobalDatabaseNetworksNetworkDbClusterArray{ GetGlobalDatabaseNetworksNetworkDbClusterArgs{...} }

type GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput struct{ *pulumi.OutputState }

func (GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput) Index added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput) Index(i pulumi.IntInput) GetGlobalDatabaseNetworksNetworkDbClusterOutput

func (GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput) ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutput added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput) ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutput() GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput

func (GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput) ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutputWithContext added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput) ToGetGlobalDatabaseNetworksNetworkDbClusterArrayOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput

type GetGlobalDatabaseNetworksNetworkDbClusterInput added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkDbClusterInput interface {
	pulumi.Input

	ToGetGlobalDatabaseNetworksNetworkDbClusterOutput() GetGlobalDatabaseNetworksNetworkDbClusterOutput
	ToGetGlobalDatabaseNetworksNetworkDbClusterOutputWithContext(context.Context) GetGlobalDatabaseNetworksNetworkDbClusterOutput
}

GetGlobalDatabaseNetworksNetworkDbClusterInput is an input type that accepts GetGlobalDatabaseNetworksNetworkDbClusterArgs and GetGlobalDatabaseNetworksNetworkDbClusterOutput values. You can construct a concrete instance of `GetGlobalDatabaseNetworksNetworkDbClusterInput` via: 

GetGlobalDatabaseNetworksNetworkDbClusterArgs{...}

type GetGlobalDatabaseNetworksNetworkDbClusterOutput added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkDbClusterOutput struct{ *pulumi.OutputState }

func (GetGlobalDatabaseNetworksNetworkDbClusterOutput) DbClusterId added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkDbClusterOutput) DbClusterId() pulumi.StringOutput

The ID of the cluster.

func (GetGlobalDatabaseNetworksNetworkDbClusterOutput) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksNetworkDbClusterOutput) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksNetworkDbClusterOutput) RegionId added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkDbClusterOutput) RegionId() pulumi.StringOutput

The region ID of the cluster.

func (GetGlobalDatabaseNetworksNetworkDbClusterOutput) Role added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkDbClusterOutput) Role() pulumi.StringOutput

The role of the cluster.

func (GetGlobalDatabaseNetworksNetworkDbClusterOutput) ToGetGlobalDatabaseNetworksNetworkDbClusterOutput added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkDbClusterOutput) ToGetGlobalDatabaseNetworksNetworkDbClusterOutput() GetGlobalDatabaseNetworksNetworkDbClusterOutput

func (GetGlobalDatabaseNetworksNetworkDbClusterOutput) ToGetGlobalDatabaseNetworksNetworkDbClusterOutputWithContext added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkDbClusterOutput) ToGetGlobalDatabaseNetworksNetworkDbClusterOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksNetworkDbClusterOutput

type GetGlobalDatabaseNetworksNetworkInput added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkInput interface {
	pulumi.Input

	ToGetGlobalDatabaseNetworksNetworkOutput() GetGlobalDatabaseNetworksNetworkOutput
	ToGetGlobalDatabaseNetworksNetworkOutputWithContext(context.Context) GetGlobalDatabaseNetworksNetworkOutput
}

GetGlobalDatabaseNetworksNetworkInput is an input type that accepts GetGlobalDatabaseNetworksNetworkArgs and GetGlobalDatabaseNetworksNetworkOutput values. You can construct a concrete instance of `GetGlobalDatabaseNetworksNetworkInput` via: 

GetGlobalDatabaseNetworksNetworkArgs{...}

type GetGlobalDatabaseNetworksNetworkOutput added in v3.28.0 

type GetGlobalDatabaseNetworksNetworkOutput struct{ *pulumi.OutputState }

func (GetGlobalDatabaseNetworksNetworkOutput) CreateTime added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) CreateTime() pulumi.StringOutput

The time when the Global Database Network was created. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

func (GetGlobalDatabaseNetworksNetworkOutput) DbClusters added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) DbClusters() GetGlobalDatabaseNetworksNetworkDbClusterArrayOutput

The details of each cluster in the Global Database Network.

func (GetGlobalDatabaseNetworksNetworkOutput) DbType added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) DbType() pulumi.StringOutput

The type of the database engine. Only MySQL is supported.

func (GetGlobalDatabaseNetworksNetworkOutput) DbVersion added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) DbVersion() pulumi.StringOutput

The version number of the database engine. Only the 8.0 version is supported.

func (GetGlobalDatabaseNetworksNetworkOutput) Description added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) Description() pulumi.StringOutput

The description of the Global Database Network.

func (GetGlobalDatabaseNetworksNetworkOutput) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksNetworkOutput) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksNetworkOutput) GdnId added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) GdnId() pulumi.StringOutput

The ID of the Global Database Network.

func (GetGlobalDatabaseNetworksNetworkOutput) Id added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) Id() pulumi.StringOutput

The ID of the Global Database Network.

func (GetGlobalDatabaseNetworksNetworkOutput) Status added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) Status() pulumi.StringOutput

The status of the Global Database Network. Valid values:

func (GetGlobalDatabaseNetworksNetworkOutput) ToGetGlobalDatabaseNetworksNetworkOutput added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) ToGetGlobalDatabaseNetworksNetworkOutput() GetGlobalDatabaseNetworksNetworkOutput

func (GetGlobalDatabaseNetworksNetworkOutput) ToGetGlobalDatabaseNetworksNetworkOutputWithContext added in v3.28.0 

func (o GetGlobalDatabaseNetworksNetworkOutput) ToGetGlobalDatabaseNetworksNetworkOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksNetworkOutput

type GetGlobalDatabaseNetworksOutputArgs added in v3.28.0 

type GetGlobalDatabaseNetworksOutputArgs struct {
	// The ID of the cluster.
	DbClusterId pulumi.StringPtrInput `pulumi:"dbClusterId"`
	// The description of the Global Database Network.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// The ID of the Global Database Network.
	GdnId pulumi.StringPtrInput `pulumi:"gdnId"`
	// A list of Global Database Network IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	PageNumber pulumi.IntPtrInput    `pulumi:"pageNumber"`
	PageSize   pulumi.IntPtrInput    `pulumi:"pageSize"`
	// The status of the Global Database Network. Valid values:
	Status pulumi.StringPtrInput `pulumi:"status"`
}

A collection of arguments for invoking getGlobalDatabaseNetworks.

func (GetGlobalDatabaseNetworksOutputArgs) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksOutputArgs) ElementType() reflect.Type

type GetGlobalDatabaseNetworksResult added in v3.28.0 

type GetGlobalDatabaseNetworksResult struct {
	// The ID of the PolarDB cluster.
	DbClusterId *string `pulumi:"dbClusterId"`
	// The description of the Global Database Network.
	Description *string `pulumi:"description"`
	// The ID of the Global Database Network.
	GdnId *string `pulumi:"gdnId"`
	// The provider-assigned unique ID for this managed resource.
	Id  string   `pulumi:"id"`
	Ids []string `pulumi:"ids"`
	// A list of PolarDB Global Database Networks. Each element contains the following attributes:
	Networks   []GetGlobalDatabaseNetworksNetwork `pulumi:"networks"`
	OutputFile *string                            `pulumi:"outputFile"`
	PageNumber *int                               `pulumi:"pageNumber"`
	PageSize   *int                               `pulumi:"pageSize"`
	// The status of the Global Database Network.
	Status *string `pulumi:"status"`
}

A collection of values returned by getGlobalDatabaseNetworks.

func GetGlobalDatabaseNetworks added in v3.28.0 

func GetGlobalDatabaseNetworks(ctx *pulumi.Context, args *GetGlobalDatabaseNetworksArgs, opts ...pulumi.InvokeOption) (*GetGlobalDatabaseNetworksResult, error)

This data source provides the PolarDB Global Database Networks of the current Alibaba Cloud user.

> **NOTE:** Available since v1.181.0+.

## Example Usage

Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
			Category:  pulumi.StringRef("Normal"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       _default.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(this.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		cluster, err := polardb.NewCluster(ctx, "cluster", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			PayType:     pulumi.String("PostPaid"),
			DbNodeCount: pulumi.Int(2),
			DbNodeClass: pulumi.String(this.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			VswitchId:   defaultSwitch.ID(),
		})
		if err != nil {
			return err
		}
		defaultGlobalDatabaseNetwork, err := polardb.NewGlobalDatabaseNetwork(ctx, "default", &polardb.GlobalDatabaseNetworkArgs{
			DbClusterId: cluster.ID(),
			Description: cluster.ID(),
		})
		if err != nil {
			return err
		}
		ids := polardb.GetGlobalDatabaseNetworksOutput(ctx, polardb.GetGlobalDatabaseNetworksOutputArgs{
			Ids: pulumi.StringArray{
				defaultGlobalDatabaseNetwork.ID(),
			},
		}, nil)
		ctx.Export("polardbGlobalDatabaseNetworkId1", ids.ApplyT(func(ids polardb.GetGlobalDatabaseNetworksResult) (*string, error) {
			return &ids.Networks[0].Id, nil
		}).(pulumi.StringPtrOutput))
		description := polardb.GetGlobalDatabaseNetworksOutput(ctx, polardb.GetGlobalDatabaseNetworksOutputArgs{
			Description: defaultGlobalDatabaseNetwork.Description,
		}, nil)
		ctx.Export("polardbGlobalDatabaseNetworkId2", description.ApplyT(func(description polardb.GetGlobalDatabaseNetworksResult) (*string, error) {
			return &description.Networks[0].Id, nil
		}).(pulumi.StringPtrOutput))
		return nil
	})
}

```

type GetGlobalDatabaseNetworksResultOutput added in v3.28.0 

type GetGlobalDatabaseNetworksResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getGlobalDatabaseNetworks.

func GetGlobalDatabaseNetworksOutput added in v3.28.0 

func GetGlobalDatabaseNetworksOutput(ctx *pulumi.Context, args GetGlobalDatabaseNetworksOutputArgs, opts ...pulumi.InvokeOption) GetGlobalDatabaseNetworksResultOutput

func (GetGlobalDatabaseNetworksResultOutput) DbClusterId added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) DbClusterId() pulumi.StringPtrOutput

The ID of the PolarDB cluster.

func (GetGlobalDatabaseNetworksResultOutput) Description added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) Description() pulumi.StringPtrOutput

The description of the Global Database Network.

func (GetGlobalDatabaseNetworksResultOutput) ElementType added in v3.28.0 

func (GetGlobalDatabaseNetworksResultOutput) ElementType() reflect.Type

func (GetGlobalDatabaseNetworksResultOutput) GdnId added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) GdnId() pulumi.StringPtrOutput

The ID of the Global Database Network.

func (GetGlobalDatabaseNetworksResultOutput) Id added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetGlobalDatabaseNetworksResultOutput) Ids added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) Ids() pulumi.StringArrayOutput

func (GetGlobalDatabaseNetworksResultOutput) Networks added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) Networks() GetGlobalDatabaseNetworksNetworkArrayOutput

A list of PolarDB Global Database Networks. Each element contains the following attributes:

func (GetGlobalDatabaseNetworksResultOutput) OutputFile added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) OutputFile() pulumi.StringPtrOutput

func (GetGlobalDatabaseNetworksResultOutput) PageNumber added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) PageNumber() pulumi.IntPtrOutput

func (GetGlobalDatabaseNetworksResultOutput) PageSize added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) PageSize() pulumi.IntPtrOutput

func (GetGlobalDatabaseNetworksResultOutput) Status added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) Status() pulumi.StringPtrOutput

The status of the Global Database Network.

func (GetGlobalDatabaseNetworksResultOutput) ToGetGlobalDatabaseNetworksResultOutput added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) ToGetGlobalDatabaseNetworksResultOutput() GetGlobalDatabaseNetworksResultOutput

func (GetGlobalDatabaseNetworksResultOutput) ToGetGlobalDatabaseNetworksResultOutputWithContext added in v3.28.0 

func (o GetGlobalDatabaseNetworksResultOutput) ToGetGlobalDatabaseNetworksResultOutputWithContext(ctx context.Context) GetGlobalDatabaseNetworksResultOutput

type GetNodeClassesArgs 

type GetNodeClassesArgs struct {
	// The PolarDB node cluster series.
	Category *string `pulumi:"category"`
	// The PolarDB node class type by the user.
	DbNodeClass *string `pulumi:"dbNodeClass"`
	// Database type. Options are `MySQL`, `PostgreSQL`, `Oracle`. If dbType is set, dbVersion also needs to be set.
	DbType *string `pulumi:"dbType"`
	// Database version required by the user. Value options can refer to the latest docs [detail info](https://www.alibabacloud.com/help/doc-detail/98169.htm) `DBVersion`. If dbVersion is set, dbType also needs to be set.
	DbVersion *string `pulumi:"dbVersion"`
	// File name where to save data source results (after running `pulumi up`).
	OutputFile *string `pulumi:"outputFile"`
	// Filter the results by charge type. Valid values: `PrePaid` and `PostPaid`.
	PayType string `pulumi:"payType"`
	// The Region to launch the PolarDB cluster.
	RegionId *string `pulumi:"regionId"`
	// The Zone to launch the PolarDB cluster.
	ZoneId *string `pulumi:"zoneId"`
}

A collection of arguments for invoking getNodeClasses.

type GetNodeClassesClass 

type GetNodeClassesClass struct {
	// A list of PolarDB node classes in the zone.
	SupportedEngines []GetNodeClassesClassSupportedEngine `pulumi:"supportedEngines"`
	// The Zone to launch the PolarDB cluster.
	ZoneId string `pulumi:"zoneId"`
}

type GetNodeClassesClassArgs 

type GetNodeClassesClassArgs struct {
	// A list of PolarDB node classes in the zone.
	SupportedEngines GetNodeClassesClassSupportedEngineArrayInput `pulumi:"supportedEngines"`
	// The Zone to launch the PolarDB cluster.
	ZoneId pulumi.StringInput `pulumi:"zoneId"`
}

func (GetNodeClassesClassArgs) ElementType 

func (GetNodeClassesClassArgs) ElementType() reflect.Type

func (GetNodeClassesClassArgs) ToGetNodeClassesClassOutput 

func (i GetNodeClassesClassArgs) ToGetNodeClassesClassOutput() GetNodeClassesClassOutput

func (GetNodeClassesClassArgs) ToGetNodeClassesClassOutputWithContext 

func (i GetNodeClassesClassArgs) ToGetNodeClassesClassOutputWithContext(ctx context.Context) GetNodeClassesClassOutput

type GetNodeClassesClassArray 

type GetNodeClassesClassArray []GetNodeClassesClassInput

func (GetNodeClassesClassArray) ElementType 

func (GetNodeClassesClassArray) ElementType() reflect.Type

func (GetNodeClassesClassArray) ToGetNodeClassesClassArrayOutput 

func (i GetNodeClassesClassArray) ToGetNodeClassesClassArrayOutput() GetNodeClassesClassArrayOutput

func (GetNodeClassesClassArray) ToGetNodeClassesClassArrayOutputWithContext 

func (i GetNodeClassesClassArray) ToGetNodeClassesClassArrayOutputWithContext(ctx context.Context) GetNodeClassesClassArrayOutput

type GetNodeClassesClassArrayInput 

type GetNodeClassesClassArrayInput interface {
	pulumi.Input

	ToGetNodeClassesClassArrayOutput() GetNodeClassesClassArrayOutput
	ToGetNodeClassesClassArrayOutputWithContext(context.Context) GetNodeClassesClassArrayOutput
}

GetNodeClassesClassArrayInput is an input type that accepts GetNodeClassesClassArray and GetNodeClassesClassArrayOutput values. You can construct a concrete instance of `GetNodeClassesClassArrayInput` via: 

GetNodeClassesClassArray{ GetNodeClassesClassArgs{...} }

type GetNodeClassesClassArrayOutput 

type GetNodeClassesClassArrayOutput struct{ *pulumi.OutputState }

func (GetNodeClassesClassArrayOutput) ElementType 

func (GetNodeClassesClassArrayOutput) ElementType() reflect.Type

func (GetNodeClassesClassArrayOutput) Index 

func (o GetNodeClassesClassArrayOutput) Index(i pulumi.IntInput) GetNodeClassesClassOutput

func (GetNodeClassesClassArrayOutput) ToGetNodeClassesClassArrayOutput 

func (o GetNodeClassesClassArrayOutput) ToGetNodeClassesClassArrayOutput() GetNodeClassesClassArrayOutput

func (GetNodeClassesClassArrayOutput) ToGetNodeClassesClassArrayOutputWithContext 

func (o GetNodeClassesClassArrayOutput) ToGetNodeClassesClassArrayOutputWithContext(ctx context.Context) GetNodeClassesClassArrayOutput

type GetNodeClassesClassInput 

type GetNodeClassesClassInput interface {
	pulumi.Input

	ToGetNodeClassesClassOutput() GetNodeClassesClassOutput
	ToGetNodeClassesClassOutputWithContext(context.Context) GetNodeClassesClassOutput
}

GetNodeClassesClassInput is an input type that accepts GetNodeClassesClassArgs and GetNodeClassesClassOutput values. You can construct a concrete instance of `GetNodeClassesClassInput` via: 

GetNodeClassesClassArgs{...}

type GetNodeClassesClassOutput 

type GetNodeClassesClassOutput struct{ *pulumi.OutputState }

func (GetNodeClassesClassOutput) ElementType 

func (GetNodeClassesClassOutput) ElementType() reflect.Type

func (GetNodeClassesClassOutput) SupportedEngines 

func (o GetNodeClassesClassOutput) SupportedEngines() GetNodeClassesClassSupportedEngineArrayOutput

A list of PolarDB node classes in the zone.

func (GetNodeClassesClassOutput) ToGetNodeClassesClassOutput 

func (o GetNodeClassesClassOutput) ToGetNodeClassesClassOutput() GetNodeClassesClassOutput

func (GetNodeClassesClassOutput) ToGetNodeClassesClassOutputWithContext 

func (o GetNodeClassesClassOutput) ToGetNodeClassesClassOutputWithContext(ctx context.Context) GetNodeClassesClassOutput

func (GetNodeClassesClassOutput) ZoneId 

func (o GetNodeClassesClassOutput) ZoneId() pulumi.StringOutput

The Zone to launch the PolarDB cluster.

type GetNodeClassesClassSupportedEngine 

type GetNodeClassesClassSupportedEngine struct {
	// A list of PolarDB node available classes.
	AvailableResources []GetNodeClassesClassSupportedEngineAvailableResource `pulumi:"availableResources"`
	// In the zone, the database type supports classes in the following available_resources.
	Engine string `pulumi:"engine"`
}

type GetNodeClassesClassSupportedEngineArgs 

type GetNodeClassesClassSupportedEngineArgs struct {
	// A list of PolarDB node available classes.
	AvailableResources GetNodeClassesClassSupportedEngineAvailableResourceArrayInput `pulumi:"availableResources"`
	// In the zone, the database type supports classes in the following available_resources.
	Engine pulumi.StringInput `pulumi:"engine"`
}

func (GetNodeClassesClassSupportedEngineArgs) ElementType 

func (GetNodeClassesClassSupportedEngineArgs) ElementType() reflect.Type

func (GetNodeClassesClassSupportedEngineArgs) ToGetNodeClassesClassSupportedEngineOutput 

func (i GetNodeClassesClassSupportedEngineArgs) ToGetNodeClassesClassSupportedEngineOutput() GetNodeClassesClassSupportedEngineOutput

func (GetNodeClassesClassSupportedEngineArgs) ToGetNodeClassesClassSupportedEngineOutputWithContext 

func (i GetNodeClassesClassSupportedEngineArgs) ToGetNodeClassesClassSupportedEngineOutputWithContext(ctx context.Context) GetNodeClassesClassSupportedEngineOutput

type GetNodeClassesClassSupportedEngineArray 

type GetNodeClassesClassSupportedEngineArray []GetNodeClassesClassSupportedEngineInput

func (GetNodeClassesClassSupportedEngineArray) ElementType 

func (GetNodeClassesClassSupportedEngineArray) ElementType() reflect.Type

func (GetNodeClassesClassSupportedEngineArray) ToGetNodeClassesClassSupportedEngineArrayOutput 

func (i GetNodeClassesClassSupportedEngineArray) ToGetNodeClassesClassSupportedEngineArrayOutput() GetNodeClassesClassSupportedEngineArrayOutput

func (GetNodeClassesClassSupportedEngineArray) ToGetNodeClassesClassSupportedEngineArrayOutputWithContext 

func (i GetNodeClassesClassSupportedEngineArray) ToGetNodeClassesClassSupportedEngineArrayOutputWithContext(ctx context.Context) GetNodeClassesClassSupportedEngineArrayOutput

type GetNodeClassesClassSupportedEngineArrayInput 

type GetNodeClassesClassSupportedEngineArrayInput interface {
	pulumi.Input

	ToGetNodeClassesClassSupportedEngineArrayOutput() GetNodeClassesClassSupportedEngineArrayOutput
	ToGetNodeClassesClassSupportedEngineArrayOutputWithContext(context.Context) GetNodeClassesClassSupportedEngineArrayOutput
}

GetNodeClassesClassSupportedEngineArrayInput is an input type that accepts GetNodeClassesClassSupportedEngineArray and GetNodeClassesClassSupportedEngineArrayOutput values. You can construct a concrete instance of `GetNodeClassesClassSupportedEngineArrayInput` via: 

GetNodeClassesClassSupportedEngineArray{ GetNodeClassesClassSupportedEngineArgs{...} }

type GetNodeClassesClassSupportedEngineArrayOutput 

type GetNodeClassesClassSupportedEngineArrayOutput struct{ *pulumi.OutputState }

func (GetNodeClassesClassSupportedEngineArrayOutput) ElementType 

func (GetNodeClassesClassSupportedEngineArrayOutput) ElementType() reflect.Type

func (GetNodeClassesClassSupportedEngineArrayOutput) Index 

func (o GetNodeClassesClassSupportedEngineArrayOutput) Index(i pulumi.IntInput) GetNodeClassesClassSupportedEngineOutput

func (GetNodeClassesClassSupportedEngineArrayOutput) ToGetNodeClassesClassSupportedEngineArrayOutput 

func (o GetNodeClassesClassSupportedEngineArrayOutput) ToGetNodeClassesClassSupportedEngineArrayOutput() GetNodeClassesClassSupportedEngineArrayOutput

func (GetNodeClassesClassSupportedEngineArrayOutput) ToGetNodeClassesClassSupportedEngineArrayOutputWithContext 

func (o GetNodeClassesClassSupportedEngineArrayOutput) ToGetNodeClassesClassSupportedEngineArrayOutputWithContext(ctx context.Context) GetNodeClassesClassSupportedEngineArrayOutput

type GetNodeClassesClassSupportedEngineAvailableResource 

type GetNodeClassesClassSupportedEngineAvailableResource struct {
	// The PolarDB node class type by the user.
	DbNodeClass string `pulumi:"dbNodeClass"`
}

type GetNodeClassesClassSupportedEngineAvailableResourceArgs 

type GetNodeClassesClassSupportedEngineAvailableResourceArgs struct {
	// The PolarDB node class type by the user.
	DbNodeClass pulumi.StringInput `pulumi:"dbNodeClass"`
}

func (GetNodeClassesClassSupportedEngineAvailableResourceArgs) ElementType 

func (GetNodeClassesClassSupportedEngineAvailableResourceArgs) ElementType() reflect.Type

func (GetNodeClassesClassSupportedEngineAvailableResourceArgs) ToGetNodeClassesClassSupportedEngineAvailableResourceOutput 

func (i GetNodeClassesClassSupportedEngineAvailableResourceArgs) ToGetNodeClassesClassSupportedEngineAvailableResourceOutput() GetNodeClassesClassSupportedEngineAvailableResourceOutput

func (GetNodeClassesClassSupportedEngineAvailableResourceArgs) ToGetNodeClassesClassSupportedEngineAvailableResourceOutputWithContext 

func (i GetNodeClassesClassSupportedEngineAvailableResourceArgs) ToGetNodeClassesClassSupportedEngineAvailableResourceOutputWithContext(ctx context.Context) GetNodeClassesClassSupportedEngineAvailableResourceOutput

type GetNodeClassesClassSupportedEngineAvailableResourceArray 

type GetNodeClassesClassSupportedEngineAvailableResourceArray []GetNodeClassesClassSupportedEngineAvailableResourceInput

func (GetNodeClassesClassSupportedEngineAvailableResourceArray) ElementType 

func (GetNodeClassesClassSupportedEngineAvailableResourceArray) ElementType() reflect.Type

func (GetNodeClassesClassSupportedEngineAvailableResourceArray) ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutput 

func (i GetNodeClassesClassSupportedEngineAvailableResourceArray) ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutput() GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput

func (GetNodeClassesClassSupportedEngineAvailableResourceArray) ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutputWithContext 

func (i GetNodeClassesClassSupportedEngineAvailableResourceArray) ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutputWithContext(ctx context.Context) GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput

type GetNodeClassesClassSupportedEngineAvailableResourceArrayInput 

type GetNodeClassesClassSupportedEngineAvailableResourceArrayInput interface {
	pulumi.Input

	ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutput() GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput
	ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutputWithContext(context.Context) GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput
}

GetNodeClassesClassSupportedEngineAvailableResourceArrayInput is an input type that accepts GetNodeClassesClassSupportedEngineAvailableResourceArray and GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput values. You can construct a concrete instance of `GetNodeClassesClassSupportedEngineAvailableResourceArrayInput` via: 

GetNodeClassesClassSupportedEngineAvailableResourceArray{ GetNodeClassesClassSupportedEngineAvailableResourceArgs{...} }

type GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput 

type GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput struct{ *pulumi.OutputState }

func (GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput) ElementType 

func (GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput) ElementType() reflect.Type

func (GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput) Index 

func (o GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput) Index(i pulumi.IntInput) GetNodeClassesClassSupportedEngineAvailableResourceOutput

func (GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput) ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutput 

func (o GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput) ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutput() GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput

func (GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput) ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutputWithContext 

func (o GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput) ToGetNodeClassesClassSupportedEngineAvailableResourceArrayOutputWithContext(ctx context.Context) GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput

type GetNodeClassesClassSupportedEngineAvailableResourceInput 

type GetNodeClassesClassSupportedEngineAvailableResourceInput interface {
	pulumi.Input

	ToGetNodeClassesClassSupportedEngineAvailableResourceOutput() GetNodeClassesClassSupportedEngineAvailableResourceOutput
	ToGetNodeClassesClassSupportedEngineAvailableResourceOutputWithContext(context.Context) GetNodeClassesClassSupportedEngineAvailableResourceOutput
}

GetNodeClassesClassSupportedEngineAvailableResourceInput is an input type that accepts GetNodeClassesClassSupportedEngineAvailableResourceArgs and GetNodeClassesClassSupportedEngineAvailableResourceOutput values. You can construct a concrete instance of `GetNodeClassesClassSupportedEngineAvailableResourceInput` via: 

GetNodeClassesClassSupportedEngineAvailableResourceArgs{...}

type GetNodeClassesClassSupportedEngineAvailableResourceOutput 

type GetNodeClassesClassSupportedEngineAvailableResourceOutput struct{ *pulumi.OutputState }

func (GetNodeClassesClassSupportedEngineAvailableResourceOutput) DbNodeClass 

func (o GetNodeClassesClassSupportedEngineAvailableResourceOutput) DbNodeClass() pulumi.StringOutput

The PolarDB node class type by the user.

func (GetNodeClassesClassSupportedEngineAvailableResourceOutput) ElementType 

func (GetNodeClassesClassSupportedEngineAvailableResourceOutput) ElementType() reflect.Type

func (GetNodeClassesClassSupportedEngineAvailableResourceOutput) ToGetNodeClassesClassSupportedEngineAvailableResourceOutput 

func (o GetNodeClassesClassSupportedEngineAvailableResourceOutput) ToGetNodeClassesClassSupportedEngineAvailableResourceOutput() GetNodeClassesClassSupportedEngineAvailableResourceOutput

func (GetNodeClassesClassSupportedEngineAvailableResourceOutput) ToGetNodeClassesClassSupportedEngineAvailableResourceOutputWithContext 

func (o GetNodeClassesClassSupportedEngineAvailableResourceOutput) ToGetNodeClassesClassSupportedEngineAvailableResourceOutputWithContext(ctx context.Context) GetNodeClassesClassSupportedEngineAvailableResourceOutput

type GetNodeClassesClassSupportedEngineInput 

type GetNodeClassesClassSupportedEngineInput interface {
	pulumi.Input

	ToGetNodeClassesClassSupportedEngineOutput() GetNodeClassesClassSupportedEngineOutput
	ToGetNodeClassesClassSupportedEngineOutputWithContext(context.Context) GetNodeClassesClassSupportedEngineOutput
}

GetNodeClassesClassSupportedEngineInput is an input type that accepts GetNodeClassesClassSupportedEngineArgs and GetNodeClassesClassSupportedEngineOutput values. You can construct a concrete instance of `GetNodeClassesClassSupportedEngineInput` via: 

GetNodeClassesClassSupportedEngineArgs{...}

type GetNodeClassesClassSupportedEngineOutput 

type GetNodeClassesClassSupportedEngineOutput struct{ *pulumi.OutputState }

func (GetNodeClassesClassSupportedEngineOutput) AvailableResources 

func (o GetNodeClassesClassSupportedEngineOutput) AvailableResources() GetNodeClassesClassSupportedEngineAvailableResourceArrayOutput

A list of PolarDB node available classes.

func (GetNodeClassesClassSupportedEngineOutput) ElementType 

func (GetNodeClassesClassSupportedEngineOutput) ElementType() reflect.Type

func (GetNodeClassesClassSupportedEngineOutput) Engine 

func (o GetNodeClassesClassSupportedEngineOutput) Engine() pulumi.StringOutput

In the zone, the database type supports classes in the following available_resources.

func (GetNodeClassesClassSupportedEngineOutput) ToGetNodeClassesClassSupportedEngineOutput 

func (o GetNodeClassesClassSupportedEngineOutput) ToGetNodeClassesClassSupportedEngineOutput() GetNodeClassesClassSupportedEngineOutput

func (GetNodeClassesClassSupportedEngineOutput) ToGetNodeClassesClassSupportedEngineOutputWithContext 

func (o GetNodeClassesClassSupportedEngineOutput) ToGetNodeClassesClassSupportedEngineOutputWithContext(ctx context.Context) GetNodeClassesClassSupportedEngineOutput

type GetNodeClassesOutputArgs added in v3.9.0 

type GetNodeClassesOutputArgs struct {
	// The PolarDB node cluster series.
	Category pulumi.StringPtrInput `pulumi:"category"`
	// The PolarDB node class type by the user.
	DbNodeClass pulumi.StringPtrInput `pulumi:"dbNodeClass"`
	// Database type. Options are `MySQL`, `PostgreSQL`, `Oracle`. If dbType is set, dbVersion also needs to be set.
	DbType pulumi.StringPtrInput `pulumi:"dbType"`
	// Database version required by the user. Value options can refer to the latest docs [detail info](https://www.alibabacloud.com/help/doc-detail/98169.htm) `DBVersion`. If dbVersion is set, dbType also needs to be set.
	DbVersion pulumi.StringPtrInput `pulumi:"dbVersion"`
	// File name where to save data source results (after running `pulumi up`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// Filter the results by charge type. Valid values: `PrePaid` and `PostPaid`.
	PayType pulumi.StringInput `pulumi:"payType"`
	// The Region to launch the PolarDB cluster.
	RegionId pulumi.StringPtrInput `pulumi:"regionId"`
	// The Zone to launch the PolarDB cluster.
	ZoneId pulumi.StringPtrInput `pulumi:"zoneId"`
}

A collection of arguments for invoking getNodeClasses.

func (GetNodeClassesOutputArgs) ElementType added in v3.9.0 

func (GetNodeClassesOutputArgs) ElementType() reflect.Type

type GetNodeClassesResult 

type GetNodeClassesResult struct {
	Category *string `pulumi:"category"`
	// A list of PolarDB node classes. Each element contains the following attributes:
	Classes []GetNodeClassesClass `pulumi:"classes"`
	// PolarDB node available class.
	DbNodeClass *string `pulumi:"dbNodeClass"`
	DbType      *string `pulumi:"dbType"`
	DbVersion   *string `pulumi:"dbVersion"`
	// The provider-assigned unique ID for this managed resource.
	Id         string  `pulumi:"id"`
	OutputFile *string `pulumi:"outputFile"`
	PayType    string  `pulumi:"payType"`
	RegionId   *string `pulumi:"regionId"`
	// The Zone to launch the PolarDB cluster.
	ZoneId *string `pulumi:"zoneId"`
}

A collection of values returned by getNodeClasses.

func GetNodeClasses 

func GetNodeClasses(ctx *pulumi.Context, args *GetNodeClassesArgs, opts ...pulumi.InvokeOption) (*GetNodeClassesResult, error)

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

> **NOTE:** Available since v1.81.0+

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		resources, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			PayType:   "PostPaid",
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("5.6"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("polardbNodeClasses", resources.Classes)
		ctx.Export("polardbAvailableZoneId", resources.Classes[0].ZoneId)
		return nil
	})
}

```

type GetNodeClassesResultOutput added in v3.9.0 

type GetNodeClassesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getNodeClasses.

func GetNodeClassesOutput added in v3.9.0 

func GetNodeClassesOutput(ctx *pulumi.Context, args GetNodeClassesOutputArgs, opts ...pulumi.InvokeOption) GetNodeClassesResultOutput

func (GetNodeClassesResultOutput) Category added in v3.36.0 

func (o GetNodeClassesResultOutput) Category() pulumi.StringPtrOutput

func (GetNodeClassesResultOutput) Classes added in v3.9.0 

func (o GetNodeClassesResultOutput) Classes() GetNodeClassesClassArrayOutput

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

func (GetNodeClassesResultOutput) DbNodeClass added in v3.9.0 

func (o GetNodeClassesResultOutput) DbNodeClass() pulumi.StringPtrOutput

PolarDB node available class.

func (GetNodeClassesResultOutput) DbType added in v3.9.0 

func (o GetNodeClassesResultOutput) DbType() pulumi.StringPtrOutput

func (GetNodeClassesResultOutput) DbVersion added in v3.9.0 

func (o GetNodeClassesResultOutput) DbVersion() pulumi.StringPtrOutput

func (GetNodeClassesResultOutput) ElementType added in v3.9.0 

func (GetNodeClassesResultOutput) ElementType() reflect.Type

func (GetNodeClassesResultOutput) Id added in v3.9.0 

func (o GetNodeClassesResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetNodeClassesResultOutput) OutputFile added in v3.9.0 

func (o GetNodeClassesResultOutput) OutputFile() pulumi.StringPtrOutput

func (GetNodeClassesResultOutput) PayType added in v3.9.0 

func (o GetNodeClassesResultOutput) PayType() pulumi.StringOutput

func (GetNodeClassesResultOutput) RegionId added in v3.9.0 

func (o GetNodeClassesResultOutput) RegionId() pulumi.StringPtrOutput

func (GetNodeClassesResultOutput) ToGetNodeClassesResultOutput added in v3.9.0 

func (o GetNodeClassesResultOutput) ToGetNodeClassesResultOutput() GetNodeClassesResultOutput

func (GetNodeClassesResultOutput) ToGetNodeClassesResultOutputWithContext added in v3.9.0 

func (o GetNodeClassesResultOutput) ToGetNodeClassesResultOutputWithContext(ctx context.Context) GetNodeClassesResultOutput

func (GetNodeClassesResultOutput) ZoneId added in v3.9.0 

func (o GetNodeClassesResultOutput) ZoneId() pulumi.StringPtrOutput

The Zone to launch the PolarDB cluster.

type GetParameterGroupsArgs added in v3.29.0 

type GetParameterGroupsArgs struct {
	// The type of the database engine. Only `MySQL` is supported.
	DbType *string `pulumi:"dbType"`
	// The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.
	DbVersion *string `pulumi:"dbVersion"`
	// A list of Parameter Group IDs.
	Ids []string `pulumi:"ids"`
	// A regex string to filter results by Parameter Group name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
}

A collection of arguments for invoking getParameterGroups.

type GetParameterGroupsGroup added in v3.29.0 

type GetParameterGroupsGroup struct {
	// The time when the parameter template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	CreateTime string `pulumi:"createTime"`
	// The type of the database engine. Only `MySQL` is supported.
	DbType string `pulumi:"dbType"`
	// The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.
	DbVersion string `pulumi:"dbVersion"`
	// Indicates whether to restart the cluster when this parameter template is applied.
	ForceRestart string `pulumi:"forceRestart"`
	// The ID of the Parameter Group.
	Id string `pulumi:"id"`
	// The number of parameters in the parameter template.
	ParameterCounts int `pulumi:"parameterCounts"`
	// The description of the parameter template.
	ParameterGroupDesc string `pulumi:"parameterGroupDesc"`
	// The ID of the Parameter Group.
	ParameterGroupId string `pulumi:"parameterGroupId"`
	// The name of the parameter template.
	ParameterGroupName string `pulumi:"parameterGroupName"`
	// The type of the parameter template.
	ParameterGroupType string `pulumi:"parameterGroupType"`
}

type GetParameterGroupsGroupArgs added in v3.29.0 

type GetParameterGroupsGroupArgs struct {
	// The time when the parameter template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The type of the database engine. Only `MySQL` is supported.
	DbType pulumi.StringInput `pulumi:"dbType"`
	// The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.
	DbVersion pulumi.StringInput `pulumi:"dbVersion"`
	// Indicates whether to restart the cluster when this parameter template is applied.
	ForceRestart pulumi.StringInput `pulumi:"forceRestart"`
	// The ID of the Parameter Group.
	Id pulumi.StringInput `pulumi:"id"`
	// The number of parameters in the parameter template.
	ParameterCounts pulumi.IntInput `pulumi:"parameterCounts"`
	// The description of the parameter template.
	ParameterGroupDesc pulumi.StringInput `pulumi:"parameterGroupDesc"`
	// The ID of the Parameter Group.
	ParameterGroupId pulumi.StringInput `pulumi:"parameterGroupId"`
	// The name of the parameter template.
	ParameterGroupName pulumi.StringInput `pulumi:"parameterGroupName"`
	// The type of the parameter template.
	ParameterGroupType pulumi.StringInput `pulumi:"parameterGroupType"`
}

func (GetParameterGroupsGroupArgs) ElementType added in v3.29.0 

func (GetParameterGroupsGroupArgs) ElementType() reflect.Type

func (GetParameterGroupsGroupArgs) ToGetParameterGroupsGroupOutput added in v3.29.0 

func (i GetParameterGroupsGroupArgs) ToGetParameterGroupsGroupOutput() GetParameterGroupsGroupOutput

func (GetParameterGroupsGroupArgs) ToGetParameterGroupsGroupOutputWithContext added in v3.29.0 

func (i GetParameterGroupsGroupArgs) ToGetParameterGroupsGroupOutputWithContext(ctx context.Context) GetParameterGroupsGroupOutput

type GetParameterGroupsGroupArray added in v3.29.0 

type GetParameterGroupsGroupArray []GetParameterGroupsGroupInput

func (GetParameterGroupsGroupArray) ElementType added in v3.29.0 

func (GetParameterGroupsGroupArray) ElementType() reflect.Type

func (GetParameterGroupsGroupArray) ToGetParameterGroupsGroupArrayOutput added in v3.29.0 

func (i GetParameterGroupsGroupArray) ToGetParameterGroupsGroupArrayOutput() GetParameterGroupsGroupArrayOutput

func (GetParameterGroupsGroupArray) ToGetParameterGroupsGroupArrayOutputWithContext added in v3.29.0 

func (i GetParameterGroupsGroupArray) ToGetParameterGroupsGroupArrayOutputWithContext(ctx context.Context) GetParameterGroupsGroupArrayOutput

type GetParameterGroupsGroupArrayInput added in v3.29.0 

type GetParameterGroupsGroupArrayInput interface {
	pulumi.Input

	ToGetParameterGroupsGroupArrayOutput() GetParameterGroupsGroupArrayOutput
	ToGetParameterGroupsGroupArrayOutputWithContext(context.Context) GetParameterGroupsGroupArrayOutput
}

GetParameterGroupsGroupArrayInput is an input type that accepts GetParameterGroupsGroupArray and GetParameterGroupsGroupArrayOutput values. You can construct a concrete instance of `GetParameterGroupsGroupArrayInput` via: 

GetParameterGroupsGroupArray{ GetParameterGroupsGroupArgs{...} }

type GetParameterGroupsGroupArrayOutput added in v3.29.0 

type GetParameterGroupsGroupArrayOutput struct{ *pulumi.OutputState }

func (GetParameterGroupsGroupArrayOutput) ElementType added in v3.29.0 

func (GetParameterGroupsGroupArrayOutput) ElementType() reflect.Type

func (GetParameterGroupsGroupArrayOutput) Index added in v3.29.0 

func (o GetParameterGroupsGroupArrayOutput) Index(i pulumi.IntInput) GetParameterGroupsGroupOutput

func (GetParameterGroupsGroupArrayOutput) ToGetParameterGroupsGroupArrayOutput added in v3.29.0 

func (o GetParameterGroupsGroupArrayOutput) ToGetParameterGroupsGroupArrayOutput() GetParameterGroupsGroupArrayOutput

func (GetParameterGroupsGroupArrayOutput) ToGetParameterGroupsGroupArrayOutputWithContext added in v3.29.0 

func (o GetParameterGroupsGroupArrayOutput) ToGetParameterGroupsGroupArrayOutputWithContext(ctx context.Context) GetParameterGroupsGroupArrayOutput

type GetParameterGroupsGroupInput added in v3.29.0 

type GetParameterGroupsGroupInput interface {
	pulumi.Input

	ToGetParameterGroupsGroupOutput() GetParameterGroupsGroupOutput
	ToGetParameterGroupsGroupOutputWithContext(context.Context) GetParameterGroupsGroupOutput
}

GetParameterGroupsGroupInput is an input type that accepts GetParameterGroupsGroupArgs and GetParameterGroupsGroupOutput values. You can construct a concrete instance of `GetParameterGroupsGroupInput` via: 

GetParameterGroupsGroupArgs{...}

type GetParameterGroupsGroupOutput added in v3.29.0 

type GetParameterGroupsGroupOutput struct{ *pulumi.OutputState }

func (GetParameterGroupsGroupOutput) CreateTime added in v3.29.0 

func (o GetParameterGroupsGroupOutput) CreateTime() pulumi.StringOutput

The time when the parameter template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

func (GetParameterGroupsGroupOutput) DbType added in v3.29.0 

func (o GetParameterGroupsGroupOutput) DbType() pulumi.StringOutput

The type of the database engine. Only `MySQL` is supported.

func (GetParameterGroupsGroupOutput) DbVersion added in v3.29.0 

func (o GetParameterGroupsGroupOutput) DbVersion() pulumi.StringOutput

The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.

func (GetParameterGroupsGroupOutput) ElementType added in v3.29.0 

func (GetParameterGroupsGroupOutput) ElementType() reflect.Type

func (GetParameterGroupsGroupOutput) ForceRestart added in v3.29.0 

func (o GetParameterGroupsGroupOutput) ForceRestart() pulumi.StringOutput

Indicates whether to restart the cluster when this parameter template is applied.

func (GetParameterGroupsGroupOutput) Id added in v3.29.0 

func (o GetParameterGroupsGroupOutput) Id() pulumi.StringOutput

The ID of the Parameter Group.

func (GetParameterGroupsGroupOutput) ParameterCounts added in v3.29.0 

func (o GetParameterGroupsGroupOutput) ParameterCounts() pulumi.IntOutput

The number of parameters in the parameter template.

func (GetParameterGroupsGroupOutput) ParameterGroupDesc added in v3.29.0 

func (o GetParameterGroupsGroupOutput) ParameterGroupDesc() pulumi.StringOutput

The description of the parameter template.

func (GetParameterGroupsGroupOutput) ParameterGroupId added in v3.29.0 

func (o GetParameterGroupsGroupOutput) ParameterGroupId() pulumi.StringOutput

The ID of the Parameter Group.

func (GetParameterGroupsGroupOutput) ParameterGroupName added in v3.29.0 

func (o GetParameterGroupsGroupOutput) ParameterGroupName() pulumi.StringOutput

The name of the parameter template.

func (GetParameterGroupsGroupOutput) ParameterGroupType added in v3.29.0 

func (o GetParameterGroupsGroupOutput) ParameterGroupType() pulumi.StringOutput

The type of the parameter template.

func (GetParameterGroupsGroupOutput) ToGetParameterGroupsGroupOutput added in v3.29.0 

func (o GetParameterGroupsGroupOutput) ToGetParameterGroupsGroupOutput() GetParameterGroupsGroupOutput

func (GetParameterGroupsGroupOutput) ToGetParameterGroupsGroupOutputWithContext added in v3.29.0 

func (o GetParameterGroupsGroupOutput) ToGetParameterGroupsGroupOutputWithContext(ctx context.Context) GetParameterGroupsGroupOutput

type GetParameterGroupsOutputArgs added in v3.29.0 

type GetParameterGroupsOutputArgs struct {
	// The type of the database engine. Only `MySQL` is supported.
	DbType pulumi.StringPtrInput `pulumi:"dbType"`
	// The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.
	DbVersion pulumi.StringPtrInput `pulumi:"dbVersion"`
	// A list of Parameter Group IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// A regex string to filter results by Parameter Group name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
}

A collection of arguments for invoking getParameterGroups.

func (GetParameterGroupsOutputArgs) ElementType added in v3.29.0 

func (GetParameterGroupsOutputArgs) ElementType() reflect.Type

type GetParameterGroupsResult added in v3.29.0 

type GetParameterGroupsResult struct {
	// The type of the database engine.
	DbType *string `pulumi:"dbType"`
	// The version number of the database engine.
	DbVersion *string `pulumi:"dbVersion"`
	// A list of PolarDB Parameter Groups. Each element contains the following attributes:
	Groups []GetParameterGroupsGroup `pulumi:"groups"`
	// The provider-assigned unique ID for this managed resource.
	Id        string   `pulumi:"id"`
	Ids       []string `pulumi:"ids"`
	NameRegex *string  `pulumi:"nameRegex"`
	// A list of Parameter Group names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
}

A collection of values returned by getParameterGroups.

func GetParameterGroups added in v3.29.0 

func GetParameterGroups(ctx *pulumi.Context, args *GetParameterGroupsArgs, opts ...pulumi.InvokeOption) (*GetParameterGroupsResult, error)

This data source provides the PolarDB Parameter Groups of the current Alibaba Cloud user.

> **NOTE:** Available since v1.183.0+.

## Example Usage

Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _default, err := polardb.GetParameterGroups(ctx, &polardb.GetParameterGroupsArgs{ DbType: pulumi.StringRef("MySQL"), DbVersion: pulumi.StringRef("8.0"), }, nil); if err != nil { return err } ids, err := polardb.GetParameterGroups(ctx, &polardb.GetParameterGroupsArgs{ Ids: interface{}{ _default.Groups[0].Id, }, }, nil); if err != nil { return err } ctx.Export("polardbParameterGroupId1", ids.Groups[0].Id) nameRegex, err := polardb.GetParameterGroups(ctx, &polardb.GetParameterGroupsArgs{ NameRegex: pulumi.StringRef(_default.Groups[0].ParameterGroupName), }, nil); if err != nil { return err } ctx.Export("polardbParameterGroupId2", nameRegex.Groups[0].Id) return nil }) } ```

type GetParameterGroupsResultOutput added in v3.29.0 

type GetParameterGroupsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getParameterGroups.

func GetParameterGroupsOutput added in v3.29.0 

func GetParameterGroupsOutput(ctx *pulumi.Context, args GetParameterGroupsOutputArgs, opts ...pulumi.InvokeOption) GetParameterGroupsResultOutput

func (GetParameterGroupsResultOutput) DbType added in v3.29.0 

func (o GetParameterGroupsResultOutput) DbType() pulumi.StringPtrOutput

The type of the database engine.

func (GetParameterGroupsResultOutput) DbVersion added in v3.29.0 

func (o GetParameterGroupsResultOutput) DbVersion() pulumi.StringPtrOutput

The version number of the database engine.

func (GetParameterGroupsResultOutput) ElementType added in v3.29.0 

func (GetParameterGroupsResultOutput) ElementType() reflect.Type

func (GetParameterGroupsResultOutput) Groups added in v3.29.0 

func (o GetParameterGroupsResultOutput) Groups() GetParameterGroupsGroupArrayOutput

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

func (GetParameterGroupsResultOutput) Id added in v3.29.0 

func (o GetParameterGroupsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetParameterGroupsResultOutput) Ids added in v3.29.0 

func (o GetParameterGroupsResultOutput) Ids() pulumi.StringArrayOutput

func (GetParameterGroupsResultOutput) NameRegex added in v3.29.0 

func (o GetParameterGroupsResultOutput) NameRegex() pulumi.StringPtrOutput

func (GetParameterGroupsResultOutput) Names added in v3.29.0 

func (o GetParameterGroupsResultOutput) Names() pulumi.StringArrayOutput

A list of Parameter Group names.

func (GetParameterGroupsResultOutput) OutputFile added in v3.29.0 

func (o GetParameterGroupsResultOutput) OutputFile() pulumi.StringPtrOutput

func (GetParameterGroupsResultOutput) ToGetParameterGroupsResultOutput added in v3.29.0 

func (o GetParameterGroupsResultOutput) ToGetParameterGroupsResultOutput() GetParameterGroupsResultOutput

func (GetParameterGroupsResultOutput) ToGetParameterGroupsResultOutputWithContext added in v3.29.0 

func (o GetParameterGroupsResultOutput) ToGetParameterGroupsResultOutputWithContext(ctx context.Context) GetParameterGroupsResultOutput

type GetZonesArgs 

type GetZonesArgs struct {
	// Indicate whether the zones can be used in a multi AZ configuration. Default to `false`. Multi AZ is usually used to launch PolarDB instances.
	Multi *bool `pulumi:"multi"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
}

A collection of arguments for invoking getZones.

type GetZonesOutputArgs added in v3.9.0 

type GetZonesOutputArgs struct {
	// Indicate whether the zones can be used in a multi AZ configuration. Default to `false`. Multi AZ is usually used to launch PolarDB instances.
	Multi pulumi.BoolPtrInput `pulumi:"multi"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
}

A collection of arguments for invoking getZones.

func (GetZonesOutputArgs) ElementType added in v3.9.0 

func (GetZonesOutputArgs) ElementType() reflect.Type

type GetZonesResult 

type GetZonesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of zone IDs.
	Ids        []string `pulumi:"ids"`
	Multi      *bool    `pulumi:"multi"`
	OutputFile *string  `pulumi:"outputFile"`
	// A list of availability zones. Each element contains the following attributes:
	Zones []GetZonesZone `pulumi:"zones"`
}

A collection of values returned by getZones.

func GetZones 

func GetZones(ctx *pulumi.Context, args *GetZonesArgs, opts ...pulumi.InvokeOption) (*GetZonesResult, error)

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

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Declare the data source
		_, err := polardb.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetZonesResultOutput added in v3.9.0 

type GetZonesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getZones.

func GetZonesOutput added in v3.9.0 

func GetZonesOutput(ctx *pulumi.Context, args GetZonesOutputArgs, opts ...pulumi.InvokeOption) GetZonesResultOutput

func (GetZonesResultOutput) ElementType added in v3.9.0 

func (GetZonesResultOutput) ElementType() reflect.Type

func (GetZonesResultOutput) Id added in v3.9.0 

func (o GetZonesResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetZonesResultOutput) Ids added in v3.9.0 

func (o GetZonesResultOutput) Ids() pulumi.StringArrayOutput

A list of zone IDs.

func (GetZonesResultOutput) Multi added in v3.9.0 

func (o GetZonesResultOutput) Multi() pulumi.BoolPtrOutput

func (GetZonesResultOutput) OutputFile added in v3.9.0 

func (o GetZonesResultOutput) OutputFile() pulumi.StringPtrOutput

func (GetZonesResultOutput) ToGetZonesResultOutput added in v3.9.0 

func (o GetZonesResultOutput) ToGetZonesResultOutput() GetZonesResultOutput

func (GetZonesResultOutput) ToGetZonesResultOutputWithContext added in v3.9.0 

func (o GetZonesResultOutput) ToGetZonesResultOutputWithContext(ctx context.Context) GetZonesResultOutput

func (GetZonesResultOutput) Zones added in v3.9.0 

func (o GetZonesResultOutput) Zones() GetZonesZoneArrayOutput

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

type GetZonesZone 

type GetZonesZone struct {
	// ID of the zone.
	Id string `pulumi:"id"`
	// A list of zone ids in which the multi zone.
	MultiZoneIds []string `pulumi:"multiZoneIds"`
}

type GetZonesZoneArgs 

type GetZonesZoneArgs struct {
	// ID of the zone.
	Id pulumi.StringInput `pulumi:"id"`
	// A list of zone ids in which the multi zone.
	MultiZoneIds pulumi.StringArrayInput `pulumi:"multiZoneIds"`
}

func (GetZonesZoneArgs) ElementType 

func (GetZonesZoneArgs) ElementType() reflect.Type

func (GetZonesZoneArgs) ToGetZonesZoneOutput 

func (i GetZonesZoneArgs) ToGetZonesZoneOutput() GetZonesZoneOutput

func (GetZonesZoneArgs) ToGetZonesZoneOutputWithContext 

func (i GetZonesZoneArgs) ToGetZonesZoneOutputWithContext(ctx context.Context) GetZonesZoneOutput

type GetZonesZoneArray 

type GetZonesZoneArray []GetZonesZoneInput

func (GetZonesZoneArray) ElementType 

func (GetZonesZoneArray) ElementType() reflect.Type

func (GetZonesZoneArray) ToGetZonesZoneArrayOutput 

func (i GetZonesZoneArray) ToGetZonesZoneArrayOutput() GetZonesZoneArrayOutput

func (GetZonesZoneArray) ToGetZonesZoneArrayOutputWithContext 

func (i GetZonesZoneArray) ToGetZonesZoneArrayOutputWithContext(ctx context.Context) GetZonesZoneArrayOutput

type GetZonesZoneArrayInput 

type GetZonesZoneArrayInput interface {
	pulumi.Input

	ToGetZonesZoneArrayOutput() GetZonesZoneArrayOutput
	ToGetZonesZoneArrayOutputWithContext(context.Context) GetZonesZoneArrayOutput
}

GetZonesZoneArrayInput is an input type that accepts GetZonesZoneArray and GetZonesZoneArrayOutput values. You can construct a concrete instance of `GetZonesZoneArrayInput` via: 

GetZonesZoneArray{ GetZonesZoneArgs{...} }

type GetZonesZoneArrayOutput 

type GetZonesZoneArrayOutput struct{ *pulumi.OutputState }

func (GetZonesZoneArrayOutput) ElementType 

func (GetZonesZoneArrayOutput) ElementType() reflect.Type

func (GetZonesZoneArrayOutput) Index 

func (o GetZonesZoneArrayOutput) Index(i pulumi.IntInput) GetZonesZoneOutput

func (GetZonesZoneArrayOutput) ToGetZonesZoneArrayOutput 

func (o GetZonesZoneArrayOutput) ToGetZonesZoneArrayOutput() GetZonesZoneArrayOutput

func (GetZonesZoneArrayOutput) ToGetZonesZoneArrayOutputWithContext 

func (o GetZonesZoneArrayOutput) ToGetZonesZoneArrayOutputWithContext(ctx context.Context) GetZonesZoneArrayOutput

type GetZonesZoneInput 

type GetZonesZoneInput interface {
	pulumi.Input

	ToGetZonesZoneOutput() GetZonesZoneOutput
	ToGetZonesZoneOutputWithContext(context.Context) GetZonesZoneOutput
}

GetZonesZoneInput is an input type that accepts GetZonesZoneArgs and GetZonesZoneOutput values. You can construct a concrete instance of `GetZonesZoneInput` via: 

GetZonesZoneArgs{...}

type GetZonesZoneOutput 

type GetZonesZoneOutput struct{ *pulumi.OutputState }

func (GetZonesZoneOutput) ElementType 

func (GetZonesZoneOutput) ElementType() reflect.Type

func (GetZonesZoneOutput) Id 

func (o GetZonesZoneOutput) Id() pulumi.StringOutput

ID of the zone.

func (GetZonesZoneOutput) MultiZoneIds 

func (o GetZonesZoneOutput) MultiZoneIds() pulumi.StringArrayOutput

A list of zone ids in which the multi zone.

func (GetZonesZoneOutput) ToGetZonesZoneOutput 

func (o GetZonesZoneOutput) ToGetZonesZoneOutput() GetZonesZoneOutput

func (GetZonesZoneOutput) ToGetZonesZoneOutputWithContext 

func (o GetZonesZoneOutput) ToGetZonesZoneOutputWithContext(ctx context.Context) GetZonesZoneOutput

type GlobalDatabaseNetwork added in v3.28.0 

type GlobalDatabaseNetwork struct {
	pulumi.CustomResourceState

	// The ID of the primary cluster.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// The description of the Global Database Network.
	Description pulumi.StringOutput `pulumi:"description"`
	// The status of the Global Database Network.
	Status pulumi.StringOutput `pulumi:"status"`
}

Provides a PolarDB Global Database Network resource.

For information about PolarDB Global Database Network and how to use it, see [What is Global Database Network](https://www.alibabacloud.com/help/en/polardb/api-polardb-2017-08-01-createglobaldatabasenetwork).

> **NOTE:** Available since v1.181.0+.

## Example Usage

Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			Category:  pulumi.StringRef("Normal"),
			PayType:   "PostPaid",
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewGlobalDatabaseNetwork(ctx, "default", &polardb.GlobalDatabaseNetworkArgs{
			DbClusterId: defaultCluster.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

PolarDB Global Database Network can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/globalDatabaseNetwork:GlobalDatabaseNetwork example <id> ```

func GetGlobalDatabaseNetwork added in v3.28.0 

func GetGlobalDatabaseNetwork(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GlobalDatabaseNetworkState, opts ...pulumi.ResourceOption) (*GlobalDatabaseNetwork, error)

GetGlobalDatabaseNetwork gets an existing GlobalDatabaseNetwork resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGlobalDatabaseNetwork added in v3.28.0 

func NewGlobalDatabaseNetwork(ctx *pulumi.Context,
	name string, args *GlobalDatabaseNetworkArgs, opts ...pulumi.ResourceOption) (*GlobalDatabaseNetwork, error)

NewGlobalDatabaseNetwork registers a new resource with the given unique name, arguments, and options.

func (*GlobalDatabaseNetwork) ElementType added in v3.28.0 

func (*GlobalDatabaseNetwork) ElementType() reflect.Type

func (*GlobalDatabaseNetwork) ToGlobalDatabaseNetworkOutput added in v3.28.0 

func (i *GlobalDatabaseNetwork) ToGlobalDatabaseNetworkOutput() GlobalDatabaseNetworkOutput

func (*GlobalDatabaseNetwork) ToGlobalDatabaseNetworkOutputWithContext added in v3.28.0 

func (i *GlobalDatabaseNetwork) ToGlobalDatabaseNetworkOutputWithContext(ctx context.Context) GlobalDatabaseNetworkOutput

type GlobalDatabaseNetworkArgs added in v3.28.0 

type GlobalDatabaseNetworkArgs struct {
	// The ID of the primary cluster.
	DbClusterId pulumi.StringInput
	// The description of the Global Database Network.
	Description pulumi.StringPtrInput
}

The set of arguments for constructing a GlobalDatabaseNetwork resource.

func (GlobalDatabaseNetworkArgs) ElementType added in v3.28.0 

func (GlobalDatabaseNetworkArgs) ElementType() reflect.Type

type GlobalDatabaseNetworkArray added in v3.28.0 

type GlobalDatabaseNetworkArray []GlobalDatabaseNetworkInput

func (GlobalDatabaseNetworkArray) ElementType added in v3.28.0 

func (GlobalDatabaseNetworkArray) ElementType() reflect.Type

func (GlobalDatabaseNetworkArray) ToGlobalDatabaseNetworkArrayOutput added in v3.28.0 

func (i GlobalDatabaseNetworkArray) ToGlobalDatabaseNetworkArrayOutput() GlobalDatabaseNetworkArrayOutput

func (GlobalDatabaseNetworkArray) ToGlobalDatabaseNetworkArrayOutputWithContext added in v3.28.0 

func (i GlobalDatabaseNetworkArray) ToGlobalDatabaseNetworkArrayOutputWithContext(ctx context.Context) GlobalDatabaseNetworkArrayOutput

type GlobalDatabaseNetworkArrayInput added in v3.28.0 

type GlobalDatabaseNetworkArrayInput interface {
	pulumi.Input

	ToGlobalDatabaseNetworkArrayOutput() GlobalDatabaseNetworkArrayOutput
	ToGlobalDatabaseNetworkArrayOutputWithContext(context.Context) GlobalDatabaseNetworkArrayOutput
}

GlobalDatabaseNetworkArrayInput is an input type that accepts GlobalDatabaseNetworkArray and GlobalDatabaseNetworkArrayOutput values. You can construct a concrete instance of `GlobalDatabaseNetworkArrayInput` via: 

GlobalDatabaseNetworkArray{ GlobalDatabaseNetworkArgs{...} }

type GlobalDatabaseNetworkArrayOutput added in v3.28.0 

type GlobalDatabaseNetworkArrayOutput struct{ *pulumi.OutputState }

func (GlobalDatabaseNetworkArrayOutput) ElementType added in v3.28.0 

func (GlobalDatabaseNetworkArrayOutput) ElementType() reflect.Type

func (GlobalDatabaseNetworkArrayOutput) Index added in v3.28.0 

func (o GlobalDatabaseNetworkArrayOutput) Index(i pulumi.IntInput) GlobalDatabaseNetworkOutput

func (GlobalDatabaseNetworkArrayOutput) ToGlobalDatabaseNetworkArrayOutput added in v3.28.0 

func (o GlobalDatabaseNetworkArrayOutput) ToGlobalDatabaseNetworkArrayOutput() GlobalDatabaseNetworkArrayOutput

func (GlobalDatabaseNetworkArrayOutput) ToGlobalDatabaseNetworkArrayOutputWithContext added in v3.28.0 

func (o GlobalDatabaseNetworkArrayOutput) ToGlobalDatabaseNetworkArrayOutputWithContext(ctx context.Context) GlobalDatabaseNetworkArrayOutput

type GlobalDatabaseNetworkInput added in v3.28.0 

type GlobalDatabaseNetworkInput interface {
	pulumi.Input

	ToGlobalDatabaseNetworkOutput() GlobalDatabaseNetworkOutput
	ToGlobalDatabaseNetworkOutputWithContext(ctx context.Context) GlobalDatabaseNetworkOutput
}

type GlobalDatabaseNetworkMap added in v3.28.0 

type GlobalDatabaseNetworkMap map[string]GlobalDatabaseNetworkInput

func (GlobalDatabaseNetworkMap) ElementType added in v3.28.0 

func (GlobalDatabaseNetworkMap) ElementType() reflect.Type

func (GlobalDatabaseNetworkMap) ToGlobalDatabaseNetworkMapOutput added in v3.28.0 

func (i GlobalDatabaseNetworkMap) ToGlobalDatabaseNetworkMapOutput() GlobalDatabaseNetworkMapOutput

func (GlobalDatabaseNetworkMap) ToGlobalDatabaseNetworkMapOutputWithContext added in v3.28.0 

func (i GlobalDatabaseNetworkMap) ToGlobalDatabaseNetworkMapOutputWithContext(ctx context.Context) GlobalDatabaseNetworkMapOutput

type GlobalDatabaseNetworkMapInput added in v3.28.0 

type GlobalDatabaseNetworkMapInput interface {
	pulumi.Input

	ToGlobalDatabaseNetworkMapOutput() GlobalDatabaseNetworkMapOutput
	ToGlobalDatabaseNetworkMapOutputWithContext(context.Context) GlobalDatabaseNetworkMapOutput
}

GlobalDatabaseNetworkMapInput is an input type that accepts GlobalDatabaseNetworkMap and GlobalDatabaseNetworkMapOutput values. You can construct a concrete instance of `GlobalDatabaseNetworkMapInput` via: 

GlobalDatabaseNetworkMap{ "key": GlobalDatabaseNetworkArgs{...} }

type GlobalDatabaseNetworkMapOutput added in v3.28.0 

type GlobalDatabaseNetworkMapOutput struct{ *pulumi.OutputState }

func (GlobalDatabaseNetworkMapOutput) ElementType added in v3.28.0 

func (GlobalDatabaseNetworkMapOutput) ElementType() reflect.Type

func (GlobalDatabaseNetworkMapOutput) MapIndex added in v3.28.0 

func (o GlobalDatabaseNetworkMapOutput) MapIndex(k pulumi.StringInput) GlobalDatabaseNetworkOutput

func (GlobalDatabaseNetworkMapOutput) ToGlobalDatabaseNetworkMapOutput added in v3.28.0 

func (o GlobalDatabaseNetworkMapOutput) ToGlobalDatabaseNetworkMapOutput() GlobalDatabaseNetworkMapOutput

func (GlobalDatabaseNetworkMapOutput) ToGlobalDatabaseNetworkMapOutputWithContext added in v3.28.0 

func (o GlobalDatabaseNetworkMapOutput) ToGlobalDatabaseNetworkMapOutputWithContext(ctx context.Context) GlobalDatabaseNetworkMapOutput

type GlobalDatabaseNetworkOutput added in v3.28.0 

type GlobalDatabaseNetworkOutput struct{ *pulumi.OutputState }

func (GlobalDatabaseNetworkOutput) DbClusterId added in v3.28.0 

func (o GlobalDatabaseNetworkOutput) DbClusterId() pulumi.StringOutput

The ID of the primary cluster.

func (GlobalDatabaseNetworkOutput) Description added in v3.28.0 

func (o GlobalDatabaseNetworkOutput) Description() pulumi.StringOutput

The description of the Global Database Network.

func (GlobalDatabaseNetworkOutput) ElementType added in v3.28.0 

func (GlobalDatabaseNetworkOutput) ElementType() reflect.Type

func (GlobalDatabaseNetworkOutput) Status added in v3.28.0 

func (o GlobalDatabaseNetworkOutput) Status() pulumi.StringOutput

The status of the Global Database Network.

func (GlobalDatabaseNetworkOutput) ToGlobalDatabaseNetworkOutput added in v3.28.0 

func (o GlobalDatabaseNetworkOutput) ToGlobalDatabaseNetworkOutput() GlobalDatabaseNetworkOutput

func (GlobalDatabaseNetworkOutput) ToGlobalDatabaseNetworkOutputWithContext added in v3.28.0 

func (o GlobalDatabaseNetworkOutput) ToGlobalDatabaseNetworkOutputWithContext(ctx context.Context) GlobalDatabaseNetworkOutput

type GlobalDatabaseNetworkState added in v3.28.0 

type GlobalDatabaseNetworkState struct {
	// The ID of the primary cluster.
	DbClusterId pulumi.StringPtrInput
	// The description of the Global Database Network.
	Description pulumi.StringPtrInput
	// The status of the Global Database Network.
	Status pulumi.StringPtrInput
}

func (GlobalDatabaseNetworkState) ElementType added in v3.28.0 

func (GlobalDatabaseNetworkState) ElementType() reflect.Type

type ParameterGroup added in v3.29.0 

type ParameterGroup struct {
	pulumi.CustomResourceState

	// The type of the database engine. Only `MySQL` is supported.
	DbType pulumi.StringOutput `pulumi:"dbType"`
	// The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.
	DbVersion pulumi.StringOutput `pulumi:"dbVersion"`
	// The description of the parameter template. It must be 0 to 200 characters in length.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
	Name pulumi.StringOutput `pulumi:"name"`
	// The parameter template. See the following `Block parameters`.
	Parameters ParameterGroupParameterArrayOutput `pulumi:"parameters"`
}

Provides a PolarDB Parameter Group resource.

For information about PolarDB Parameter Group and how to use it, see [What is Parameter Group](https://www.alibabacloud.com/help/en/polardb/polardb-for-mysql/user-guide/apply-a-parameter-template).

> **NOTE:** Available in v1.183.0+.

## Example Usage

Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := polardb.NewParameterGroup(ctx, "example", &polardb.ParameterGroupArgs{
			Name:      pulumi.String("example_value"),
			DbType:    pulumi.String("MySQL"),
			DbVersion: pulumi.String("8.0"),
			Parameters: polardb.ParameterGroupParameterArray{
				&polardb.ParameterGroupParameterArgs{
					ParamName:  pulumi.String("wait_timeout"),
					ParamValue: pulumi.String("86400"),
				},
			},
			Description: pulumi.String("example_value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

PolarDB Parameter Group can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/parameterGroup:ParameterGroup example <id> ```

func GetParameterGroup added in v3.29.0 

func GetParameterGroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ParameterGroupState, opts ...pulumi.ResourceOption) (*ParameterGroup, error)

GetParameterGroup gets an existing ParameterGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewParameterGroup added in v3.29.0 

func NewParameterGroup(ctx *pulumi.Context,
	name string, args *ParameterGroupArgs, opts ...pulumi.ResourceOption) (*ParameterGroup, error)

NewParameterGroup registers a new resource with the given unique name, arguments, and options.

func (*ParameterGroup) ElementType added in v3.29.0 

func (*ParameterGroup) ElementType() reflect.Type

func (*ParameterGroup) ToParameterGroupOutput added in v3.29.0 

func (i *ParameterGroup) ToParameterGroupOutput() ParameterGroupOutput

func (*ParameterGroup) ToParameterGroupOutputWithContext added in v3.29.0 

func (i *ParameterGroup) ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput

type ParameterGroupArgs added in v3.29.0 

type ParameterGroupArgs struct {
	// The type of the database engine. Only `MySQL` is supported.
	DbType pulumi.StringInput
	// The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.
	DbVersion pulumi.StringInput
	// The description of the parameter template. It must be 0 to 200 characters in length.
	Description pulumi.StringPtrInput
	// The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
	Name pulumi.StringPtrInput
	// The parameter template. See the following `Block parameters`.
	Parameters ParameterGroupParameterArrayInput
}

The set of arguments for constructing a ParameterGroup resource.

func (ParameterGroupArgs) ElementType added in v3.29.0 

func (ParameterGroupArgs) ElementType() reflect.Type

type ParameterGroupArray added in v3.29.0 

type ParameterGroupArray []ParameterGroupInput

func (ParameterGroupArray) ElementType added in v3.29.0 

func (ParameterGroupArray) ElementType() reflect.Type

func (ParameterGroupArray) ToParameterGroupArrayOutput added in v3.29.0 

func (i ParameterGroupArray) ToParameterGroupArrayOutput() ParameterGroupArrayOutput

func (ParameterGroupArray) ToParameterGroupArrayOutputWithContext added in v3.29.0 

func (i ParameterGroupArray) ToParameterGroupArrayOutputWithContext(ctx context.Context) ParameterGroupArrayOutput

type ParameterGroupArrayInput added in v3.29.0 

type ParameterGroupArrayInput interface {
	pulumi.Input

	ToParameterGroupArrayOutput() ParameterGroupArrayOutput
	ToParameterGroupArrayOutputWithContext(context.Context) ParameterGroupArrayOutput
}

ParameterGroupArrayInput is an input type that accepts ParameterGroupArray and ParameterGroupArrayOutput values. You can construct a concrete instance of `ParameterGroupArrayInput` via: 

ParameterGroupArray{ ParameterGroupArgs{...} }

type ParameterGroupArrayOutput added in v3.29.0 

type ParameterGroupArrayOutput struct{ *pulumi.OutputState }

func (ParameterGroupArrayOutput) ElementType added in v3.29.0 

func (ParameterGroupArrayOutput) ElementType() reflect.Type

func (ParameterGroupArrayOutput) Index added in v3.29.0 

func (o ParameterGroupArrayOutput) Index(i pulumi.IntInput) ParameterGroupOutput

func (ParameterGroupArrayOutput) ToParameterGroupArrayOutput added in v3.29.0 

func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutput() ParameterGroupArrayOutput

func (ParameterGroupArrayOutput) ToParameterGroupArrayOutputWithContext added in v3.29.0 

func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutputWithContext(ctx context.Context) ParameterGroupArrayOutput

type ParameterGroupInput added in v3.29.0 

type ParameterGroupInput interface {
	pulumi.Input

	ToParameterGroupOutput() ParameterGroupOutput
	ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput
}

type ParameterGroupMap added in v3.29.0 

type ParameterGroupMap map[string]ParameterGroupInput

func (ParameterGroupMap) ElementType added in v3.29.0 

func (ParameterGroupMap) ElementType() reflect.Type

func (ParameterGroupMap) ToParameterGroupMapOutput added in v3.29.0 

func (i ParameterGroupMap) ToParameterGroupMapOutput() ParameterGroupMapOutput

func (ParameterGroupMap) ToParameterGroupMapOutputWithContext added in v3.29.0 

func (i ParameterGroupMap) ToParameterGroupMapOutputWithContext(ctx context.Context) ParameterGroupMapOutput

type ParameterGroupMapInput added in v3.29.0 

type ParameterGroupMapInput interface {
	pulumi.Input

	ToParameterGroupMapOutput() ParameterGroupMapOutput
	ToParameterGroupMapOutputWithContext(context.Context) ParameterGroupMapOutput
}

ParameterGroupMapInput is an input type that accepts ParameterGroupMap and ParameterGroupMapOutput values. You can construct a concrete instance of `ParameterGroupMapInput` via: 

ParameterGroupMap{ "key": ParameterGroupArgs{...} }

type ParameterGroupMapOutput added in v3.29.0 

type ParameterGroupMapOutput struct{ *pulumi.OutputState }

func (ParameterGroupMapOutput) ElementType added in v3.29.0 

func (ParameterGroupMapOutput) ElementType() reflect.Type

func (ParameterGroupMapOutput) MapIndex added in v3.29.0 

func (o ParameterGroupMapOutput) MapIndex(k pulumi.StringInput) ParameterGroupOutput

func (ParameterGroupMapOutput) ToParameterGroupMapOutput added in v3.29.0 

func (o ParameterGroupMapOutput) ToParameterGroupMapOutput() ParameterGroupMapOutput

func (ParameterGroupMapOutput) ToParameterGroupMapOutputWithContext added in v3.29.0 

func (o ParameterGroupMapOutput) ToParameterGroupMapOutputWithContext(ctx context.Context) ParameterGroupMapOutput

type ParameterGroupOutput added in v3.29.0 

type ParameterGroupOutput struct{ *pulumi.OutputState }

func (ParameterGroupOutput) DbType added in v3.29.0 

func (o ParameterGroupOutput) DbType() pulumi.StringOutput

The type of the database engine. Only `MySQL` is supported.

func (ParameterGroupOutput) DbVersion added in v3.29.0 

func (o ParameterGroupOutput) DbVersion() pulumi.StringOutput

The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.

func (ParameterGroupOutput) Description added in v3.29.0 

func (o ParameterGroupOutput) Description() pulumi.StringPtrOutput

The description of the parameter template. It must be 0 to 200 characters in length.

func (ParameterGroupOutput) ElementType added in v3.29.0 

func (ParameterGroupOutput) ElementType() reflect.Type

func (ParameterGroupOutput) Name added in v3.29.0 

func (o ParameterGroupOutput) Name() pulumi.StringOutput

The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.

func (ParameterGroupOutput) Parameters added in v3.29.0 

func (o ParameterGroupOutput) Parameters() ParameterGroupParameterArrayOutput

The parameter template. See the following `Block parameters`.

func (ParameterGroupOutput) ToParameterGroupOutput added in v3.29.0 

func (o ParameterGroupOutput) ToParameterGroupOutput() ParameterGroupOutput

func (ParameterGroupOutput) ToParameterGroupOutputWithContext added in v3.29.0 

func (o ParameterGroupOutput) ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput

type ParameterGroupParameter added in v3.29.0 

type ParameterGroupParameter struct {
	ParamName  string `pulumi:"paramName"`
	ParamValue string `pulumi:"paramValue"`
}

type ParameterGroupParameterArgs added in v3.29.0 

type ParameterGroupParameterArgs struct {
	ParamName  pulumi.StringInput `pulumi:"paramName"`
	ParamValue pulumi.StringInput `pulumi:"paramValue"`
}

func (ParameterGroupParameterArgs) ElementType added in v3.29.0 

func (ParameterGroupParameterArgs) ElementType() reflect.Type

func (ParameterGroupParameterArgs) ToParameterGroupParameterOutput added in v3.29.0 

func (i ParameterGroupParameterArgs) ToParameterGroupParameterOutput() ParameterGroupParameterOutput

func (ParameterGroupParameterArgs) ToParameterGroupParameterOutputWithContext added in v3.29.0 

func (i ParameterGroupParameterArgs) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput

type ParameterGroupParameterArray added in v3.29.0 

type ParameterGroupParameterArray []ParameterGroupParameterInput

func (ParameterGroupParameterArray) ElementType added in v3.29.0 

func (ParameterGroupParameterArray) ElementType() reflect.Type

func (ParameterGroupParameterArray) ToParameterGroupParameterArrayOutput added in v3.29.0 

func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput

func (ParameterGroupParameterArray) ToParameterGroupParameterArrayOutputWithContext added in v3.29.0 

func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput

type ParameterGroupParameterArrayInput added in v3.29.0 

type ParameterGroupParameterArrayInput interface {
	pulumi.Input

	ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput
	ToParameterGroupParameterArrayOutputWithContext(context.Context) ParameterGroupParameterArrayOutput
}

ParameterGroupParameterArrayInput is an input type that accepts ParameterGroupParameterArray and ParameterGroupParameterArrayOutput values. You can construct a concrete instance of `ParameterGroupParameterArrayInput` via: 

ParameterGroupParameterArray{ ParameterGroupParameterArgs{...} }

type ParameterGroupParameterArrayOutput added in v3.29.0 

type ParameterGroupParameterArrayOutput struct{ *pulumi.OutputState }

func (ParameterGroupParameterArrayOutput) ElementType added in v3.29.0 

func (ParameterGroupParameterArrayOutput) ElementType() reflect.Type

func (ParameterGroupParameterArrayOutput) Index added in v3.29.0 

func (o ParameterGroupParameterArrayOutput) Index(i pulumi.IntInput) ParameterGroupParameterOutput

func (ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutput added in v3.29.0 

func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput

func (ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutputWithContext added in v3.29.0 

func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput

type ParameterGroupParameterInput added in v3.29.0 

type ParameterGroupParameterInput interface {
	pulumi.Input

	ToParameterGroupParameterOutput() ParameterGroupParameterOutput
	ToParameterGroupParameterOutputWithContext(context.Context) ParameterGroupParameterOutput
}

ParameterGroupParameterInput is an input type that accepts ParameterGroupParameterArgs and ParameterGroupParameterOutput values. You can construct a concrete instance of `ParameterGroupParameterInput` via: 

ParameterGroupParameterArgs{...}

type ParameterGroupParameterOutput added in v3.29.0 

type ParameterGroupParameterOutput struct{ *pulumi.OutputState }

func (ParameterGroupParameterOutput) ElementType added in v3.29.0 

func (ParameterGroupParameterOutput) ElementType() reflect.Type

func (ParameterGroupParameterOutput) ParamName added in v3.29.0 

func (o ParameterGroupParameterOutput) ParamName() pulumi.StringOutput

func (ParameterGroupParameterOutput) ParamValue added in v3.29.0 

func (o ParameterGroupParameterOutput) ParamValue() pulumi.StringOutput

func (ParameterGroupParameterOutput) ToParameterGroupParameterOutput added in v3.29.0 

func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutput() ParameterGroupParameterOutput

func (ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext added in v3.29.0 

func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput

type ParameterGroupState added in v3.29.0 

type ParameterGroupState struct {
	// The type of the database engine. Only `MySQL` is supported.
	DbType pulumi.StringPtrInput
	// The version number of the database engine. Valid values: `5.6`, `5.7`, `8.0`.
	DbVersion pulumi.StringPtrInput
	// The description of the parameter template. It must be 0 to 200 characters in length.
	Description pulumi.StringPtrInput
	// The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
	Name pulumi.StringPtrInput
	// The parameter template. See the following `Block parameters`.
	Parameters ParameterGroupParameterArrayInput
}

func (ParameterGroupState) ElementType added in v3.29.0 

func (ParameterGroupState) ElementType() reflect.Type

type PrimaryEndpoint added in v3.49.0 

type PrimaryEndpoint struct {
	pulumi.CustomResourceState

	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringOutput `pulumi:"connectionPrefix"`
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrOutput `pulumi:"dbEndpointDescription"`
	// The ID of the cluster endpoint.
	DbEndpointId pulumi.StringOutput `pulumi:"dbEndpointId"`
	// Type of endpoint.
	EndpointType pulumi.StringOutput `pulumi:"endpointType"`
	// The network type of the endpoint address.
	NetType pulumi.StringPtrOutput `pulumi:"netType"`
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringOutput `pulumi:"port"`
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	// **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm).
	// For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
	SslAutoRotate pulumi.StringPtrOutput `pulumi:"sslAutoRotate"`
	// The specifies SSL certificate download link.
	SslCertificateUrl pulumi.StringOutput `pulumi:"sslCertificateUrl"`
	// The SSL connection string.
	SslConnectionString pulumi.StringOutput `pulumi:"sslConnectionString"`
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrOutput `pulumi:"sslEnabled"`
	// The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	SslExpireTime pulumi.StringOutput `pulumi:"sslExpireTime"`
}

Provides a PolarDB endpoint resource to manage primary endpoint of PolarDB cluster.

> **NOTE:** Available since v1.217.0

> **NOTE:** The default primary endpoint can not be created or deleted manually.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := polardb.GetNodeClasses(ctx, &polardb.GetNodeClassesArgs{
			DbType:    pulumi.StringRef("MySQL"),
			DbVersion: pulumi.StringRef("8.0"),
			PayType:   "PostPaid",
			Category:  pulumi.StringRef("Normal"),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(_default.Classes[0].ZoneId),
			VswitchName: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := polardb.NewCluster(ctx, "default", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			DbNodeClass: pulumi.String(_default.Classes[0].SupportedEngines[0].AvailableResources[0].DbNodeClass),
			PayType:     pulumi.String("PostPaid"),
			VswitchId:   defaultSwitch.ID(),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewPrimaryEndpoint(ctx, "default", &polardb.PrimaryEndpointArgs{
			DbClusterId: defaultCluster.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

PolarDB endpoint can be imported using the id, e.g.

```sh $ pulumi import alicloud:polardb/primaryEndpoint:PrimaryEndpoint example pc-abc123456:pe-abc123456 ```

func GetPrimaryEndpoint added in v3.49.0 

func GetPrimaryEndpoint(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PrimaryEndpointState, opts ...pulumi.ResourceOption) (*PrimaryEndpoint, error)

GetPrimaryEndpoint gets an existing PrimaryEndpoint resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPrimaryEndpoint added in v3.49.0 

func NewPrimaryEndpoint(ctx *pulumi.Context,
	name string, args *PrimaryEndpointArgs, opts ...pulumi.ResourceOption) (*PrimaryEndpoint, error)

NewPrimaryEndpoint registers a new resource with the given unique name, arguments, and options.

func (*PrimaryEndpoint) ElementType added in v3.49.0 

func (*PrimaryEndpoint) ElementType() reflect.Type

func (*PrimaryEndpoint) ToPrimaryEndpointOutput added in v3.49.0 

func (i *PrimaryEndpoint) ToPrimaryEndpointOutput() PrimaryEndpointOutput

func (*PrimaryEndpoint) ToPrimaryEndpointOutputWithContext added in v3.49.0 

func (i *PrimaryEndpoint) ToPrimaryEndpointOutputWithContext(ctx context.Context) PrimaryEndpointOutput

type PrimaryEndpointArgs added in v3.49.0 

type PrimaryEndpointArgs struct {
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringInput
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrInput
	// The network type of the endpoint address.
	NetType pulumi.StringPtrInput
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringPtrInput
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	// **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm).
	// For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
	SslAutoRotate pulumi.StringPtrInput
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrInput
}

The set of arguments for constructing a PrimaryEndpoint resource.

func (PrimaryEndpointArgs) ElementType added in v3.49.0 

func (PrimaryEndpointArgs) ElementType() reflect.Type

type PrimaryEndpointArray added in v3.49.0 

type PrimaryEndpointArray []PrimaryEndpointInput

func (PrimaryEndpointArray) ElementType added in v3.49.0 

func (PrimaryEndpointArray) ElementType() reflect.Type

func (PrimaryEndpointArray) ToPrimaryEndpointArrayOutput added in v3.49.0 

func (i PrimaryEndpointArray) ToPrimaryEndpointArrayOutput() PrimaryEndpointArrayOutput

func (PrimaryEndpointArray) ToPrimaryEndpointArrayOutputWithContext added in v3.49.0 

func (i PrimaryEndpointArray) ToPrimaryEndpointArrayOutputWithContext(ctx context.Context) PrimaryEndpointArrayOutput

type PrimaryEndpointArrayInput added in v3.49.0 

type PrimaryEndpointArrayInput interface {
	pulumi.Input

	ToPrimaryEndpointArrayOutput() PrimaryEndpointArrayOutput
	ToPrimaryEndpointArrayOutputWithContext(context.Context) PrimaryEndpointArrayOutput
}

PrimaryEndpointArrayInput is an input type that accepts PrimaryEndpointArray and PrimaryEndpointArrayOutput values. You can construct a concrete instance of `PrimaryEndpointArrayInput` via: 

PrimaryEndpointArray{ PrimaryEndpointArgs{...} }

type PrimaryEndpointArrayOutput added in v3.49.0 

type PrimaryEndpointArrayOutput struct{ *pulumi.OutputState }

func (PrimaryEndpointArrayOutput) ElementType added in v3.49.0 

func (PrimaryEndpointArrayOutput) ElementType() reflect.Type

func (PrimaryEndpointArrayOutput) Index added in v3.49.0 

func (o PrimaryEndpointArrayOutput) Index(i pulumi.IntInput) PrimaryEndpointOutput

func (PrimaryEndpointArrayOutput) ToPrimaryEndpointArrayOutput added in v3.49.0 

func (o PrimaryEndpointArrayOutput) ToPrimaryEndpointArrayOutput() PrimaryEndpointArrayOutput

func (PrimaryEndpointArrayOutput) ToPrimaryEndpointArrayOutputWithContext added in v3.49.0 

func (o PrimaryEndpointArrayOutput) ToPrimaryEndpointArrayOutputWithContext(ctx context.Context) PrimaryEndpointArrayOutput

type PrimaryEndpointInput added in v3.49.0 

type PrimaryEndpointInput interface {
	pulumi.Input

	ToPrimaryEndpointOutput() PrimaryEndpointOutput
	ToPrimaryEndpointOutputWithContext(ctx context.Context) PrimaryEndpointOutput
}

type PrimaryEndpointMap added in v3.49.0 

type PrimaryEndpointMap map[string]PrimaryEndpointInput

func (PrimaryEndpointMap) ElementType added in v3.49.0 

func (PrimaryEndpointMap) ElementType() reflect.Type

func (PrimaryEndpointMap) ToPrimaryEndpointMapOutput added in v3.49.0 

func (i PrimaryEndpointMap) ToPrimaryEndpointMapOutput() PrimaryEndpointMapOutput

func (PrimaryEndpointMap) ToPrimaryEndpointMapOutputWithContext added in v3.49.0 

func (i PrimaryEndpointMap) ToPrimaryEndpointMapOutputWithContext(ctx context.Context) PrimaryEndpointMapOutput

type PrimaryEndpointMapInput added in v3.49.0 

type PrimaryEndpointMapInput interface {
	pulumi.Input

	ToPrimaryEndpointMapOutput() PrimaryEndpointMapOutput
	ToPrimaryEndpointMapOutputWithContext(context.Context) PrimaryEndpointMapOutput
}

PrimaryEndpointMapInput is an input type that accepts PrimaryEndpointMap and PrimaryEndpointMapOutput values. You can construct a concrete instance of `PrimaryEndpointMapInput` via: 

PrimaryEndpointMap{ "key": PrimaryEndpointArgs{...} }

type PrimaryEndpointMapOutput added in v3.49.0 

type PrimaryEndpointMapOutput struct{ *pulumi.OutputState }

func (PrimaryEndpointMapOutput) ElementType added in v3.49.0 

func (PrimaryEndpointMapOutput) ElementType() reflect.Type

func (PrimaryEndpointMapOutput) MapIndex added in v3.49.0 

func (o PrimaryEndpointMapOutput) MapIndex(k pulumi.StringInput) PrimaryEndpointOutput

func (PrimaryEndpointMapOutput) ToPrimaryEndpointMapOutput added in v3.49.0 

func (o PrimaryEndpointMapOutput) ToPrimaryEndpointMapOutput() PrimaryEndpointMapOutput

func (PrimaryEndpointMapOutput) ToPrimaryEndpointMapOutputWithContext added in v3.49.0 

func (o PrimaryEndpointMapOutput) ToPrimaryEndpointMapOutputWithContext(ctx context.Context) PrimaryEndpointMapOutput

type PrimaryEndpointOutput added in v3.49.0 

type PrimaryEndpointOutput struct{ *pulumi.OutputState }

func (PrimaryEndpointOutput) ConnectionPrefix added in v3.49.0 

func (o PrimaryEndpointOutput) ConnectionPrefix() pulumi.StringOutput

Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.

func (PrimaryEndpointOutput) DbClusterId added in v3.49.0 

func (o PrimaryEndpointOutput) DbClusterId() pulumi.StringOutput

The Id of cluster that can run database.

func (PrimaryEndpointOutput) DbEndpointDescription added in v3.49.0 

func (o PrimaryEndpointOutput) DbEndpointDescription() pulumi.StringPtrOutput

The name of the endpoint.

func (PrimaryEndpointOutput) DbEndpointId added in v3.49.0 

func (o PrimaryEndpointOutput) DbEndpointId() pulumi.StringOutput

The ID of the cluster endpoint.

func (PrimaryEndpointOutput) ElementType added in v3.49.0 

func (PrimaryEndpointOutput) ElementType() reflect.Type

func (PrimaryEndpointOutput) EndpointType added in v3.49.0 

func (o PrimaryEndpointOutput) EndpointType() pulumi.StringOutput

Type of endpoint.

func (PrimaryEndpointOutput) NetType added in v3.49.0 

func (o PrimaryEndpointOutput) NetType() pulumi.StringPtrOutput

The network type of the endpoint address.

func (PrimaryEndpointOutput) Port added in v3.49.0 

func (o PrimaryEndpointOutput) Port() pulumi.StringOutput

Port of the specified endpoint. Valid values: 3000 to 5999.

func (PrimaryEndpointOutput) SslAutoRotate added in v3.49.0 

func (o PrimaryEndpointOutput) SslAutoRotate() pulumi.StringPtrOutput

Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`. **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm). For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.

func (PrimaryEndpointOutput) SslCertificateUrl added in v3.49.0 

func (o PrimaryEndpointOutput) SslCertificateUrl() pulumi.StringOutput

The specifies SSL certificate download link.

func (PrimaryEndpointOutput) SslConnectionString added in v3.49.0 

func (o PrimaryEndpointOutput) SslConnectionString() pulumi.StringOutput

The SSL connection string.

func (PrimaryEndpointOutput) SslEnabled added in v3.49.0 

func (o PrimaryEndpointOutput) SslEnabled() pulumi.StringPtrOutput

Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.

func (PrimaryEndpointOutput) SslExpireTime added in v3.49.0 

func (o PrimaryEndpointOutput) SslExpireTime() pulumi.StringOutput

The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

func (PrimaryEndpointOutput) ToPrimaryEndpointOutput added in v3.49.0 

func (o PrimaryEndpointOutput) ToPrimaryEndpointOutput() PrimaryEndpointOutput

func (PrimaryEndpointOutput) ToPrimaryEndpointOutputWithContext added in v3.49.0 

func (o PrimaryEndpointOutput) ToPrimaryEndpointOutputWithContext(ctx context.Context) PrimaryEndpointOutput

type PrimaryEndpointState added in v3.49.0 

type PrimaryEndpointState struct {
	// Prefix of the specified endpoint. The prefix must be 6 to 30 characters in length, and can contain lowercase letters, digits, and hyphens (-), must start with a letter and end with a digit or letter.
	ConnectionPrefix pulumi.StringPtrInput
	// The Id of cluster that can run database.
	DbClusterId pulumi.StringPtrInput
	// The name of the endpoint.
	DbEndpointDescription pulumi.StringPtrInput
	// The ID of the cluster endpoint.
	DbEndpointId pulumi.StringPtrInput
	// Type of endpoint.
	EndpointType pulumi.StringPtrInput
	// The network type of the endpoint address.
	NetType pulumi.StringPtrInput
	// Port of the specified endpoint. Valid values: 3000 to 5999.
	Port pulumi.StringPtrInput
	// Specifies whether automatic rotation of SSL certificates is enabled. Valid values: `Enable`,`Disable`.
	// **NOTE:** For a PolarDB for MySQL cluster, this parameter is required, and only one connection string in each endpoint can enable the ssl, for other notes, see [Configure SSL encryption](https://www.alibabacloud.com/help/doc-detail/153182.htm).
	// For a PolarDB for PostgreSQL cluster or a PolarDB-O cluster, this parameter is not required, by default, SSL encryption is enabled for all endpoints.
	SslAutoRotate pulumi.StringPtrInput
	// The specifies SSL certificate download link.
	SslCertificateUrl pulumi.StringPtrInput
	// The SSL connection string.
	SslConnectionString pulumi.StringPtrInput
	// Specifies how to modify the SSL encryption status. Valid values: `Disable`, `Enable`, `Update`.
	SslEnabled pulumi.StringPtrInput
	// The time when the SSL certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
	SslExpireTime pulumi.StringPtrInput
}

func (PrimaryEndpointState) ElementType added in v3.49.0 

func (PrimaryEndpointState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.