clickhouse

package
v3.54.0 Latest Latest
Warning

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

Go to latest
Published: Apr 24, 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

	// In Chinese, English letter. May contain Chinese and English characters, lowercase letters, numbers, and underscores (_), the dash (-). Cannot start with http:// and https:// at the beginning. Length is from 2 to 256 characters.
	AccountDescription pulumi.StringPtrOutput `pulumi:"accountDescription"`
	// Account name: lowercase letters, numbers, underscores, lowercase letter; length no more than 16 characters.
	AccountName pulumi.StringOutput `pulumi:"accountName"`
	// The account password: uppercase letters, lowercase letters, lowercase letters, numbers, and special characters (special character! #$%^& author (s):_+-=) in a length of 8-32 bit.
	AccountPassword pulumi.StringOutput `pulumi:"accountPassword"`
	// The list of databases to which you want to grant permissions. Separate databases with commas (,).
	AllowDatabases pulumi.StringOutput `pulumi:"allowDatabases"`
	// The list of dictionaries to which you want to grant permissions. Separate dictionaries with commas (,).
	AllowDictionaries pulumi.StringOutput `pulumi:"allowDictionaries"`
	// The db cluster id.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// Specifies whether to grant DDL permissions to the database account. Valid values: `true` and `false`.
	DdlAuthority pulumi.BoolOutput `pulumi:"ddlAuthority"`
	// Specifies whether to grant DML permissions to the database account. Valid values: `all` and `readOnly,modify`.
	DmlAuthority pulumi.StringOutput `pulumi:"dmlAuthority"`
	// The status of the resource. Valid Status: `Creating`,`Available`,`Deleting`.
	Status pulumi.StringOutput `pulumi:"status"`
	// The list of all databases. Separate databases with commas (,).
	TotalDatabases pulumi.StringOutput `pulumi:"totalDatabases"`
	// The list of all dictionaries. Separate dictionaries with commas (,).
	TotalDictionaries pulumi.StringOutput `pulumi:"totalDictionaries"`
	// The type of the database account. Valid values: `Normal` or `Super`.
	Type pulumi.StringOutput `pulumi:"type"`
}

Provides a Click House Account resource.

For information about Click House Account and how to use it, see [What is Account](https://www.alibabacloud.com/help/zh/clickhouse/latest/api-clickhouse-2019-11-11-createaccount).

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

## Example Usage

Basic Usage

```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("10.4.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VswitchName: pulumi.String(name),
			CidrBlock:   pulumi.String("10.4.0.0/24"),
			VpcId:       defaultNetwork.ID(),
			ZoneId:      pulumi.String(_default.Regions[0].ZoneIds[0].ZoneId),
		})
		if err != nil {
			return err
		}
		defaultDbCluster, err := clickhouse.NewDbCluster(ctx, "default", &clickhouse.DbClusterArgs{
			DbClusterVersion:     pulumi.String("22.8.5.29"),
			Category:             pulumi.String("Basic"),
			DbClusterClass:       pulumi.String("S8"),
			DbClusterNetworkType: pulumi.String("vpc"),
			DbNodeGroupCount:     pulumi.Int(1),
			PaymentType:          pulumi.String("PayAsYouGo"),
			DbNodeStorage:        pulumi.String("500"),
			StorageType:          pulumi.String("cloud_essd"),
			VswitchId:            defaultSwitch.ID(),
			VpcId:                defaultNetwork.ID(),
		})
		if err != nil {
			return err
		}
		_, err = clickhouse.NewAccount(ctx, "default", &clickhouse.AccountArgs{
			DbClusterId:        defaultDbCluster.ID(),
			AccountDescription: pulumi.String("tf-example-description"),
			AccountName:        pulumi.String("examplename"),
			AccountPassword:    pulumi.String("Example1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Click House Account can be imported using the id, e.g.

```sh $ pulumi import alicloud:clickhouse/account:Account example <db_cluster_id>:<account_name> ```

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 {
	// In Chinese, English letter. May contain Chinese and English characters, lowercase letters, numbers, and underscores (_), the dash (-). Cannot start with http:// and https:// at the beginning. Length is from 2 to 256 characters.
	AccountDescription pulumi.StringPtrInput
	// Account name: lowercase letters, numbers, underscores, lowercase letter; length no more than 16 characters.
	AccountName pulumi.StringInput
	// The account password: uppercase letters, lowercase letters, lowercase letters, numbers, and special characters (special character! #$%^& author (s):_+-=) in a length of 8-32 bit.
	AccountPassword pulumi.StringInput
	// The list of databases to which you want to grant permissions. Separate databases with commas (,).
	AllowDatabases pulumi.StringPtrInput
	// The list of dictionaries to which you want to grant permissions. Separate dictionaries with commas (,).
	AllowDictionaries pulumi.StringPtrInput
	// The db cluster id.
	DbClusterId pulumi.StringInput
	// Specifies whether to grant DDL permissions to the database account. Valid values: `true` and `false`.
	DdlAuthority pulumi.BoolPtrInput
	// Specifies whether to grant DML permissions to the database account. Valid values: `all` and `readOnly,modify`.
	DmlAuthority pulumi.StringPtrInput
	// The list of all databases. Separate databases with commas (,).
	TotalDatabases pulumi.StringPtrInput
	// The list of all dictionaries. Separate dictionaries with commas (,).
	TotalDictionaries pulumi.StringPtrInput
}

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

In Chinese, English letter. May contain Chinese and English characters, lowercase letters, numbers, and underscores (_), the dash (-). Cannot start with http:// and https:// at the beginning. Length is from 2 to 256 characters.

func (AccountOutput) AccountName added in v3.27.0

func (o AccountOutput) AccountName() pulumi.StringOutput

Account name: lowercase letters, numbers, underscores, lowercase letter; length no more than 16 characters.

func (AccountOutput) AccountPassword added in v3.27.0

func (o AccountOutput) AccountPassword() pulumi.StringOutput

The account password: uppercase letters, lowercase letters, lowercase letters, numbers, and special characters (special character! #$%^& author (s):_+-=) in a length of 8-32 bit.

func (AccountOutput) AllowDatabases added in v3.27.0

func (o AccountOutput) AllowDatabases() pulumi.StringOutput

The list of databases to which you want to grant permissions. Separate databases with commas (,).

func (AccountOutput) AllowDictionaries added in v3.27.0

func (o AccountOutput) AllowDictionaries() pulumi.StringOutput

The list of dictionaries to which you want to grant permissions. Separate dictionaries with commas (,).

func (AccountOutput) DbClusterId added in v3.27.0

func (o AccountOutput) DbClusterId() pulumi.StringOutput

The db cluster id.

func (AccountOutput) DdlAuthority added in v3.27.0

func (o AccountOutput) DdlAuthority() pulumi.BoolOutput

Specifies whether to grant DDL permissions to the database account. Valid values: `true` and `false`.

func (AccountOutput) DmlAuthority added in v3.27.0

func (o AccountOutput) DmlAuthority() pulumi.StringOutput

Specifies whether to grant DML permissions to the database account. Valid values: `all` and `readOnly,modify`.

func (AccountOutput) ElementType

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) Status added in v3.27.0

func (o AccountOutput) Status() pulumi.StringOutput

The status of the resource. Valid Status: `Creating`,`Available`,`Deleting`.

func (AccountOutput) ToAccountOutput

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext

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

func (AccountOutput) TotalDatabases added in v3.27.0

func (o AccountOutput) TotalDatabases() pulumi.StringOutput

The list of all databases. Separate databases with commas (,).

func (AccountOutput) TotalDictionaries added in v3.27.0

func (o AccountOutput) TotalDictionaries() pulumi.StringOutput

The list of all dictionaries. Separate dictionaries with commas (,).

func (AccountOutput) Type added in v3.27.0

The type of the database account. Valid values: `Normal` or `Super`.

type AccountState

type AccountState struct {
	// In Chinese, English letter. May contain Chinese and English characters, lowercase letters, numbers, and underscores (_), the dash (-). Cannot start with http:// and https:// at the beginning. Length is from 2 to 256 characters.
	AccountDescription pulumi.StringPtrInput
	// Account name: lowercase letters, numbers, underscores, lowercase letter; length no more than 16 characters.
	AccountName pulumi.StringPtrInput
	// The account password: uppercase letters, lowercase letters, lowercase letters, numbers, and special characters (special character! #$%^& author (s):_+-=) in a length of 8-32 bit.
	AccountPassword pulumi.StringPtrInput
	// The list of databases to which you want to grant permissions. Separate databases with commas (,).
	AllowDatabases pulumi.StringPtrInput
	// The list of dictionaries to which you want to grant permissions. Separate dictionaries with commas (,).
	AllowDictionaries pulumi.StringPtrInput
	// The db cluster id.
	DbClusterId pulumi.StringPtrInput
	// Specifies whether to grant DDL permissions to the database account. Valid values: `true` and `false`.
	DdlAuthority pulumi.BoolPtrInput
	// Specifies whether to grant DML permissions to the database account. Valid values: `all` and `readOnly,modify`.
	DmlAuthority pulumi.StringPtrInput
	// The status of the resource. Valid Status: `Creating`,`Available`,`Deleting`.
	Status pulumi.StringPtrInput
	// The list of all databases. Separate databases with commas (,).
	TotalDatabases pulumi.StringPtrInput
	// The list of all dictionaries. Separate dictionaries with commas (,).
	TotalDictionaries pulumi.StringPtrInput
	// The type of the database account. Valid values: `Normal` or `Super`.
	Type pulumi.StringPtrInput
}

func (AccountState) ElementType

func (AccountState) ElementType() reflect.Type

type BackupPolicy added in v3.12.0

type BackupPolicy struct {
	pulumi.CustomResourceState

	// Data backup days. Valid values: `7` to `730`.
	BackupRetentionPeriod pulumi.IntPtrOutput `pulumi:"backupRetentionPeriod"`
	// The id of the DBCluster.
	DbClusterId pulumi.StringOutput `pulumi:"dbClusterId"`
	// DBCluster Backup period. A list of DBCluster Backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	PreferredBackupPeriods pulumi.StringArrayOutput `pulumi:"preferredBackupPeriods"`
	// DBCluster backup time, in the format of `HH:mmZ-HH:mmZ`. Time setting interval is one hour. China time is 8 hours behind it.
	PreferredBackupTime pulumi.StringOutput `pulumi:"preferredBackupTime"`
	// The status of the resource.
	Status pulumi.StringOutput `pulumi:"status"`
}

Provides a Click House Backup Policy resource.

For information about Click House Backup Policy and how to use it, see [What is Backup Policy](https://www.alibabacloud.com/help/zh/clickhouse/latest/api-clickhouse-2019-11-11-createbackuppolicy).

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

> **NOTE:** Only the cloud database ClickHouse cluster version `20.3` supports data backup.

## Example Usage

Basic Usage

```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("10.4.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VswitchName: pulumi.String(name),
			CidrBlock:   pulumi.String("10.4.0.0/24"),
			VpcId:       defaultNetwork.ID(),
			ZoneId:      pulumi.String(_default.Regions[0].ZoneIds[0].ZoneId),
		})
		if err != nil {
			return err
		}
		defaultDbCluster, err := clickhouse.NewDbCluster(ctx, "default", &clickhouse.DbClusterArgs{
			DbClusterVersion:     pulumi.String("22.8.5.29"),
			Status:               pulumi.String("Running"),
			Category:             pulumi.String("Basic"),
			DbClusterClass:       pulumi.String("S8"),
			DbClusterNetworkType: pulumi.String("vpc"),
			DbNodeGroupCount:     pulumi.Int(1),
			PaymentType:          pulumi.String("PayAsYouGo"),
			DbNodeStorage:        pulumi.String("500"),
			StorageType:          pulumi.String("cloud_essd"),
			VswitchId:            defaultSwitch.ID(),
			VpcId:                defaultNetwork.ID(),
		})
		if err != nil {
			return err
		}
		_, err = clickhouse.NewBackupPolicy(ctx, "default", &clickhouse.BackupPolicyArgs{
			DbClusterId: defaultDbCluster.ID(),
			PreferredBackupPeriods: pulumi.StringArray{
				pulumi.String("Monday"),
				pulumi.String("Friday"),
			},
			PreferredBackupTime:   pulumi.String("00:00Z-01:00Z"),
			BackupRetentionPeriod: pulumi.Int(7),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Click House Backup Policy can be imported using the id, e.g.

```sh $ pulumi import alicloud:clickhouse/backupPolicy:BackupPolicy example <db_cluster_id> ```

func GetBackupPolicy added in v3.12.0

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 added in v3.12.0

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 added in v3.12.0

func (*BackupPolicy) ElementType() reflect.Type

func (*BackupPolicy) ToBackupPolicyOutput added in v3.12.0

func (i *BackupPolicy) ToBackupPolicyOutput() BackupPolicyOutput

func (*BackupPolicy) ToBackupPolicyOutputWithContext added in v3.12.0

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

type BackupPolicyArgs added in v3.12.0

type BackupPolicyArgs struct {
	// Data backup days. Valid values: `7` to `730`.
	BackupRetentionPeriod pulumi.IntPtrInput
	// The id of the DBCluster.
	DbClusterId pulumi.StringInput
	// DBCluster Backup period. A list of DBCluster Backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	PreferredBackupPeriods pulumi.StringArrayInput
	// DBCluster backup time, in the format of `HH:mmZ-HH:mmZ`. Time setting interval is one hour. China time is 8 hours behind it.
	PreferredBackupTime pulumi.StringInput
}

The set of arguments for constructing a BackupPolicy resource.

func (BackupPolicyArgs) ElementType added in v3.12.0

func (BackupPolicyArgs) ElementType() reflect.Type

type BackupPolicyArray added in v3.12.0

type BackupPolicyArray []BackupPolicyInput

func (BackupPolicyArray) ElementType added in v3.12.0

func (BackupPolicyArray) ElementType() reflect.Type

func (BackupPolicyArray) ToBackupPolicyArrayOutput added in v3.12.0

func (i BackupPolicyArray) ToBackupPolicyArrayOutput() BackupPolicyArrayOutput

func (BackupPolicyArray) ToBackupPolicyArrayOutputWithContext added in v3.12.0

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

type BackupPolicyArrayInput added in v3.12.0

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 added in v3.12.0

type BackupPolicyArrayOutput struct{ *pulumi.OutputState }

func (BackupPolicyArrayOutput) ElementType added in v3.12.0

func (BackupPolicyArrayOutput) ElementType() reflect.Type

func (BackupPolicyArrayOutput) Index added in v3.12.0

func (BackupPolicyArrayOutput) ToBackupPolicyArrayOutput added in v3.12.0

func (o BackupPolicyArrayOutput) ToBackupPolicyArrayOutput() BackupPolicyArrayOutput

func (BackupPolicyArrayOutput) ToBackupPolicyArrayOutputWithContext added in v3.12.0

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

type BackupPolicyInput added in v3.12.0

type BackupPolicyInput interface {
	pulumi.Input

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

type BackupPolicyMap added in v3.12.0

type BackupPolicyMap map[string]BackupPolicyInput

func (BackupPolicyMap) ElementType added in v3.12.0

func (BackupPolicyMap) ElementType() reflect.Type

func (BackupPolicyMap) ToBackupPolicyMapOutput added in v3.12.0

func (i BackupPolicyMap) ToBackupPolicyMapOutput() BackupPolicyMapOutput

func (BackupPolicyMap) ToBackupPolicyMapOutputWithContext added in v3.12.0

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

type BackupPolicyMapInput added in v3.12.0

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 added in v3.12.0

type BackupPolicyMapOutput struct{ *pulumi.OutputState }

func (BackupPolicyMapOutput) ElementType added in v3.12.0

func (BackupPolicyMapOutput) ElementType() reflect.Type

func (BackupPolicyMapOutput) MapIndex added in v3.12.0

func (BackupPolicyMapOutput) ToBackupPolicyMapOutput added in v3.12.0

func (o BackupPolicyMapOutput) ToBackupPolicyMapOutput() BackupPolicyMapOutput

func (BackupPolicyMapOutput) ToBackupPolicyMapOutputWithContext added in v3.12.0

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

type BackupPolicyOutput added in v3.12.0

type BackupPolicyOutput struct{ *pulumi.OutputState }

func (BackupPolicyOutput) BackupRetentionPeriod added in v3.27.0

func (o BackupPolicyOutput) BackupRetentionPeriod() pulumi.IntPtrOutput

Data backup days. Valid values: `7` to `730`.

func (BackupPolicyOutput) DbClusterId added in v3.27.0

func (o BackupPolicyOutput) DbClusterId() pulumi.StringOutput

The id of the DBCluster.

func (BackupPolicyOutput) ElementType added in v3.12.0

func (BackupPolicyOutput) ElementType() reflect.Type

func (BackupPolicyOutput) PreferredBackupPeriods added in v3.27.0

func (o BackupPolicyOutput) PreferredBackupPeriods() pulumi.StringArrayOutput

DBCluster Backup period. A list of DBCluster Backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].

func (BackupPolicyOutput) PreferredBackupTime added in v3.27.0

func (o BackupPolicyOutput) PreferredBackupTime() pulumi.StringOutput

DBCluster backup time, in the format of `HH:mmZ-HH:mmZ`. Time setting interval is one hour. China time is 8 hours behind it.

func (BackupPolicyOutput) Status added in v3.27.0

The status of the resource.

func (BackupPolicyOutput) ToBackupPolicyOutput added in v3.12.0

func (o BackupPolicyOutput) ToBackupPolicyOutput() BackupPolicyOutput

func (BackupPolicyOutput) ToBackupPolicyOutputWithContext added in v3.12.0

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

type BackupPolicyState added in v3.12.0

type BackupPolicyState struct {
	// Data backup days. Valid values: `7` to `730`.
	BackupRetentionPeriod pulumi.IntPtrInput
	// The id of the DBCluster.
	DbClusterId pulumi.StringPtrInput
	// DBCluster Backup period. A list of DBCluster Backup period. Valid values: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
	PreferredBackupPeriods pulumi.StringArrayInput
	// DBCluster backup time, in the format of `HH:mmZ-HH:mmZ`. Time setting interval is one hour. China time is 8 hours behind it.
	PreferredBackupTime pulumi.StringPtrInput
	// The status of the resource.
	Status pulumi.StringPtrInput
}

func (BackupPolicyState) ElementType added in v3.12.0

func (BackupPolicyState) ElementType() reflect.Type

type DbCluster

type DbCluster struct {
	pulumi.CustomResourceState

	// The Category of DBCluster. Valid values: `Basic`,`HighAvailability`.
	Category pulumi.StringOutput `pulumi:"category"`
	// (Available since v1.196.0) - The connection string of the cluster.
	ConnectionString pulumi.StringOutput `pulumi:"connectionString"`
	// The db cluster access white list. See `dbClusterAccessWhiteList` below.
	DbClusterAccessWhiteLists DbClusterDbClusterAccessWhiteListArrayOutput `pulumi:"dbClusterAccessWhiteLists"`
	// The DBCluster class. According to the category, dbClusterClass has two value ranges:
	// * Under the condition that the category is the `Basic`, Valid values: `LS20`, `LS40`, `LS80`,`S8`, `S16`, `S32`, `S64`,`S80`, `S104`.
	// * Under the condition that the category is the `HighAvailability`, Valid values: `LC20`, `LC40`, `LC80`,`C8`, `C16`, `C32`, `C64`, `C80`, `C104`.
	DbClusterClass pulumi.StringOutput `pulumi:"dbClusterClass"`
	// The DBCluster description.
	DbClusterDescription pulumi.StringOutput `pulumi:"dbClusterDescription"`
	// The DBCluster network type. Valid values: `vpc`.
	DbClusterNetworkType pulumi.StringOutput `pulumi:"dbClusterNetworkType"`
	// The DBCluster version. Valid values: `20.3.10.75`, `20.8.7.15`, `21.8.10.19`, `22.8.5.29`. **NOTE:** `19.15.2.2` is no longer supported. From version 1.191.0, `dbClusterVersion` can be set to `22.8.5.29`.
	DbClusterVersion pulumi.StringOutput `pulumi:"dbClusterVersion"`
	// The db node group count. The number should between 1 and 48.
	DbNodeGroupCount pulumi.IntOutput `pulumi:"dbNodeGroupCount"`
	// The db node storage.
	DbNodeStorage pulumi.StringOutput `pulumi:"dbNodeStorage"`
	// Key management service KMS key ID. It is valid and required when encryptionType is `CloudDisk`.
	EncryptionKey pulumi.StringPtrOutput `pulumi:"encryptionKey"`
	// Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
	EncryptionType pulumi.StringPtrOutput `pulumi:"encryptionType"`
	// The maintenance window of DBCluster. Valid format: `hh:mmZ-hh:mm Z`.
	MaintainTime pulumi.StringOutput `pulumi:"maintainTime"`
	// The payment type of the resource. Valid values: `PayAsYouGo`,`Subscription`.
	PaymentType pulumi.StringOutput `pulumi:"paymentType"`
	// Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when paymentType is `Subscription`. Valid values: `Month`, `Year`.
	Period pulumi.StringPtrOutput `pulumi:"period"`
	// (Available since v1.196.0) The connection port of the cluster.
	Port pulumi.StringOutput `pulumi:"port"`
	// The status of the resource. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`.
	Status pulumi.StringOutput `pulumi:"status"`
	// Storage type of DBCluster. Valid values: `cloudEssd`, `cloudEfficiency`, `cloudEssdPl2`, `cloudEssdPl3`.
	StorageType pulumi.StringOutput `pulumi:"storageType"`
	// The used time of DBCluster. It is valid and required when paymentType is `Subscription`.
	UsedTime pulumi.StringPtrOutput `pulumi:"usedTime"`
	// The id of the VPC.
	VpcId pulumi.StringOutput `pulumi:"vpcId"`
	// The vswitch id of DBCluster.
	VswitchId pulumi.StringPtrOutput `pulumi:"vswitchId"`
	// The zone ID of the instance.
	ZoneId pulumi.StringOutput `pulumi:"zoneId"`
}

Provides a Click House DBCluster resource.

For information about Click House DBCluster and how to use it, see [What is DBCluster](https://www.alibabacloud.com/help/zh/clickhouse/latest/api-clickhouse-2019-11-11-createdbinstance).

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

## Example Usage

Basic Usage

```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("10.4.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VswitchName: pulumi.String(name),
			CidrBlock:   pulumi.String("10.4.0.0/24"),
			VpcId:       defaultNetwork.ID(),
			ZoneId:      pulumi.String(_default.Regions[0].ZoneIds[0].ZoneId),
		})
		if err != nil {
			return err
		}
		_, err = clickhouse.NewDbCluster(ctx, "default", &clickhouse.DbClusterArgs{
			DbClusterVersion:     pulumi.String("22.8.5.29"),
			Category:             pulumi.String("Basic"),
			DbClusterClass:       pulumi.String("S8"),
			DbClusterNetworkType: pulumi.String("vpc"),
			DbNodeGroupCount:     pulumi.Int(1),
			PaymentType:          pulumi.String("PayAsYouGo"),
			DbNodeStorage:        pulumi.String("500"),
			StorageType:          pulumi.String("cloud_essd"),
			VswitchId:            defaultSwitch.ID(),
			VpcId:                defaultNetwork.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Click House DBCluster can be imported using the id, e.g.

```sh $ pulumi import alicloud:clickhouse/dbCluster:DbCluster example <id> ```

func GetDbCluster

func GetDbCluster(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DbClusterState, opts ...pulumi.ResourceOption) (*DbCluster, error)

GetDbCluster gets an existing DbCluster 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 NewDbCluster

func NewDbCluster(ctx *pulumi.Context,
	name string, args *DbClusterArgs, opts ...pulumi.ResourceOption) (*DbCluster, error)

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

func (*DbCluster) ElementType

func (*DbCluster) ElementType() reflect.Type

func (*DbCluster) ToDbClusterOutput

func (i *DbCluster) ToDbClusterOutput() DbClusterOutput

func (*DbCluster) ToDbClusterOutputWithContext

func (i *DbCluster) ToDbClusterOutputWithContext(ctx context.Context) DbClusterOutput

type DbClusterArgs

type DbClusterArgs struct {
	// The Category of DBCluster. Valid values: `Basic`,`HighAvailability`.
	Category pulumi.StringInput
	// The db cluster access white list. See `dbClusterAccessWhiteList` below.
	DbClusterAccessWhiteLists DbClusterDbClusterAccessWhiteListArrayInput
	// The DBCluster class. According to the category, dbClusterClass has two value ranges:
	// * Under the condition that the category is the `Basic`, Valid values: `LS20`, `LS40`, `LS80`,`S8`, `S16`, `S32`, `S64`,`S80`, `S104`.
	// * Under the condition that the category is the `HighAvailability`, Valid values: `LC20`, `LC40`, `LC80`,`C8`, `C16`, `C32`, `C64`, `C80`, `C104`.
	DbClusterClass pulumi.StringInput
	// The DBCluster description.
	DbClusterDescription pulumi.StringPtrInput
	// The DBCluster network type. Valid values: `vpc`.
	DbClusterNetworkType pulumi.StringInput
	// The DBCluster version. Valid values: `20.3.10.75`, `20.8.7.15`, `21.8.10.19`, `22.8.5.29`. **NOTE:** `19.15.2.2` is no longer supported. From version 1.191.0, `dbClusterVersion` can be set to `22.8.5.29`.
	DbClusterVersion pulumi.StringInput
	// The db node group count. The number should between 1 and 48.
	DbNodeGroupCount pulumi.IntInput
	// The db node storage.
	DbNodeStorage pulumi.StringInput
	// Key management service KMS key ID. It is valid and required when encryptionType is `CloudDisk`.
	EncryptionKey pulumi.StringPtrInput
	// Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
	EncryptionType pulumi.StringPtrInput
	// The maintenance window of DBCluster. Valid format: `hh:mmZ-hh:mm Z`.
	MaintainTime pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `PayAsYouGo`,`Subscription`.
	PaymentType pulumi.StringInput
	// Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when paymentType is `Subscription`. Valid values: `Month`, `Year`.
	Period pulumi.StringPtrInput
	// The status of the resource. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`.
	Status pulumi.StringPtrInput
	// Storage type of DBCluster. Valid values: `cloudEssd`, `cloudEfficiency`, `cloudEssdPl2`, `cloudEssdPl3`.
	StorageType pulumi.StringInput
	// The used time of DBCluster. It is valid and required when paymentType is `Subscription`.
	UsedTime pulumi.StringPtrInput
	// The id of the VPC.
	VpcId pulumi.StringPtrInput
	// The vswitch id of DBCluster.
	VswitchId pulumi.StringPtrInput
	// The zone ID of the instance.
	ZoneId pulumi.StringPtrInput
}

The set of arguments for constructing a DbCluster resource.

func (DbClusterArgs) ElementType

func (DbClusterArgs) ElementType() reflect.Type

type DbClusterArray

type DbClusterArray []DbClusterInput

func (DbClusterArray) ElementType

func (DbClusterArray) ElementType() reflect.Type

func (DbClusterArray) ToDbClusterArrayOutput

func (i DbClusterArray) ToDbClusterArrayOutput() DbClusterArrayOutput

func (DbClusterArray) ToDbClusterArrayOutputWithContext

func (i DbClusterArray) ToDbClusterArrayOutputWithContext(ctx context.Context) DbClusterArrayOutput

type DbClusterArrayInput

type DbClusterArrayInput interface {
	pulumi.Input

	ToDbClusterArrayOutput() DbClusterArrayOutput
	ToDbClusterArrayOutputWithContext(context.Context) DbClusterArrayOutput
}

DbClusterArrayInput is an input type that accepts DbClusterArray and DbClusterArrayOutput values. You can construct a concrete instance of `DbClusterArrayInput` via:

DbClusterArray{ DbClusterArgs{...} }

type DbClusterArrayOutput

type DbClusterArrayOutput struct{ *pulumi.OutputState }

func (DbClusterArrayOutput) ElementType

func (DbClusterArrayOutput) ElementType() reflect.Type

func (DbClusterArrayOutput) Index

func (DbClusterArrayOutput) ToDbClusterArrayOutput

func (o DbClusterArrayOutput) ToDbClusterArrayOutput() DbClusterArrayOutput

func (DbClusterArrayOutput) ToDbClusterArrayOutputWithContext

func (o DbClusterArrayOutput) ToDbClusterArrayOutputWithContext(ctx context.Context) DbClusterArrayOutput

type DbClusterDbClusterAccessWhiteList added in v3.11.0

type DbClusterDbClusterAccessWhiteList struct {
	// Field `dbClusterIpArrayAttribute` has been removed from provider.
	DbClusterIpArrayAttribute *string `pulumi:"dbClusterIpArrayAttribute"`
	// Whitelist group name.
	DbClusterIpArrayName *string `pulumi:"dbClusterIpArrayName"`
	// The IP address list under the whitelist group.
	SecurityIpList *string `pulumi:"securityIpList"`
}

type DbClusterDbClusterAccessWhiteListArgs added in v3.11.0

type DbClusterDbClusterAccessWhiteListArgs struct {
	// Field `dbClusterIpArrayAttribute` has been removed from provider.
	DbClusterIpArrayAttribute pulumi.StringPtrInput `pulumi:"dbClusterIpArrayAttribute"`
	// Whitelist group name.
	DbClusterIpArrayName pulumi.StringPtrInput `pulumi:"dbClusterIpArrayName"`
	// The IP address list under the whitelist group.
	SecurityIpList pulumi.StringPtrInput `pulumi:"securityIpList"`
}

func (DbClusterDbClusterAccessWhiteListArgs) ElementType added in v3.11.0

func (DbClusterDbClusterAccessWhiteListArgs) ToDbClusterDbClusterAccessWhiteListOutput added in v3.11.0

func (i DbClusterDbClusterAccessWhiteListArgs) ToDbClusterDbClusterAccessWhiteListOutput() DbClusterDbClusterAccessWhiteListOutput

func (DbClusterDbClusterAccessWhiteListArgs) ToDbClusterDbClusterAccessWhiteListOutputWithContext added in v3.11.0

func (i DbClusterDbClusterAccessWhiteListArgs) ToDbClusterDbClusterAccessWhiteListOutputWithContext(ctx context.Context) DbClusterDbClusterAccessWhiteListOutput

type DbClusterDbClusterAccessWhiteListArray added in v3.11.0

type DbClusterDbClusterAccessWhiteListArray []DbClusterDbClusterAccessWhiteListInput

func (DbClusterDbClusterAccessWhiteListArray) ElementType added in v3.11.0

func (DbClusterDbClusterAccessWhiteListArray) ToDbClusterDbClusterAccessWhiteListArrayOutput added in v3.11.0

func (i DbClusterDbClusterAccessWhiteListArray) ToDbClusterDbClusterAccessWhiteListArrayOutput() DbClusterDbClusterAccessWhiteListArrayOutput

func (DbClusterDbClusterAccessWhiteListArray) ToDbClusterDbClusterAccessWhiteListArrayOutputWithContext added in v3.11.0

func (i DbClusterDbClusterAccessWhiteListArray) ToDbClusterDbClusterAccessWhiteListArrayOutputWithContext(ctx context.Context) DbClusterDbClusterAccessWhiteListArrayOutput

type DbClusterDbClusterAccessWhiteListArrayInput added in v3.11.0

type DbClusterDbClusterAccessWhiteListArrayInput interface {
	pulumi.Input

	ToDbClusterDbClusterAccessWhiteListArrayOutput() DbClusterDbClusterAccessWhiteListArrayOutput
	ToDbClusterDbClusterAccessWhiteListArrayOutputWithContext(context.Context) DbClusterDbClusterAccessWhiteListArrayOutput
}

DbClusterDbClusterAccessWhiteListArrayInput is an input type that accepts DbClusterDbClusterAccessWhiteListArray and DbClusterDbClusterAccessWhiteListArrayOutput values. You can construct a concrete instance of `DbClusterDbClusterAccessWhiteListArrayInput` via:

DbClusterDbClusterAccessWhiteListArray{ DbClusterDbClusterAccessWhiteListArgs{...} }

type DbClusterDbClusterAccessWhiteListArrayOutput added in v3.11.0

type DbClusterDbClusterAccessWhiteListArrayOutput struct{ *pulumi.OutputState }

func (DbClusterDbClusterAccessWhiteListArrayOutput) ElementType added in v3.11.0

func (DbClusterDbClusterAccessWhiteListArrayOutput) Index added in v3.11.0

func (DbClusterDbClusterAccessWhiteListArrayOutput) ToDbClusterDbClusterAccessWhiteListArrayOutput added in v3.11.0

func (o DbClusterDbClusterAccessWhiteListArrayOutput) ToDbClusterDbClusterAccessWhiteListArrayOutput() DbClusterDbClusterAccessWhiteListArrayOutput

func (DbClusterDbClusterAccessWhiteListArrayOutput) ToDbClusterDbClusterAccessWhiteListArrayOutputWithContext added in v3.11.0

func (o DbClusterDbClusterAccessWhiteListArrayOutput) ToDbClusterDbClusterAccessWhiteListArrayOutputWithContext(ctx context.Context) DbClusterDbClusterAccessWhiteListArrayOutput

type DbClusterDbClusterAccessWhiteListInput added in v3.11.0

type DbClusterDbClusterAccessWhiteListInput interface {
	pulumi.Input

	ToDbClusterDbClusterAccessWhiteListOutput() DbClusterDbClusterAccessWhiteListOutput
	ToDbClusterDbClusterAccessWhiteListOutputWithContext(context.Context) DbClusterDbClusterAccessWhiteListOutput
}

DbClusterDbClusterAccessWhiteListInput is an input type that accepts DbClusterDbClusterAccessWhiteListArgs and DbClusterDbClusterAccessWhiteListOutput values. You can construct a concrete instance of `DbClusterDbClusterAccessWhiteListInput` via:

DbClusterDbClusterAccessWhiteListArgs{...}

type DbClusterDbClusterAccessWhiteListOutput added in v3.11.0

type DbClusterDbClusterAccessWhiteListOutput struct{ *pulumi.OutputState }

func (DbClusterDbClusterAccessWhiteListOutput) DbClusterIpArrayAttribute added in v3.11.0

func (o DbClusterDbClusterAccessWhiteListOutput) DbClusterIpArrayAttribute() pulumi.StringPtrOutput

Field `dbClusterIpArrayAttribute` has been removed from provider.

func (DbClusterDbClusterAccessWhiteListOutput) DbClusterIpArrayName added in v3.11.0

Whitelist group name.

func (DbClusterDbClusterAccessWhiteListOutput) ElementType added in v3.11.0

func (DbClusterDbClusterAccessWhiteListOutput) SecurityIpList added in v3.11.0

The IP address list under the whitelist group.

func (DbClusterDbClusterAccessWhiteListOutput) ToDbClusterDbClusterAccessWhiteListOutput added in v3.11.0

func (o DbClusterDbClusterAccessWhiteListOutput) ToDbClusterDbClusterAccessWhiteListOutput() DbClusterDbClusterAccessWhiteListOutput

func (DbClusterDbClusterAccessWhiteListOutput) ToDbClusterDbClusterAccessWhiteListOutputWithContext added in v3.11.0

func (o DbClusterDbClusterAccessWhiteListOutput) ToDbClusterDbClusterAccessWhiteListOutputWithContext(ctx context.Context) DbClusterDbClusterAccessWhiteListOutput

type DbClusterInput

type DbClusterInput interface {
	pulumi.Input

	ToDbClusterOutput() DbClusterOutput
	ToDbClusterOutputWithContext(ctx context.Context) DbClusterOutput
}

type DbClusterMap

type DbClusterMap map[string]DbClusterInput

func (DbClusterMap) ElementType

func (DbClusterMap) ElementType() reflect.Type

func (DbClusterMap) ToDbClusterMapOutput

func (i DbClusterMap) ToDbClusterMapOutput() DbClusterMapOutput

func (DbClusterMap) ToDbClusterMapOutputWithContext

func (i DbClusterMap) ToDbClusterMapOutputWithContext(ctx context.Context) DbClusterMapOutput

type DbClusterMapInput

type DbClusterMapInput interface {
	pulumi.Input

	ToDbClusterMapOutput() DbClusterMapOutput
	ToDbClusterMapOutputWithContext(context.Context) DbClusterMapOutput
}

DbClusterMapInput is an input type that accepts DbClusterMap and DbClusterMapOutput values. You can construct a concrete instance of `DbClusterMapInput` via:

DbClusterMap{ "key": DbClusterArgs{...} }

type DbClusterMapOutput

type DbClusterMapOutput struct{ *pulumi.OutputState }

func (DbClusterMapOutput) ElementType

func (DbClusterMapOutput) ElementType() reflect.Type

func (DbClusterMapOutput) MapIndex

func (DbClusterMapOutput) ToDbClusterMapOutput

func (o DbClusterMapOutput) ToDbClusterMapOutput() DbClusterMapOutput

func (DbClusterMapOutput) ToDbClusterMapOutputWithContext

func (o DbClusterMapOutput) ToDbClusterMapOutputWithContext(ctx context.Context) DbClusterMapOutput

type DbClusterOutput

type DbClusterOutput struct{ *pulumi.OutputState }

func (DbClusterOutput) Category added in v3.27.0

func (o DbClusterOutput) Category() pulumi.StringOutput

The Category of DBCluster. Valid values: `Basic`,`HighAvailability`.

func (DbClusterOutput) ConnectionString added in v3.29.0

func (o DbClusterOutput) ConnectionString() pulumi.StringOutput

(Available since v1.196.0) - The connection string of the cluster.

func (DbClusterOutput) DbClusterAccessWhiteLists added in v3.27.0

func (o DbClusterOutput) DbClusterAccessWhiteLists() DbClusterDbClusterAccessWhiteListArrayOutput

The db cluster access white list. See `dbClusterAccessWhiteList` below.

func (DbClusterOutput) DbClusterClass added in v3.27.0

func (o DbClusterOutput) DbClusterClass() pulumi.StringOutput

The DBCluster class. According to the category, dbClusterClass has two value ranges: * Under the condition that the category is the `Basic`, Valid values: `LS20`, `LS40`, `LS80`,`S8`, `S16`, `S32`, `S64`,`S80`, `S104`. * Under the condition that the category is the `HighAvailability`, Valid values: `LC20`, `LC40`, `LC80`,`C8`, `C16`, `C32`, `C64`, `C80`, `C104`.

func (DbClusterOutput) DbClusterDescription added in v3.27.0

func (o DbClusterOutput) DbClusterDescription() pulumi.StringOutput

The DBCluster description.

func (DbClusterOutput) DbClusterNetworkType added in v3.27.0

func (o DbClusterOutput) DbClusterNetworkType() pulumi.StringOutput

The DBCluster network type. Valid values: `vpc`.

func (DbClusterOutput) DbClusterVersion added in v3.27.0

func (o DbClusterOutput) DbClusterVersion() pulumi.StringOutput

The DBCluster version. Valid values: `20.3.10.75`, `20.8.7.15`, `21.8.10.19`, `22.8.5.29`. **NOTE:** `19.15.2.2` is no longer supported. From version 1.191.0, `dbClusterVersion` can be set to `22.8.5.29`.

func (DbClusterOutput) DbNodeGroupCount added in v3.27.0

func (o DbClusterOutput) DbNodeGroupCount() pulumi.IntOutput

The db node group count. The number should between 1 and 48.

func (DbClusterOutput) DbNodeStorage added in v3.27.0

func (o DbClusterOutput) DbNodeStorage() pulumi.StringOutput

The db node storage.

func (DbClusterOutput) ElementType

func (DbClusterOutput) ElementType() reflect.Type

func (DbClusterOutput) EncryptionKey added in v3.27.0

func (o DbClusterOutput) EncryptionKey() pulumi.StringPtrOutput

Key management service KMS key ID. It is valid and required when encryptionType is `CloudDisk`.

func (DbClusterOutput) EncryptionType added in v3.27.0

func (o DbClusterOutput) EncryptionType() pulumi.StringPtrOutput

Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.

func (DbClusterOutput) MaintainTime added in v3.27.0

func (o DbClusterOutput) MaintainTime() pulumi.StringOutput

The maintenance window of DBCluster. Valid format: `hh:mmZ-hh:mm Z`.

func (DbClusterOutput) PaymentType added in v3.27.0

func (o DbClusterOutput) PaymentType() pulumi.StringOutput

The payment type of the resource. Valid values: `PayAsYouGo`,`Subscription`.

func (DbClusterOutput) Period added in v3.27.0

Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when paymentType is `Subscription`. Valid values: `Month`, `Year`.

func (DbClusterOutput) Port added in v3.29.0

(Available since v1.196.0) The connection port of the cluster.

func (DbClusterOutput) Status added in v3.27.0

func (o DbClusterOutput) Status() pulumi.StringOutput

The status of the resource. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`.

func (DbClusterOutput) StorageType added in v3.27.0

func (o DbClusterOutput) StorageType() pulumi.StringOutput

Storage type of DBCluster. Valid values: `cloudEssd`, `cloudEfficiency`, `cloudEssdPl2`, `cloudEssdPl3`.

func (DbClusterOutput) ToDbClusterOutput

func (o DbClusterOutput) ToDbClusterOutput() DbClusterOutput

func (DbClusterOutput) ToDbClusterOutputWithContext

func (o DbClusterOutput) ToDbClusterOutputWithContext(ctx context.Context) DbClusterOutput

func (DbClusterOutput) UsedTime added in v3.27.0

func (o DbClusterOutput) UsedTime() pulumi.StringPtrOutput

The used time of DBCluster. It is valid and required when paymentType is `Subscription`.

func (DbClusterOutput) VpcId added in v3.29.0

The id of the VPC.

func (DbClusterOutput) VswitchId added in v3.27.0

func (o DbClusterOutput) VswitchId() pulumi.StringPtrOutput

The vswitch id of DBCluster.

func (DbClusterOutput) ZoneId added in v3.29.0

func (o DbClusterOutput) ZoneId() pulumi.StringOutput

The zone ID of the instance.

type DbClusterState

type DbClusterState struct {
	// The Category of DBCluster. Valid values: `Basic`,`HighAvailability`.
	Category pulumi.StringPtrInput
	// (Available since v1.196.0) - The connection string of the cluster.
	ConnectionString pulumi.StringPtrInput
	// The db cluster access white list. See `dbClusterAccessWhiteList` below.
	DbClusterAccessWhiteLists DbClusterDbClusterAccessWhiteListArrayInput
	// The DBCluster class. According to the category, dbClusterClass has two value ranges:
	// * Under the condition that the category is the `Basic`, Valid values: `LS20`, `LS40`, `LS80`,`S8`, `S16`, `S32`, `S64`,`S80`, `S104`.
	// * Under the condition that the category is the `HighAvailability`, Valid values: `LC20`, `LC40`, `LC80`,`C8`, `C16`, `C32`, `C64`, `C80`, `C104`.
	DbClusterClass pulumi.StringPtrInput
	// The DBCluster description.
	DbClusterDescription pulumi.StringPtrInput
	// The DBCluster network type. Valid values: `vpc`.
	DbClusterNetworkType pulumi.StringPtrInput
	// The DBCluster version. Valid values: `20.3.10.75`, `20.8.7.15`, `21.8.10.19`, `22.8.5.29`. **NOTE:** `19.15.2.2` is no longer supported. From version 1.191.0, `dbClusterVersion` can be set to `22.8.5.29`.
	DbClusterVersion pulumi.StringPtrInput
	// The db node group count. The number should between 1 and 48.
	DbNodeGroupCount pulumi.IntPtrInput
	// The db node storage.
	DbNodeStorage pulumi.StringPtrInput
	// Key management service KMS key ID. It is valid and required when encryptionType is `CloudDisk`.
	EncryptionKey pulumi.StringPtrInput
	// Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
	EncryptionType pulumi.StringPtrInput
	// The maintenance window of DBCluster. Valid format: `hh:mmZ-hh:mm Z`.
	MaintainTime pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `PayAsYouGo`,`Subscription`.
	PaymentType pulumi.StringPtrInput
	// Pre-paid cluster of the pay-as-you-go cycle. It is valid and required when paymentType is `Subscription`. Valid values: `Month`, `Year`.
	Period pulumi.StringPtrInput
	// (Available since v1.196.0) The connection port of the cluster.
	Port pulumi.StringPtrInput
	// The status of the resource. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`.
	Status pulumi.StringPtrInput
	// Storage type of DBCluster. Valid values: `cloudEssd`, `cloudEfficiency`, `cloudEssdPl2`, `cloudEssdPl3`.
	StorageType pulumi.StringPtrInput
	// The used time of DBCluster. It is valid and required when paymentType is `Subscription`.
	UsedTime pulumi.StringPtrInput
	// The id of the VPC.
	VpcId pulumi.StringPtrInput
	// The vswitch id of DBCluster.
	VswitchId pulumi.StringPtrInput
	// The zone ID of the instance.
	ZoneId pulumi.StringPtrInput
}

func (DbClusterState) ElementType

func (DbClusterState) ElementType() reflect.Type

type GetAccountsAccount

type GetAccountsAccount struct {
	// In Chinese, English letter. May contain Chinese and English characters, lowercase letters, numbers, and underscores (_), the dash (-). Cannot start with http:// and https:// at the beginning. Length is from 2 to 256 characters.
	AccountDescription string `pulumi:"accountDescription"`
	// Account name: lowercase letters, numbers, underscores, lowercase letter; length no more than 16 characters.
	AccountName string `pulumi:"accountName"`
	// The Valid Account type: `Normal`, `Super`.
	AccountType string `pulumi:"accountType"`
	// The DBCluster id.
	DbClusterId string `pulumi:"dbClusterId"`
	// The ID of the Account. Its value is same as Queue Name.
	Id string `pulumi:"id"`
	// The status of the resource.
	Status string `pulumi:"status"`
}

type GetAccountsAccountArgs

type GetAccountsAccountArgs struct {
	// In Chinese, English letter. May contain Chinese and English characters, lowercase letters, numbers, and underscores (_), the dash (-). Cannot start with http:// and https:// at the beginning. Length is from 2 to 256 characters.
	AccountDescription pulumi.StringInput `pulumi:"accountDescription"`
	// Account name: lowercase letters, numbers, underscores, lowercase letter; length no more than 16 characters.
	AccountName pulumi.StringInput `pulumi:"accountName"`
	// The Valid Account type: `Normal`, `Super`.
	AccountType pulumi.StringInput `pulumi:"accountType"`
	// The DBCluster id.
	DbClusterId pulumi.StringInput `pulumi:"dbClusterId"`
	// The ID of the Account. Its value is same as Queue Name.
	Id pulumi.StringInput `pulumi:"id"`
	// The status of the resource.
	Status pulumi.StringInput `pulumi:"status"`
}

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

func (GetAccountsAccountArrayOutput) ToGetAccountsAccountArrayOutput

func (o GetAccountsAccountArrayOutput) ToGetAccountsAccountArrayOutput() GetAccountsAccountArrayOutput

func (GetAccountsAccountArrayOutput) ToGetAccountsAccountArrayOutputWithContext

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

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

In Chinese, English letter. May contain Chinese and English characters, lowercase letters, numbers, and underscores (_), the dash (-). Cannot start with http:// and https:// at the beginning. Length is from 2 to 256 characters.

func (GetAccountsAccountOutput) AccountName

Account name: lowercase letters, numbers, underscores, lowercase letter; length no more than 16 characters.

func (GetAccountsAccountOutput) AccountType

The Valid Account type: `Normal`, `Super`.

func (GetAccountsAccountOutput) DbClusterId

The DBCluster id.

func (GetAccountsAccountOutput) ElementType

func (GetAccountsAccountOutput) ElementType() reflect.Type

func (GetAccountsAccountOutput) Id

The ID of the Account. Its value is same as Queue Name.

func (GetAccountsAccountOutput) Status

The status of the resource.

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 DBCluster id.
	DbClusterId string `pulumi:"dbClusterId"`
	// A list of Account IDs. Its element value is same as Account Name.
	Ids []string `pulumi:"ids"`
	// A regex string to filter results by Account name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// The status of the resource.
	Status *string `pulumi:"status"`
}

A collection of arguments for invoking getAccounts.

type GetAccountsOutputArgs added in v3.9.0

type GetAccountsOutputArgs struct {
	// The DBCluster id.
	DbClusterId pulumi.StringInput `pulumi:"dbClusterId"`
	// A list of Account IDs. Its element value is same as Account Name.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// A regex string to filter results by Account name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// The status of the resource.
	Status pulumi.StringPtrInput `pulumi:"status"`
}

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 {
	Accounts    []GetAccountsAccount `pulumi:"accounts"`
	DbClusterId string               `pulumi:"dbClusterId"`
	// The provider-assigned unique ID for this managed resource.
	Id         string   `pulumi:"id"`
	Ids        []string `pulumi:"ids"`
	NameRegex  *string  `pulumi:"nameRegex"`
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	Status     *string  `pulumi:"status"`
}

A collection of values returned by getAccounts.

func GetAccounts

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

This data source provides the Click House Accounts of the current Alibaba Cloud user.

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

## Example Usage

Basic Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/clickhouse"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { cfg := config.New(ctx, "") name := "testaccountname"; if param := cfg.Get("name"); param != ""{ name = param } pwd := "Tf-testpwd"; if param := cfg.Get("pwd"); param != ""{ pwd = param } defaultDbCluster, err := clickhouse.NewDbCluster(ctx, "default", &clickhouse.DbClusterArgs{ DbClusterVersion: pulumi.String("20.3.10.75"), Category: pulumi.String("Basic"), DbClusterClass: pulumi.String("S8"), DbClusterNetworkType: pulumi.String("vpc"), DbClusterDescription: pulumi.String(name), DbNodeGroupCount: pulumi.Int(1), PaymentType: pulumi.String("PayAsYouGo"), DbNodeStorage: pulumi.String("500"), StorageType: pulumi.String("cloud_essd"), VswitchId: pulumi.String("your_vswitch_id"), }) if err != nil { return err } defaultAccount, err := clickhouse.NewAccount(ctx, "default", &clickhouse.AccountArgs{ DbClusterId: defaultDbCluster.ID(), AccountDescription: pulumi.String("your_description"), AccountName: pulumi.String(name), AccountPassword: pulumi.String(pwd), }) if err != nil { return err } _default := clickhouse.GetAccountsOutput(ctx, clickhouse.GetAccountsOutputArgs{ Ids: pulumi.StringArray{ defaultAccount.ID(), }, DbClusterId: defaultDbCluster.ID(), }, nil); ctx.Export("accountId", _default.ApplyT(func(_default clickhouse.GetAccountsResult) (*string, error) { return &default.Ids[0], 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 (GetAccountsResultOutput) DbClusterId added in v3.9.0

func (GetAccountsResultOutput) ElementType added in v3.9.0

func (GetAccountsResultOutput) ElementType() reflect.Type

func (GetAccountsResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetAccountsResultOutput) Ids added in v3.9.0

func (GetAccountsResultOutput) NameRegex added in v3.9.0

func (GetAccountsResultOutput) Names added in v3.9.0

func (GetAccountsResultOutput) OutputFile added in v3.9.0

func (GetAccountsResultOutput) Status added in v3.9.0

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 GetBackupPoliciesArgs added in v3.12.0

type GetBackupPoliciesArgs struct {
	// The db cluster id.
	DbClusterId string `pulumi:"dbClusterId"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
}

A collection of arguments for invoking getBackupPolicies.

type GetBackupPoliciesOutputArgs added in v3.12.0

type GetBackupPoliciesOutputArgs struct {
	// The db cluster id.
	DbClusterId pulumi.StringInput `pulumi:"dbClusterId"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
}

A collection of arguments for invoking getBackupPolicies.

func (GetBackupPoliciesOutputArgs) ElementType added in v3.12.0

type GetBackupPoliciesPolicy added in v3.12.0

type GetBackupPoliciesPolicy struct {
	// Data backup days. Valid values: `7` to `730`.
	BackupRetentionPeriod int `pulumi:"backupRetentionPeriod"`
	// The db cluster id.
	DbClusterId string `pulumi:"dbClusterId"`
	// The ID of the Backup Policy.
	Id string `pulumi:"id"`
	// DBCluster Backup period.
	PreferredBackupPeriods []string `pulumi:"preferredBackupPeriods"`
	// Backup Time, UTC time.
	PreferredBackupTime string `pulumi:"preferredBackupTime"`
	// The status of the resource.
	Status string `pulumi:"status"`
}

type GetBackupPoliciesPolicyArgs added in v3.12.0

type GetBackupPoliciesPolicyArgs struct {
	// Data backup days. Valid values: `7` to `730`.
	BackupRetentionPeriod pulumi.IntInput `pulumi:"backupRetentionPeriod"`
	// The db cluster id.
	DbClusterId pulumi.StringInput `pulumi:"dbClusterId"`
	// The ID of the Backup Policy.
	Id pulumi.StringInput `pulumi:"id"`
	// DBCluster Backup period.
	PreferredBackupPeriods pulumi.StringArrayInput `pulumi:"preferredBackupPeriods"`
	// Backup Time, UTC time.
	PreferredBackupTime pulumi.StringInput `pulumi:"preferredBackupTime"`
	// The status of the resource.
	Status pulumi.StringInput `pulumi:"status"`
}

func (GetBackupPoliciesPolicyArgs) ElementType added in v3.12.0

func (GetBackupPoliciesPolicyArgs) ToGetBackupPoliciesPolicyOutput added in v3.12.0

func (i GetBackupPoliciesPolicyArgs) ToGetBackupPoliciesPolicyOutput() GetBackupPoliciesPolicyOutput

func (GetBackupPoliciesPolicyArgs) ToGetBackupPoliciesPolicyOutputWithContext added in v3.12.0

func (i GetBackupPoliciesPolicyArgs) ToGetBackupPoliciesPolicyOutputWithContext(ctx context.Context) GetBackupPoliciesPolicyOutput

type GetBackupPoliciesPolicyArray added in v3.12.0

type GetBackupPoliciesPolicyArray []GetBackupPoliciesPolicyInput

func (GetBackupPoliciesPolicyArray) ElementType added in v3.12.0

func (GetBackupPoliciesPolicyArray) ToGetBackupPoliciesPolicyArrayOutput added in v3.12.0

func (i GetBackupPoliciesPolicyArray) ToGetBackupPoliciesPolicyArrayOutput() GetBackupPoliciesPolicyArrayOutput

func (GetBackupPoliciesPolicyArray) ToGetBackupPoliciesPolicyArrayOutputWithContext added in v3.12.0

func (i GetBackupPoliciesPolicyArray) ToGetBackupPoliciesPolicyArrayOutputWithContext(ctx context.Context) GetBackupPoliciesPolicyArrayOutput

type GetBackupPoliciesPolicyArrayInput added in v3.12.0

type GetBackupPoliciesPolicyArrayInput interface {
	pulumi.Input

	ToGetBackupPoliciesPolicyArrayOutput() GetBackupPoliciesPolicyArrayOutput
	ToGetBackupPoliciesPolicyArrayOutputWithContext(context.Context) GetBackupPoliciesPolicyArrayOutput
}

GetBackupPoliciesPolicyArrayInput is an input type that accepts GetBackupPoliciesPolicyArray and GetBackupPoliciesPolicyArrayOutput values. You can construct a concrete instance of `GetBackupPoliciesPolicyArrayInput` via:

GetBackupPoliciesPolicyArray{ GetBackupPoliciesPolicyArgs{...} }

type GetBackupPoliciesPolicyArrayOutput added in v3.12.0

type GetBackupPoliciesPolicyArrayOutput struct{ *pulumi.OutputState }

func (GetBackupPoliciesPolicyArrayOutput) ElementType added in v3.12.0

func (GetBackupPoliciesPolicyArrayOutput) Index added in v3.12.0

func (GetBackupPoliciesPolicyArrayOutput) ToGetBackupPoliciesPolicyArrayOutput added in v3.12.0

func (o GetBackupPoliciesPolicyArrayOutput) ToGetBackupPoliciesPolicyArrayOutput() GetBackupPoliciesPolicyArrayOutput

func (GetBackupPoliciesPolicyArrayOutput) ToGetBackupPoliciesPolicyArrayOutputWithContext added in v3.12.0

func (o GetBackupPoliciesPolicyArrayOutput) ToGetBackupPoliciesPolicyArrayOutputWithContext(ctx context.Context) GetBackupPoliciesPolicyArrayOutput

type GetBackupPoliciesPolicyInput added in v3.12.0

type GetBackupPoliciesPolicyInput interface {
	pulumi.Input

	ToGetBackupPoliciesPolicyOutput() GetBackupPoliciesPolicyOutput
	ToGetBackupPoliciesPolicyOutputWithContext(context.Context) GetBackupPoliciesPolicyOutput
}

GetBackupPoliciesPolicyInput is an input type that accepts GetBackupPoliciesPolicyArgs and GetBackupPoliciesPolicyOutput values. You can construct a concrete instance of `GetBackupPoliciesPolicyInput` via:

GetBackupPoliciesPolicyArgs{...}

type GetBackupPoliciesPolicyOutput added in v3.12.0

type GetBackupPoliciesPolicyOutput struct{ *pulumi.OutputState }

func (GetBackupPoliciesPolicyOutput) BackupRetentionPeriod added in v3.12.0

func (o GetBackupPoliciesPolicyOutput) BackupRetentionPeriod() pulumi.IntOutput

Data backup days. Valid values: `7` to `730`.

func (GetBackupPoliciesPolicyOutput) DbClusterId added in v3.12.0

The db cluster id.

func (GetBackupPoliciesPolicyOutput) ElementType added in v3.12.0

func (GetBackupPoliciesPolicyOutput) Id added in v3.12.0

The ID of the Backup Policy.

func (GetBackupPoliciesPolicyOutput) PreferredBackupPeriods added in v3.12.0

func (o GetBackupPoliciesPolicyOutput) PreferredBackupPeriods() pulumi.StringArrayOutput

DBCluster Backup period.

func (GetBackupPoliciesPolicyOutput) PreferredBackupTime added in v3.12.0

func (o GetBackupPoliciesPolicyOutput) PreferredBackupTime() pulumi.StringOutput

Backup Time, UTC time.

func (GetBackupPoliciesPolicyOutput) Status added in v3.12.0

The status of the resource.

func (GetBackupPoliciesPolicyOutput) ToGetBackupPoliciesPolicyOutput added in v3.12.0

func (o GetBackupPoliciesPolicyOutput) ToGetBackupPoliciesPolicyOutput() GetBackupPoliciesPolicyOutput

func (GetBackupPoliciesPolicyOutput) ToGetBackupPoliciesPolicyOutputWithContext added in v3.12.0

func (o GetBackupPoliciesPolicyOutput) ToGetBackupPoliciesPolicyOutputWithContext(ctx context.Context) GetBackupPoliciesPolicyOutput

type GetBackupPoliciesResult added in v3.12.0

type GetBackupPoliciesResult struct {
	DbClusterId string `pulumi:"dbClusterId"`
	// The provider-assigned unique ID for this managed resource.
	Id         string                    `pulumi:"id"`
	OutputFile *string                   `pulumi:"outputFile"`
	Policies   []GetBackupPoliciesPolicy `pulumi:"policies"`
}

A collection of values returned by getBackupPolicies.

func GetBackupPolicies added in v3.12.0

func GetBackupPolicies(ctx *pulumi.Context, args *GetBackupPoliciesArgs, opts ...pulumi.InvokeOption) (*GetBackupPoliciesResult, error)

This data source provides the Click House Backup Policies of the current Alibaba Cloud user.

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

## Example Usage

Basic Usage

```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := clickhouse.GetBackupPolicies(ctx, &clickhouse.GetBackupPoliciesArgs{
			DbClusterId: "example_value",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("clickHouseBackupPolicyId1", example.Policies[0].Id)
		return nil
	})
}

```

type GetBackupPoliciesResultOutput added in v3.12.0

type GetBackupPoliciesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getBackupPolicies.

func GetBackupPoliciesOutput added in v3.12.0

func (GetBackupPoliciesResultOutput) DbClusterId added in v3.12.0

func (GetBackupPoliciesResultOutput) ElementType added in v3.12.0

func (GetBackupPoliciesResultOutput) Id added in v3.12.0

The provider-assigned unique ID for this managed resource.

func (GetBackupPoliciesResultOutput) OutputFile added in v3.12.0

func (GetBackupPoliciesResultOutput) Policies added in v3.12.0

func (GetBackupPoliciesResultOutput) ToGetBackupPoliciesResultOutput added in v3.12.0

func (o GetBackupPoliciesResultOutput) ToGetBackupPoliciesResultOutput() GetBackupPoliciesResultOutput

func (GetBackupPoliciesResultOutput) ToGetBackupPoliciesResultOutputWithContext added in v3.12.0

func (o GetBackupPoliciesResultOutput) ToGetBackupPoliciesResultOutputWithContext(ctx context.Context) GetBackupPoliciesResultOutput

type GetDbClustersArgs

type GetDbClustersArgs struct {
	// The DBCluster description.
	DbClusterDescription *string `pulumi:"dbClusterDescription"`
	// Default to `false`. Set it to `true` can output more details about resource attributes.
	EnableDetails *bool `pulumi:"enableDetails"`
	// A list of DBCluster IDs.
	Ids []string `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// The status of the resource. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`,.
	Status *string `pulumi:"status"`
}

A collection of arguments for invoking getDbClusters.

type GetDbClustersCluster

type GetDbClustersCluster struct {
	// Alibaba Cloud account Id.
	AliUid string `pulumi:"aliUid"`
	// The ID of the business process flow.
	Bid string `pulumi:"bid"`
	// Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.
	Category string `pulumi:"category"`
	// The Commodity Code of the DBCluster.
	CommodityCode string `pulumi:"commodityCode"`
	// Connection string.
	ConnectionString string `pulumi:"connectionString"`
	// The control version of the DBCluster.
	ControlVersion string `pulumi:"controlVersion"`
	// The creation time of the resource.
	CreateTime string `pulumi:"createTime"`
	// The db cluster access white list.
	DbClusterAccessWhiteLists []GetDbClustersClusterDbClusterAccessWhiteList `pulumi:"dbClusterAccessWhiteLists"`
	// The DBCluster description.
	DbClusterDescription string `pulumi:"dbClusterDescription"`
	DbClusterId          string `pulumi:"dbClusterId"`
	// The DBCluster network type.
	DbClusterNetworkType string `pulumi:"dbClusterNetworkType"`
	// The DBCluster type.
	DbClusterType string `pulumi:"dbClusterType"`
	// The node class of the DBCluster.
	DbNodeClass string `pulumi:"dbNodeClass"`
	// The node count of the DBCluster.
	DbNodeCount string `pulumi:"dbNodeCount"`
	// The node storage of the DBCluster.
	DbNodeStorage string `pulumi:"dbNodeStorage"`
	// Key management service KMS key ID.
	EncryptionKey string `pulumi:"encryptionKey"`
	// Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
	EncryptionType string `pulumi:"encryptionType"`
	// The Engine of the DBCluster.
	Engine string `pulumi:"engine"`
	// The engine version of the DBCluster.
	EngineVersion string `pulumi:"engineVersion"`
	// The expiration time of the DBCluster.
	ExpireTime string `pulumi:"expireTime"`
	// The ID of the DBCluster.
	Id string `pulumi:"id"`
	// If the instance has expired.
	IsExpired string `pulumi:"isExpired"`
	// The lock mode of the DBCluster.
	LockMode string `pulumi:"lockMode"`
	// Lock reason of the DBCluster.
	LockReason string `pulumi:"lockReason"`
	// Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
	MaintainTime string `pulumi:"maintainTime"`
	// The payment type of the resource. Valid values: `PayAsYouGo`,`Subscription`.
	PaymentType string `pulumi:"paymentType"`
	// Connection port.
	Port int `pulumi:"port"`
	// A public IP address for the connection.
	PublicConnectionString string `pulumi:"publicConnectionString"`
	// Public network port.
	PublicPort string `pulumi:"publicPort"`
	// Scale state.
	ScaleOutStatuses []GetDbClustersClusterScaleOutStatus `pulumi:"scaleOutStatuses"`
	// The status of the DBCluster. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`.
	Status string `pulumi:"status"`
	// Storage type of DBCluster. Valid values: `cloudEssd`, `cloudEfficiency`, `cloudEssdPl2`, `cloudEssdPl3`.
	StorageType string `pulumi:"storageType"`
	// Support fallback scheme.
	SupportBackup int `pulumi:"supportBackup"`
	// The system supports http port number.
	SupportHttpsPort bool `pulumi:"supportHttpsPort"`
	// Supports Mysql, and those of the ports.
	SupportMysqlPort bool `pulumi:"supportMysqlPort"`
	// Virtual Private Cloud (VPC cloud instance ID.
	VpcCloudInstanceId string `pulumi:"vpcCloudInstanceId"`
	// The VPC ID of the DBCluster.
	VpcId string `pulumi:"vpcId"`
	// The vswitch id of the DBCluster.
	VswitchId string `pulumi:"vswitchId"`
	// The zone ID of the DBCluster.
	ZoneId string `pulumi:"zoneId"`
}

type GetDbClustersClusterArgs

type GetDbClustersClusterArgs struct {
	// Alibaba Cloud account Id.
	AliUid pulumi.StringInput `pulumi:"aliUid"`
	// The ID of the business process flow.
	Bid pulumi.StringInput `pulumi:"bid"`
	// Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.
	Category pulumi.StringInput `pulumi:"category"`
	// The Commodity Code of the DBCluster.
	CommodityCode pulumi.StringInput `pulumi:"commodityCode"`
	// Connection string.
	ConnectionString pulumi.StringInput `pulumi:"connectionString"`
	// The control version of the DBCluster.
	ControlVersion pulumi.StringInput `pulumi:"controlVersion"`
	// The creation time of the resource.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The db cluster access white list.
	DbClusterAccessWhiteLists GetDbClustersClusterDbClusterAccessWhiteListArrayInput `pulumi:"dbClusterAccessWhiteLists"`
	// The DBCluster description.
	DbClusterDescription pulumi.StringInput `pulumi:"dbClusterDescription"`
	DbClusterId          pulumi.StringInput `pulumi:"dbClusterId"`
	// The DBCluster network type.
	DbClusterNetworkType pulumi.StringInput `pulumi:"dbClusterNetworkType"`
	// The DBCluster type.
	DbClusterType pulumi.StringInput `pulumi:"dbClusterType"`
	// The node class of the DBCluster.
	DbNodeClass pulumi.StringInput `pulumi:"dbNodeClass"`
	// The node count of the DBCluster.
	DbNodeCount pulumi.StringInput `pulumi:"dbNodeCount"`
	// The node storage of the DBCluster.
	DbNodeStorage pulumi.StringInput `pulumi:"dbNodeStorage"`
	// Key management service KMS key ID.
	EncryptionKey pulumi.StringInput `pulumi:"encryptionKey"`
	// Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
	EncryptionType pulumi.StringInput `pulumi:"encryptionType"`
	// The Engine of the DBCluster.
	Engine pulumi.StringInput `pulumi:"engine"`
	// The engine version of the DBCluster.
	EngineVersion pulumi.StringInput `pulumi:"engineVersion"`
	// The expiration time of the DBCluster.
	ExpireTime pulumi.StringInput `pulumi:"expireTime"`
	// The ID of the DBCluster.
	Id pulumi.StringInput `pulumi:"id"`
	// If the instance has expired.
	IsExpired pulumi.StringInput `pulumi:"isExpired"`
	// The lock mode of the DBCluster.
	LockMode pulumi.StringInput `pulumi:"lockMode"`
	// Lock reason of the DBCluster.
	LockReason pulumi.StringInput `pulumi:"lockReason"`
	// Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
	MaintainTime pulumi.StringInput `pulumi:"maintainTime"`
	// The payment type of the resource. Valid values: `PayAsYouGo`,`Subscription`.
	PaymentType pulumi.StringInput `pulumi:"paymentType"`
	// Connection port.
	Port pulumi.IntInput `pulumi:"port"`
	// A public IP address for the connection.
	PublicConnectionString pulumi.StringInput `pulumi:"publicConnectionString"`
	// Public network port.
	PublicPort pulumi.StringInput `pulumi:"publicPort"`
	// Scale state.
	ScaleOutStatuses GetDbClustersClusterScaleOutStatusArrayInput `pulumi:"scaleOutStatuses"`
	// The status of the DBCluster. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`.
	Status pulumi.StringInput `pulumi:"status"`
	// Storage type of DBCluster. Valid values: `cloudEssd`, `cloudEfficiency`, `cloudEssdPl2`, `cloudEssdPl3`.
	StorageType pulumi.StringInput `pulumi:"storageType"`
	// Support fallback scheme.
	SupportBackup pulumi.IntInput `pulumi:"supportBackup"`
	// The system supports http port number.
	SupportHttpsPort pulumi.BoolInput `pulumi:"supportHttpsPort"`
	// Supports Mysql, and those of the ports.
	SupportMysqlPort pulumi.BoolInput `pulumi:"supportMysqlPort"`
	// Virtual Private Cloud (VPC cloud instance ID.
	VpcCloudInstanceId pulumi.StringInput `pulumi:"vpcCloudInstanceId"`
	// The VPC ID of the DBCluster.
	VpcId pulumi.StringInput `pulumi:"vpcId"`
	// The vswitch id of the DBCluster.
	VswitchId pulumi.StringInput `pulumi:"vswitchId"`
	// The zone ID of the DBCluster.
	ZoneId pulumi.StringInput `pulumi:"zoneId"`
}

func (GetDbClustersClusterArgs) ElementType

func (GetDbClustersClusterArgs) ElementType() reflect.Type

func (GetDbClustersClusterArgs) ToGetDbClustersClusterOutput

func (i GetDbClustersClusterArgs) ToGetDbClustersClusterOutput() GetDbClustersClusterOutput

func (GetDbClustersClusterArgs) ToGetDbClustersClusterOutputWithContext

func (i GetDbClustersClusterArgs) ToGetDbClustersClusterOutputWithContext(ctx context.Context) GetDbClustersClusterOutput

type GetDbClustersClusterArray

type GetDbClustersClusterArray []GetDbClustersClusterInput

func (GetDbClustersClusterArray) ElementType

func (GetDbClustersClusterArray) ElementType() reflect.Type

func (GetDbClustersClusterArray) ToGetDbClustersClusterArrayOutput

func (i GetDbClustersClusterArray) ToGetDbClustersClusterArrayOutput() GetDbClustersClusterArrayOutput

func (GetDbClustersClusterArray) ToGetDbClustersClusterArrayOutputWithContext

func (i GetDbClustersClusterArray) ToGetDbClustersClusterArrayOutputWithContext(ctx context.Context) GetDbClustersClusterArrayOutput

type GetDbClustersClusterArrayInput

type GetDbClustersClusterArrayInput interface {
	pulumi.Input

	ToGetDbClustersClusterArrayOutput() GetDbClustersClusterArrayOutput
	ToGetDbClustersClusterArrayOutputWithContext(context.Context) GetDbClustersClusterArrayOutput
}

GetDbClustersClusterArrayInput is an input type that accepts GetDbClustersClusterArray and GetDbClustersClusterArrayOutput values. You can construct a concrete instance of `GetDbClustersClusterArrayInput` via:

GetDbClustersClusterArray{ GetDbClustersClusterArgs{...} }

type GetDbClustersClusterArrayOutput

type GetDbClustersClusterArrayOutput struct{ *pulumi.OutputState }

func (GetDbClustersClusterArrayOutput) ElementType

func (GetDbClustersClusterArrayOutput) Index

func (GetDbClustersClusterArrayOutput) ToGetDbClustersClusterArrayOutput

func (o GetDbClustersClusterArrayOutput) ToGetDbClustersClusterArrayOutput() GetDbClustersClusterArrayOutput

func (GetDbClustersClusterArrayOutput) ToGetDbClustersClusterArrayOutputWithContext

func (o GetDbClustersClusterArrayOutput) ToGetDbClustersClusterArrayOutputWithContext(ctx context.Context) GetDbClustersClusterArrayOutput

type GetDbClustersClusterDbClusterAccessWhiteList added in v3.11.0

type GetDbClustersClusterDbClusterAccessWhiteList struct {
	DbClusterIpArrayAttribute string `pulumi:"dbClusterIpArrayAttribute"`
	DbClusterIpArrayName      string `pulumi:"dbClusterIpArrayName"`
	SecurityIpList            string `pulumi:"securityIpList"`
}

type GetDbClustersClusterDbClusterAccessWhiteListArgs added in v3.11.0

type GetDbClustersClusterDbClusterAccessWhiteListArgs struct {
	DbClusterIpArrayAttribute pulumi.StringInput `pulumi:"dbClusterIpArrayAttribute"`
	DbClusterIpArrayName      pulumi.StringInput `pulumi:"dbClusterIpArrayName"`
	SecurityIpList            pulumi.StringInput `pulumi:"securityIpList"`
}

func (GetDbClustersClusterDbClusterAccessWhiteListArgs) ElementType added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListArgs) ToGetDbClustersClusterDbClusterAccessWhiteListOutput added in v3.11.0

func (i GetDbClustersClusterDbClusterAccessWhiteListArgs) ToGetDbClustersClusterDbClusterAccessWhiteListOutput() GetDbClustersClusterDbClusterAccessWhiteListOutput

func (GetDbClustersClusterDbClusterAccessWhiteListArgs) ToGetDbClustersClusterDbClusterAccessWhiteListOutputWithContext added in v3.11.0

func (i GetDbClustersClusterDbClusterAccessWhiteListArgs) ToGetDbClustersClusterDbClusterAccessWhiteListOutputWithContext(ctx context.Context) GetDbClustersClusterDbClusterAccessWhiteListOutput

type GetDbClustersClusterDbClusterAccessWhiteListArray added in v3.11.0

type GetDbClustersClusterDbClusterAccessWhiteListArray []GetDbClustersClusterDbClusterAccessWhiteListInput

func (GetDbClustersClusterDbClusterAccessWhiteListArray) ElementType added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListArray) ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutput added in v3.11.0

func (i GetDbClustersClusterDbClusterAccessWhiteListArray) ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutput() GetDbClustersClusterDbClusterAccessWhiteListArrayOutput

func (GetDbClustersClusterDbClusterAccessWhiteListArray) ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutputWithContext added in v3.11.0

func (i GetDbClustersClusterDbClusterAccessWhiteListArray) ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutputWithContext(ctx context.Context) GetDbClustersClusterDbClusterAccessWhiteListArrayOutput

type GetDbClustersClusterDbClusterAccessWhiteListArrayInput added in v3.11.0

type GetDbClustersClusterDbClusterAccessWhiteListArrayInput interface {
	pulumi.Input

	ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutput() GetDbClustersClusterDbClusterAccessWhiteListArrayOutput
	ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutputWithContext(context.Context) GetDbClustersClusterDbClusterAccessWhiteListArrayOutput
}

GetDbClustersClusterDbClusterAccessWhiteListArrayInput is an input type that accepts GetDbClustersClusterDbClusterAccessWhiteListArray and GetDbClustersClusterDbClusterAccessWhiteListArrayOutput values. You can construct a concrete instance of `GetDbClustersClusterDbClusterAccessWhiteListArrayInput` via:

GetDbClustersClusterDbClusterAccessWhiteListArray{ GetDbClustersClusterDbClusterAccessWhiteListArgs{...} }

type GetDbClustersClusterDbClusterAccessWhiteListArrayOutput added in v3.11.0

type GetDbClustersClusterDbClusterAccessWhiteListArrayOutput struct{ *pulumi.OutputState }

func (GetDbClustersClusterDbClusterAccessWhiteListArrayOutput) ElementType added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListArrayOutput) Index added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListArrayOutput) ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutput added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListArrayOutput) ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutputWithContext added in v3.11.0

func (o GetDbClustersClusterDbClusterAccessWhiteListArrayOutput) ToGetDbClustersClusterDbClusterAccessWhiteListArrayOutputWithContext(ctx context.Context) GetDbClustersClusterDbClusterAccessWhiteListArrayOutput

type GetDbClustersClusterDbClusterAccessWhiteListInput added in v3.11.0

type GetDbClustersClusterDbClusterAccessWhiteListInput interface {
	pulumi.Input

	ToGetDbClustersClusterDbClusterAccessWhiteListOutput() GetDbClustersClusterDbClusterAccessWhiteListOutput
	ToGetDbClustersClusterDbClusterAccessWhiteListOutputWithContext(context.Context) GetDbClustersClusterDbClusterAccessWhiteListOutput
}

GetDbClustersClusterDbClusterAccessWhiteListInput is an input type that accepts GetDbClustersClusterDbClusterAccessWhiteListArgs and GetDbClustersClusterDbClusterAccessWhiteListOutput values. You can construct a concrete instance of `GetDbClustersClusterDbClusterAccessWhiteListInput` via:

GetDbClustersClusterDbClusterAccessWhiteListArgs{...}

type GetDbClustersClusterDbClusterAccessWhiteListOutput added in v3.11.0

type GetDbClustersClusterDbClusterAccessWhiteListOutput struct{ *pulumi.OutputState }

func (GetDbClustersClusterDbClusterAccessWhiteListOutput) DbClusterIpArrayAttribute added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListOutput) DbClusterIpArrayName added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListOutput) ElementType added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListOutput) SecurityIpList added in v3.11.0

func (GetDbClustersClusterDbClusterAccessWhiteListOutput) ToGetDbClustersClusterDbClusterAccessWhiteListOutput added in v3.11.0

func (o GetDbClustersClusterDbClusterAccessWhiteListOutput) ToGetDbClustersClusterDbClusterAccessWhiteListOutput() GetDbClustersClusterDbClusterAccessWhiteListOutput

func (GetDbClustersClusterDbClusterAccessWhiteListOutput) ToGetDbClustersClusterDbClusterAccessWhiteListOutputWithContext added in v3.11.0

func (o GetDbClustersClusterDbClusterAccessWhiteListOutput) ToGetDbClustersClusterDbClusterAccessWhiteListOutputWithContext(ctx context.Context) GetDbClustersClusterDbClusterAccessWhiteListOutput

type GetDbClustersClusterInput

type GetDbClustersClusterInput interface {
	pulumi.Input

	ToGetDbClustersClusterOutput() GetDbClustersClusterOutput
	ToGetDbClustersClusterOutputWithContext(context.Context) GetDbClustersClusterOutput
}

GetDbClustersClusterInput is an input type that accepts GetDbClustersClusterArgs and GetDbClustersClusterOutput values. You can construct a concrete instance of `GetDbClustersClusterInput` via:

GetDbClustersClusterArgs{...}

type GetDbClustersClusterOutput

type GetDbClustersClusterOutput struct{ *pulumi.OutputState }

func (GetDbClustersClusterOutput) AliUid

Alibaba Cloud account Id.

func (GetDbClustersClusterOutput) Bid

The ID of the business process flow.

func (GetDbClustersClusterOutput) Category

Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.

func (GetDbClustersClusterOutput) CommodityCode

The Commodity Code of the DBCluster.

func (GetDbClustersClusterOutput) ConnectionString

func (o GetDbClustersClusterOutput) ConnectionString() pulumi.StringOutput

Connection string.

func (GetDbClustersClusterOutput) ControlVersion added in v3.12.0

func (o GetDbClustersClusterOutput) ControlVersion() pulumi.StringOutput

The control version of the DBCluster.

func (GetDbClustersClusterOutput) CreateTime

The creation time of the resource.

func (GetDbClustersClusterOutput) DbClusterAccessWhiteLists added in v3.11.0

The db cluster access white list.

func (GetDbClustersClusterOutput) DbClusterDescription

func (o GetDbClustersClusterOutput) DbClusterDescription() pulumi.StringOutput

The DBCluster description.

func (GetDbClustersClusterOutput) DbClusterId

func (GetDbClustersClusterOutput) DbClusterNetworkType

func (o GetDbClustersClusterOutput) DbClusterNetworkType() pulumi.StringOutput

The DBCluster network type.

func (GetDbClustersClusterOutput) DbClusterType

The DBCluster type.

func (GetDbClustersClusterOutput) DbNodeClass

The node class of the DBCluster.

func (GetDbClustersClusterOutput) DbNodeCount

The node count of the DBCluster.

func (GetDbClustersClusterOutput) DbNodeStorage

The node storage of the DBCluster.

func (GetDbClustersClusterOutput) ElementType

func (GetDbClustersClusterOutput) ElementType() reflect.Type

func (GetDbClustersClusterOutput) EncryptionKey

Key management service KMS key ID.

func (GetDbClustersClusterOutput) EncryptionType

func (o GetDbClustersClusterOutput) EncryptionType() pulumi.StringOutput

Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.

func (GetDbClustersClusterOutput) Engine

The Engine of the DBCluster.

func (GetDbClustersClusterOutput) EngineVersion

The engine version of the DBCluster.

func (GetDbClustersClusterOutput) ExpireTime

The expiration time of the DBCluster.

func (GetDbClustersClusterOutput) Id

The ID of the DBCluster.

func (GetDbClustersClusterOutput) IsExpired

If the instance has expired.

func (GetDbClustersClusterOutput) LockMode

The lock mode of the DBCluster.

func (GetDbClustersClusterOutput) LockReason

Lock reason of the DBCluster.

func (GetDbClustersClusterOutput) MaintainTime

Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.

func (GetDbClustersClusterOutput) PaymentType

The payment type of the resource. Valid values: `PayAsYouGo`,`Subscription`.

func (GetDbClustersClusterOutput) Port

Connection port.

func (GetDbClustersClusterOutput) PublicConnectionString

func (o GetDbClustersClusterOutput) PublicConnectionString() pulumi.StringOutput

A public IP address for the connection.

func (GetDbClustersClusterOutput) PublicPort

Public network port.

func (GetDbClustersClusterOutput) ScaleOutStatuses

Scale state.

func (GetDbClustersClusterOutput) Status added in v3.12.0

The status of the DBCluster. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`.

func (GetDbClustersClusterOutput) StorageType

Storage type of DBCluster. Valid values: `cloudEssd`, `cloudEfficiency`, `cloudEssdPl2`, `cloudEssdPl3`.

func (GetDbClustersClusterOutput) SupportBackup

func (o GetDbClustersClusterOutput) SupportBackup() pulumi.IntOutput

Support fallback scheme.

func (GetDbClustersClusterOutput) SupportHttpsPort

func (o GetDbClustersClusterOutput) SupportHttpsPort() pulumi.BoolOutput

The system supports http port number.

func (GetDbClustersClusterOutput) SupportMysqlPort

func (o GetDbClustersClusterOutput) SupportMysqlPort() pulumi.BoolOutput

Supports Mysql, and those of the ports.

func (GetDbClustersClusterOutput) ToGetDbClustersClusterOutput

func (o GetDbClustersClusterOutput) ToGetDbClustersClusterOutput() GetDbClustersClusterOutput

func (GetDbClustersClusterOutput) ToGetDbClustersClusterOutputWithContext

func (o GetDbClustersClusterOutput) ToGetDbClustersClusterOutputWithContext(ctx context.Context) GetDbClustersClusterOutput

func (GetDbClustersClusterOutput) VpcCloudInstanceId

func (o GetDbClustersClusterOutput) VpcCloudInstanceId() pulumi.StringOutput

Virtual Private Cloud (VPC cloud instance ID.

func (GetDbClustersClusterOutput) VpcId

The VPC ID of the DBCluster.

func (GetDbClustersClusterOutput) VswitchId

The vswitch id of the DBCluster.

func (GetDbClustersClusterOutput) ZoneId

The zone ID of the DBCluster.

type GetDbClustersClusterScaleOutStatus

type GetDbClustersClusterScaleOutStatus struct {
	Progress string `pulumi:"progress"`
	Ratio    string `pulumi:"ratio"`
}

type GetDbClustersClusterScaleOutStatusArgs

type GetDbClustersClusterScaleOutStatusArgs struct {
	Progress pulumi.StringInput `pulumi:"progress"`
	Ratio    pulumi.StringInput `pulumi:"ratio"`
}

func (GetDbClustersClusterScaleOutStatusArgs) ElementType

func (GetDbClustersClusterScaleOutStatusArgs) ToGetDbClustersClusterScaleOutStatusOutput

func (i GetDbClustersClusterScaleOutStatusArgs) ToGetDbClustersClusterScaleOutStatusOutput() GetDbClustersClusterScaleOutStatusOutput

func (GetDbClustersClusterScaleOutStatusArgs) ToGetDbClustersClusterScaleOutStatusOutputWithContext

func (i GetDbClustersClusterScaleOutStatusArgs) ToGetDbClustersClusterScaleOutStatusOutputWithContext(ctx context.Context) GetDbClustersClusterScaleOutStatusOutput

type GetDbClustersClusterScaleOutStatusArray

type GetDbClustersClusterScaleOutStatusArray []GetDbClustersClusterScaleOutStatusInput

func (GetDbClustersClusterScaleOutStatusArray) ElementType

func (GetDbClustersClusterScaleOutStatusArray) ToGetDbClustersClusterScaleOutStatusArrayOutput

func (i GetDbClustersClusterScaleOutStatusArray) ToGetDbClustersClusterScaleOutStatusArrayOutput() GetDbClustersClusterScaleOutStatusArrayOutput

func (GetDbClustersClusterScaleOutStatusArray) ToGetDbClustersClusterScaleOutStatusArrayOutputWithContext

func (i GetDbClustersClusterScaleOutStatusArray) ToGetDbClustersClusterScaleOutStatusArrayOutputWithContext(ctx context.Context) GetDbClustersClusterScaleOutStatusArrayOutput

type GetDbClustersClusterScaleOutStatusArrayInput

type GetDbClustersClusterScaleOutStatusArrayInput interface {
	pulumi.Input

	ToGetDbClustersClusterScaleOutStatusArrayOutput() GetDbClustersClusterScaleOutStatusArrayOutput
	ToGetDbClustersClusterScaleOutStatusArrayOutputWithContext(context.Context) GetDbClustersClusterScaleOutStatusArrayOutput
}

GetDbClustersClusterScaleOutStatusArrayInput is an input type that accepts GetDbClustersClusterScaleOutStatusArray and GetDbClustersClusterScaleOutStatusArrayOutput values. You can construct a concrete instance of `GetDbClustersClusterScaleOutStatusArrayInput` via:

GetDbClustersClusterScaleOutStatusArray{ GetDbClustersClusterScaleOutStatusArgs{...} }

type GetDbClustersClusterScaleOutStatusArrayOutput

type GetDbClustersClusterScaleOutStatusArrayOutput struct{ *pulumi.OutputState }

func (GetDbClustersClusterScaleOutStatusArrayOutput) ElementType

func (GetDbClustersClusterScaleOutStatusArrayOutput) Index

func (GetDbClustersClusterScaleOutStatusArrayOutput) ToGetDbClustersClusterScaleOutStatusArrayOutput

func (o GetDbClustersClusterScaleOutStatusArrayOutput) ToGetDbClustersClusterScaleOutStatusArrayOutput() GetDbClustersClusterScaleOutStatusArrayOutput

func (GetDbClustersClusterScaleOutStatusArrayOutput) ToGetDbClustersClusterScaleOutStatusArrayOutputWithContext

func (o GetDbClustersClusterScaleOutStatusArrayOutput) ToGetDbClustersClusterScaleOutStatusArrayOutputWithContext(ctx context.Context) GetDbClustersClusterScaleOutStatusArrayOutput

type GetDbClustersClusterScaleOutStatusInput

type GetDbClustersClusterScaleOutStatusInput interface {
	pulumi.Input

	ToGetDbClustersClusterScaleOutStatusOutput() GetDbClustersClusterScaleOutStatusOutput
	ToGetDbClustersClusterScaleOutStatusOutputWithContext(context.Context) GetDbClustersClusterScaleOutStatusOutput
}

GetDbClustersClusterScaleOutStatusInput is an input type that accepts GetDbClustersClusterScaleOutStatusArgs and GetDbClustersClusterScaleOutStatusOutput values. You can construct a concrete instance of `GetDbClustersClusterScaleOutStatusInput` via:

GetDbClustersClusterScaleOutStatusArgs{...}

type GetDbClustersClusterScaleOutStatusOutput

type GetDbClustersClusterScaleOutStatusOutput struct{ *pulumi.OutputState }

func (GetDbClustersClusterScaleOutStatusOutput) ElementType

func (GetDbClustersClusterScaleOutStatusOutput) Progress

func (GetDbClustersClusterScaleOutStatusOutput) Ratio

func (GetDbClustersClusterScaleOutStatusOutput) ToGetDbClustersClusterScaleOutStatusOutput

func (o GetDbClustersClusterScaleOutStatusOutput) ToGetDbClustersClusterScaleOutStatusOutput() GetDbClustersClusterScaleOutStatusOutput

func (GetDbClustersClusterScaleOutStatusOutput) ToGetDbClustersClusterScaleOutStatusOutputWithContext

func (o GetDbClustersClusterScaleOutStatusOutput) ToGetDbClustersClusterScaleOutStatusOutputWithContext(ctx context.Context) GetDbClustersClusterScaleOutStatusOutput

type GetDbClustersOutputArgs added in v3.9.0

type GetDbClustersOutputArgs struct {
	// The DBCluster description.
	DbClusterDescription pulumi.StringPtrInput `pulumi:"dbClusterDescription"`
	// Default to `false`. Set it to `true` can output more details about resource attributes.
	EnableDetails pulumi.BoolPtrInput `pulumi:"enableDetails"`
	// A list of DBCluster IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// The status of the resource. Valid values: `Running`,`Creating`,`Deleting`,`Restarting`,`Preparing`,.
	Status pulumi.StringPtrInput `pulumi:"status"`
}

A collection of arguments for invoking getDbClusters.

func (GetDbClustersOutputArgs) ElementType added in v3.9.0

func (GetDbClustersOutputArgs) ElementType() reflect.Type

type GetDbClustersResult

type GetDbClustersResult struct {
	Clusters             []GetDbClustersCluster `pulumi:"clusters"`
	DbClusterDescription *string                `pulumi:"dbClusterDescription"`
	EnableDetails        *bool                  `pulumi:"enableDetails"`
	// The provider-assigned unique ID for this managed resource.
	Id         string   `pulumi:"id"`
	Ids        []string `pulumi:"ids"`
	OutputFile *string  `pulumi:"outputFile"`
	Status     *string  `pulumi:"status"`
}

A collection of values returned by getDbClusters.

func GetDbClusters

func GetDbClusters(ctx *pulumi.Context, args *GetDbClustersArgs, opts ...pulumi.InvokeOption) (*GetDbClustersResult, error)

This data source provides the Click House DBCluster of the current Alibaba Cloud user.

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

## Example Usage

Basic Usage

```go package main

import (

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

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { defaultDbCluster, err := clickhouse.NewDbCluster(ctx, "default", &clickhouse.DbClusterArgs{ DbClusterVersion: pulumi.String("20.3.10.75"), Category: pulumi.String("Basic"), DbClusterClass: pulumi.String("S8"), DbClusterNetworkType: pulumi.String("vpc"), DbNodeGroupCount: pulumi.Int(1), PaymentType: pulumi.String("PayAsYouGo"), DbNodeStorage: pulumi.String("500"), StorageType: pulumi.String("cloud_essd"), VswitchId: pulumi.String("your_vswitch_id"), }) if err != nil { return err } _default := clickhouse.GetDbClustersOutput(ctx, clickhouse.GetDbClustersOutputArgs{ Ids: pulumi.StringArray{ defaultDbCluster.ID(), }, }, nil); ctx.Export("dbCluster", _default.ApplyT(func(_default clickhouse.GetDbClustersResult) (*string, error) { return &default.Ids[0], nil }).(pulumi.StringPtrOutput)) return nil }) } ```

type GetDbClustersResultOutput added in v3.9.0

type GetDbClustersResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDbClusters.

func GetDbClustersOutput added in v3.9.0

func GetDbClustersOutput(ctx *pulumi.Context, args GetDbClustersOutputArgs, opts ...pulumi.InvokeOption) GetDbClustersResultOutput

func (GetDbClustersResultOutput) Clusters added in v3.9.0

func (GetDbClustersResultOutput) DbClusterDescription added in v3.9.0

func (o GetDbClustersResultOutput) DbClusterDescription() pulumi.StringPtrOutput

func (GetDbClustersResultOutput) ElementType added in v3.9.0

func (GetDbClustersResultOutput) ElementType() reflect.Type

func (GetDbClustersResultOutput) EnableDetails added in v3.9.0

func (GetDbClustersResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetDbClustersResultOutput) Ids added in v3.9.0

func (GetDbClustersResultOutput) OutputFile added in v3.9.0

func (GetDbClustersResultOutput) Status added in v3.9.0

func (GetDbClustersResultOutput) ToGetDbClustersResultOutput added in v3.9.0

func (o GetDbClustersResultOutput) ToGetDbClustersResultOutput() GetDbClustersResultOutput

func (GetDbClustersResultOutput) ToGetDbClustersResultOutputWithContext added in v3.9.0

func (o GetDbClustersResultOutput) ToGetDbClustersResultOutputWithContext(ctx context.Context) GetDbClustersResultOutput

type GetRegionsArgs

type GetRegionsArgs struct {
	// Set to true to match only the region configured in the provider. Default value: `true`.
	Current *bool `pulumi:"current"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// You can use specified regionId to find the region and available zones information that supports ClickHouse.
	RegionId *string `pulumi:"regionId"`
}

A collection of arguments for invoking getRegions.

type GetRegionsOutputArgs added in v3.9.0

type GetRegionsOutputArgs struct {
	// Set to true to match only the region configured in the provider. Default value: `true`.
	Current pulumi.BoolPtrInput `pulumi:"current"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// You can use specified regionId to find the region and available zones information that supports ClickHouse.
	RegionId pulumi.StringPtrInput `pulumi:"regionId"`
}

A collection of arguments for invoking getRegions.

func (GetRegionsOutputArgs) ElementType added in v3.9.0

func (GetRegionsOutputArgs) ElementType() reflect.Type

type GetRegionsRegion

type GetRegionsRegion struct {
	// The Region ID.
	RegionId string `pulumi:"regionId"`
	// A list of available zone ids in the region_id.
	ZoneIds []GetRegionsRegionZoneId `pulumi:"zoneIds"`
}

type GetRegionsRegionArgs

type GetRegionsRegionArgs struct {
	// The Region ID.
	RegionId pulumi.StringInput `pulumi:"regionId"`
	// A list of available zone ids in the region_id.
	ZoneIds GetRegionsRegionZoneIdArrayInput `pulumi:"zoneIds"`
}

func (GetRegionsRegionArgs) ElementType

func (GetRegionsRegionArgs) ElementType() reflect.Type

func (GetRegionsRegionArgs) ToGetRegionsRegionOutput

func (i GetRegionsRegionArgs) ToGetRegionsRegionOutput() GetRegionsRegionOutput

func (GetRegionsRegionArgs) ToGetRegionsRegionOutputWithContext

func (i GetRegionsRegionArgs) ToGetRegionsRegionOutputWithContext(ctx context.Context) GetRegionsRegionOutput

type GetRegionsRegionArray

type GetRegionsRegionArray []GetRegionsRegionInput

func (GetRegionsRegionArray) ElementType

func (GetRegionsRegionArray) ElementType() reflect.Type

func (GetRegionsRegionArray) ToGetRegionsRegionArrayOutput

func (i GetRegionsRegionArray) ToGetRegionsRegionArrayOutput() GetRegionsRegionArrayOutput

func (GetRegionsRegionArray) ToGetRegionsRegionArrayOutputWithContext

func (i GetRegionsRegionArray) ToGetRegionsRegionArrayOutputWithContext(ctx context.Context) GetRegionsRegionArrayOutput

type GetRegionsRegionArrayInput

type GetRegionsRegionArrayInput interface {
	pulumi.Input

	ToGetRegionsRegionArrayOutput() GetRegionsRegionArrayOutput
	ToGetRegionsRegionArrayOutputWithContext(context.Context) GetRegionsRegionArrayOutput
}

GetRegionsRegionArrayInput is an input type that accepts GetRegionsRegionArray and GetRegionsRegionArrayOutput values. You can construct a concrete instance of `GetRegionsRegionArrayInput` via:

GetRegionsRegionArray{ GetRegionsRegionArgs{...} }

type GetRegionsRegionArrayOutput

type GetRegionsRegionArrayOutput struct{ *pulumi.OutputState }

func (GetRegionsRegionArrayOutput) ElementType

func (GetRegionsRegionArrayOutput) Index

func (GetRegionsRegionArrayOutput) ToGetRegionsRegionArrayOutput

func (o GetRegionsRegionArrayOutput) ToGetRegionsRegionArrayOutput() GetRegionsRegionArrayOutput

func (GetRegionsRegionArrayOutput) ToGetRegionsRegionArrayOutputWithContext

func (o GetRegionsRegionArrayOutput) ToGetRegionsRegionArrayOutputWithContext(ctx context.Context) GetRegionsRegionArrayOutput

type GetRegionsRegionInput

type GetRegionsRegionInput interface {
	pulumi.Input

	ToGetRegionsRegionOutput() GetRegionsRegionOutput
	ToGetRegionsRegionOutputWithContext(context.Context) GetRegionsRegionOutput
}

GetRegionsRegionInput is an input type that accepts GetRegionsRegionArgs and GetRegionsRegionOutput values. You can construct a concrete instance of `GetRegionsRegionInput` via:

GetRegionsRegionArgs{...}

type GetRegionsRegionOutput

type GetRegionsRegionOutput struct{ *pulumi.OutputState }

func (GetRegionsRegionOutput) ElementType

func (GetRegionsRegionOutput) ElementType() reflect.Type

func (GetRegionsRegionOutput) RegionId

The Region ID.

func (GetRegionsRegionOutput) ToGetRegionsRegionOutput

func (o GetRegionsRegionOutput) ToGetRegionsRegionOutput() GetRegionsRegionOutput

func (GetRegionsRegionOutput) ToGetRegionsRegionOutputWithContext

func (o GetRegionsRegionOutput) ToGetRegionsRegionOutputWithContext(ctx context.Context) GetRegionsRegionOutput

func (GetRegionsRegionOutput) ZoneIds

A list of available zone ids in the region_id.

type GetRegionsRegionZoneId

type GetRegionsRegionZoneId struct {
	VpcEnabled bool   `pulumi:"vpcEnabled"`
	ZoneId     string `pulumi:"zoneId"`
}

type GetRegionsRegionZoneIdArgs

type GetRegionsRegionZoneIdArgs struct {
	VpcEnabled pulumi.BoolInput   `pulumi:"vpcEnabled"`
	ZoneId     pulumi.StringInput `pulumi:"zoneId"`
}

func (GetRegionsRegionZoneIdArgs) ElementType

func (GetRegionsRegionZoneIdArgs) ElementType() reflect.Type

func (GetRegionsRegionZoneIdArgs) ToGetRegionsRegionZoneIdOutput

func (i GetRegionsRegionZoneIdArgs) ToGetRegionsRegionZoneIdOutput() GetRegionsRegionZoneIdOutput

func (GetRegionsRegionZoneIdArgs) ToGetRegionsRegionZoneIdOutputWithContext

func (i GetRegionsRegionZoneIdArgs) ToGetRegionsRegionZoneIdOutputWithContext(ctx context.Context) GetRegionsRegionZoneIdOutput

type GetRegionsRegionZoneIdArray

type GetRegionsRegionZoneIdArray []GetRegionsRegionZoneIdInput

func (GetRegionsRegionZoneIdArray) ElementType

func (GetRegionsRegionZoneIdArray) ToGetRegionsRegionZoneIdArrayOutput

func (i GetRegionsRegionZoneIdArray) ToGetRegionsRegionZoneIdArrayOutput() GetRegionsRegionZoneIdArrayOutput

func (GetRegionsRegionZoneIdArray) ToGetRegionsRegionZoneIdArrayOutputWithContext

func (i GetRegionsRegionZoneIdArray) ToGetRegionsRegionZoneIdArrayOutputWithContext(ctx context.Context) GetRegionsRegionZoneIdArrayOutput

type GetRegionsRegionZoneIdArrayInput

type GetRegionsRegionZoneIdArrayInput interface {
	pulumi.Input

	ToGetRegionsRegionZoneIdArrayOutput() GetRegionsRegionZoneIdArrayOutput
	ToGetRegionsRegionZoneIdArrayOutputWithContext(context.Context) GetRegionsRegionZoneIdArrayOutput
}

GetRegionsRegionZoneIdArrayInput is an input type that accepts GetRegionsRegionZoneIdArray and GetRegionsRegionZoneIdArrayOutput values. You can construct a concrete instance of `GetRegionsRegionZoneIdArrayInput` via:

GetRegionsRegionZoneIdArray{ GetRegionsRegionZoneIdArgs{...} }

type GetRegionsRegionZoneIdArrayOutput

type GetRegionsRegionZoneIdArrayOutput struct{ *pulumi.OutputState }

func (GetRegionsRegionZoneIdArrayOutput) ElementType

func (GetRegionsRegionZoneIdArrayOutput) Index

func (GetRegionsRegionZoneIdArrayOutput) ToGetRegionsRegionZoneIdArrayOutput

func (o GetRegionsRegionZoneIdArrayOutput) ToGetRegionsRegionZoneIdArrayOutput() GetRegionsRegionZoneIdArrayOutput

func (GetRegionsRegionZoneIdArrayOutput) ToGetRegionsRegionZoneIdArrayOutputWithContext

func (o GetRegionsRegionZoneIdArrayOutput) ToGetRegionsRegionZoneIdArrayOutputWithContext(ctx context.Context) GetRegionsRegionZoneIdArrayOutput

type GetRegionsRegionZoneIdInput

type GetRegionsRegionZoneIdInput interface {
	pulumi.Input

	ToGetRegionsRegionZoneIdOutput() GetRegionsRegionZoneIdOutput
	ToGetRegionsRegionZoneIdOutputWithContext(context.Context) GetRegionsRegionZoneIdOutput
}

GetRegionsRegionZoneIdInput is an input type that accepts GetRegionsRegionZoneIdArgs and GetRegionsRegionZoneIdOutput values. You can construct a concrete instance of `GetRegionsRegionZoneIdInput` via:

GetRegionsRegionZoneIdArgs{...}

type GetRegionsRegionZoneIdOutput

type GetRegionsRegionZoneIdOutput struct{ *pulumi.OutputState }

func (GetRegionsRegionZoneIdOutput) ElementType

func (GetRegionsRegionZoneIdOutput) ToGetRegionsRegionZoneIdOutput

func (o GetRegionsRegionZoneIdOutput) ToGetRegionsRegionZoneIdOutput() GetRegionsRegionZoneIdOutput

func (GetRegionsRegionZoneIdOutput) ToGetRegionsRegionZoneIdOutputWithContext

func (o GetRegionsRegionZoneIdOutput) ToGetRegionsRegionZoneIdOutputWithContext(ctx context.Context) GetRegionsRegionZoneIdOutput

func (GetRegionsRegionZoneIdOutput) VpcEnabled

func (GetRegionsRegionZoneIdOutput) ZoneId

type GetRegionsResult

type GetRegionsResult struct {
	Current *bool `pulumi:"current"`
	// The provider-assigned unique ID for this managed resource.
	Id         string             `pulumi:"id"`
	OutputFile *string            `pulumi:"outputFile"`
	RegionId   *string            `pulumi:"regionId"`
	Regions    []GetRegionsRegion `pulumi:"regions"`
}

A collection of values returned by getRegions.

func GetRegions

func GetRegions(ctx *pulumi.Context, args *GetRegionsArgs, opts ...pulumi.InvokeOption) (*GetRegionsResult, error)

This data source provides the Click House Accounts of the current Alibaba Cloud user.

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

## Example Usage

Basic Usage

```go package main

import (

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

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = clickhouse.GetRegions(ctx, &clickhouse.GetRegionsArgs{
			RegionId: pulumi.StringRef("cn-hangzhou"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetRegionsResultOutput added in v3.9.0

type GetRegionsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getRegions.

func GetRegionsOutput added in v3.9.0

func GetRegionsOutput(ctx *pulumi.Context, args GetRegionsOutputArgs, opts ...pulumi.InvokeOption) GetRegionsResultOutput

func (GetRegionsResultOutput) Current added in v3.9.0

func (GetRegionsResultOutput) ElementType added in v3.9.0

func (GetRegionsResultOutput) ElementType() reflect.Type

func (GetRegionsResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetRegionsResultOutput) OutputFile added in v3.9.0

func (GetRegionsResultOutput) RegionId added in v3.9.0

func (GetRegionsResultOutput) Regions added in v3.9.0

func (GetRegionsResultOutput) ToGetRegionsResultOutput added in v3.9.0

func (o GetRegionsResultOutput) ToGetRegionsResultOutput() GetRegionsResultOutput

func (GetRegionsResultOutput) ToGetRegionsResultOutputWithContext added in v3.9.0

func (o GetRegionsResultOutput) ToGetRegionsResultOutputWithContext(ctx context.Context) GetRegionsResultOutput

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL