ocean

package
v3.55.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BaseInstance 

type BaseInstance struct {
	pulumi.CustomResourceState

	// Whether to automatically renew.
	// It takes effect when the parameter ChargeType is PrePaid. Value range:
	// - true: automatic renewal.
	// - false (default): no automatic renewal.
	AutoRenew pulumi.BoolPtrOutput `pulumi:"autoRenew"`
	// The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.
	// - PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
	// - PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.
	AutoRenewPeriod pulumi.IntPtrOutput `pulumi:"autoRenewPeriod"`
	// The backup retention policy after the cluster is deleted. The values are as follows:
	// - receive_all: Keep all backup sets;
	// - delete_all: delete all backup sets;
	// - receive_last: Keep the last backup set.
	// > **NOTE:**   The default value is delete_all.
	BackupRetainMode pulumi.StringPtrOutput `pulumi:"backupRetainMode"`
	// The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.
	CommodityCode pulumi.StringOutput `pulumi:"commodityCode"`
	// The number of CPU cores of the cluster.
	Cpu pulumi.IntOutput `pulumi:"cpu"`
	// The creation time of the resource.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// The size of the storage space, in GB.
	// The limits of storage space vary according to the cluster specifications, as follows:
	// - 8C32GB:100GB ~ 10000GB
	// - 14C70GB:200GB ~ 10000GB
	// - 30C180GB:400GB ~ 10000GB
	// - 62C400G:800GB ~ 10000GB.
	//   The default value of each package is its minimum value.
	DiskSize pulumi.IntOutput `pulumi:"diskSize"`
	// The storage type of the cluster. Effective only in the standard cluster version (cloud disk).
	// Two types are currently supported:
	// - cloud_essd_pl1: cloud disk ESSD pl1.
	// - cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.
	DiskType pulumi.StringOutput `pulumi:"diskType"`
	// Cluster specification information.
	// Four packages are currently supported:
	// - 4C16GB：4cores 16GB
	// - 8C32GB：8cores 32GB
	// - 14C70GB：14cores 70GB
	// - 24C120GB：24cores 120GB
	// - 30C180GB：30cores 180GB
	// - 62C400GB：62cores 400GB
	// - 104C600GB：104cores 600GB
	// - 16C70GB：16cores 70GB
	// - 32C160GB：32cores 160GB
	// - 64C380GB：64cores 380GB
	// - 20C32GB：20cores 32GB
	// - 40C64GB：40cores 64GB
	// - 16C32GB：16cores 32GB
	// - 32C70GB：32cores 70GB
	// - 64C180GB：64cores 180GB
	// - 32C180GB：32cores 180GB
	// - 64C400GB：64cores 400GB.
	InstanceClass pulumi.StringOutput `pulumi:"instanceClass"`
	// OceanBase cluster name.The length is 1 to 20 English or Chinese characters.If this parameter is not specified, the default value is the InstanceId of the cluster.
	InstanceName pulumi.StringOutput `pulumi:"instanceName"`
	// The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
	NodeNum pulumi.StringOutput `pulumi:"nodeNum"`
	// The OceanBase Server version number.
	ObVersion pulumi.StringOutput `pulumi:"obVersion"`
	// The payment method of the instance. Value range:
	// - Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
	// - PayAsYouGo (default): Pay-as-you-go (default hourly billing).
	PaymentType pulumi.StringOutput `pulumi:"paymentType"`
	// The duration of the resource purchase. The unit is specified by the PeriodUnit. The parameter InstanceChargeType takes effect only when the value is PrePaid and is required. Once the DedicatedHostId is specified, the value cannot exceed the subscription duration of the dedicated host. When PeriodUnit = Week, Period values: {"1", "2", "3", "4"}. When PeriodUnit = Month, Period values: {"1", "2", "3", "4", "5", "6", "7", "8", "9", "12", "24", "36", "48", "60"}.
	Period pulumi.IntPtrOutput `pulumi:"period"`
	// The duration of the purchase of resources.Package year and Month value range: Month.Default value: Month of the package, which is billed by volume. The default period is Hour.
	PeriodUnit pulumi.StringPtrOutput `pulumi:"periodUnit"`
	// The ID of the enterprise resource group to which the instance resides.
	ResourceGroupId pulumi.StringOutput `pulumi:"resourceGroupId"`
	// Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
	Series pulumi.StringOutput `pulumi:"series"`
	// The status of the resource.
	Status pulumi.StringOutput `pulumi:"status"`
	// Information about the zone where the cluster is deployed.
	Zones pulumi.StringArrayOutput `pulumi:"zones"`
}

Provides a Ocean Base Instance resource.

For information about Ocean Base Instance and how to use it, see [What is Instance](https://www.alibabacloud.com/help/en/apsaradb-for-oceanbase/latest/what-is-oceanbase-database).

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

## Example Usage

Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ocean"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
"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 := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := alicloud.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		defaultGetResourceGroups, err := resourcemanager.GetResourceGroups(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = ocean.NewBaseInstance(ctx, "default", &ocean.BaseInstanceArgs{
			ResourceGroupId: pulumi.String(defaultGetResourceGroups.Ids[0]),
			Zones: pulumi.StringArray{
				_default.Ids[len(_default.Ids)-2],
				_default.Ids[len(_default.Ids)-3],
				_default.Ids[len(_default.Ids)-4],
			},
			AutoRenew:        pulumi.Bool(false),
			DiskSize:         pulumi.Int(100),
			PaymentType:      pulumi.String("PayAsYouGo"),
			InstanceClass:    pulumi.String("8C32GB"),
			BackupRetainMode: pulumi.String("delete_all"),
			Series:           pulumi.String("normal"),
			InstanceName:     pulumi.String(name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Ocean Base Instance can be imported using the id, e.g.

```sh $ pulumi import alicloud:ocean/baseInstance:BaseInstance example <id> ```

func GetBaseInstance 

func GetBaseInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BaseInstanceState, opts ...pulumi.ResourceOption) (*BaseInstance, error)

GetBaseInstance gets an existing BaseInstance 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 NewBaseInstance 

func NewBaseInstance(ctx *pulumi.Context,
	name string, args *BaseInstanceArgs, opts ...pulumi.ResourceOption) (*BaseInstance, error)

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

func (*BaseInstance) ElementType 

func (*BaseInstance) ElementType() reflect.Type

func (*BaseInstance) ToBaseInstanceOutput 

func (i *BaseInstance) ToBaseInstanceOutput() BaseInstanceOutput

func (*BaseInstance) ToBaseInstanceOutputWithContext 

func (i *BaseInstance) ToBaseInstanceOutputWithContext(ctx context.Context) BaseInstanceOutput

type BaseInstanceArgs 

type BaseInstanceArgs struct {
	// Whether to automatically renew.
	// It takes effect when the parameter ChargeType is PrePaid. Value range:
	// - true: automatic renewal.
	// - false (default): no automatic renewal.
	AutoRenew pulumi.BoolPtrInput
	// The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.
	// - PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
	// - PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.
	AutoRenewPeriod pulumi.IntPtrInput
	// The backup retention policy after the cluster is deleted. The values are as follows:
	// - receive_all: Keep all backup sets;
	// - delete_all: delete all backup sets;
	// - receive_last: Keep the last backup set.
	// > **NOTE:**   The default value is delete_all.
	BackupRetainMode pulumi.StringPtrInput
	// The size of the storage space, in GB.
	// The limits of storage space vary according to the cluster specifications, as follows:
	// - 8C32GB:100GB ~ 10000GB
	// - 14C70GB:200GB ~ 10000GB
	// - 30C180GB:400GB ~ 10000GB
	// - 62C400G:800GB ~ 10000GB.
	//   The default value of each package is its minimum value.
	DiskSize pulumi.IntInput
	// The storage type of the cluster. Effective only in the standard cluster version (cloud disk).
	// Two types are currently supported:
	// - cloud_essd_pl1: cloud disk ESSD pl1.
	// - cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.
	DiskType pulumi.StringPtrInput
	// Cluster specification information.
	// Four packages are currently supported:
	// - 4C16GB：4cores 16GB
	// - 8C32GB：8cores 32GB
	// - 14C70GB：14cores 70GB
	// - 24C120GB：24cores 120GB
	// - 30C180GB：30cores 180GB
	// - 62C400GB：62cores 400GB
	// - 104C600GB：104cores 600GB
	// - 16C70GB：16cores 70GB
	// - 32C160GB：32cores 160GB
	// - 64C380GB：64cores 380GB
	// - 20C32GB：20cores 32GB
	// - 40C64GB：40cores 64GB
	// - 16C32GB：16cores 32GB
	// - 32C70GB：32cores 70GB
	// - 64C180GB：64cores 180GB
	// - 32C180GB：32cores 180GB
	// - 64C400GB：64cores 400GB.
	InstanceClass pulumi.StringInput
	// OceanBase cluster name.The length is 1 to 20 English or Chinese characters.If this parameter is not specified, the default value is the InstanceId of the cluster.
	InstanceName pulumi.StringPtrInput
	// The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
	NodeNum pulumi.StringPtrInput
	// The OceanBase Server version number.
	ObVersion pulumi.StringPtrInput
	// The payment method of the instance. Value range:
	// - Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
	// - PayAsYouGo (default): Pay-as-you-go (default hourly billing).
	PaymentType pulumi.StringInput
	// The duration of the resource purchase. The unit is specified by the PeriodUnit. The parameter InstanceChargeType takes effect only when the value is PrePaid and is required. Once the DedicatedHostId is specified, the value cannot exceed the subscription duration of the dedicated host. When PeriodUnit = Week, Period values: {"1", "2", "3", "4"}. When PeriodUnit = Month, Period values: {"1", "2", "3", "4", "5", "6", "7", "8", "9", "12", "24", "36", "48", "60"}.
	Period pulumi.IntPtrInput
	// The duration of the purchase of resources.Package year and Month value range: Month.Default value: Month of the package, which is billed by volume. The default period is Hour.
	PeriodUnit pulumi.StringPtrInput
	// The ID of the enterprise resource group to which the instance resides.
	ResourceGroupId pulumi.StringPtrInput
	// Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
	Series pulumi.StringInput
	// Information about the zone where the cluster is deployed.
	Zones pulumi.StringArrayInput
}

The set of arguments for constructing a BaseInstance resource.

func (BaseInstanceArgs) ElementType 

func (BaseInstanceArgs) ElementType() reflect.Type

type BaseInstanceArray 

type BaseInstanceArray []BaseInstanceInput

func (BaseInstanceArray) ElementType 

func (BaseInstanceArray) ElementType() reflect.Type

func (BaseInstanceArray) ToBaseInstanceArrayOutput 

func (i BaseInstanceArray) ToBaseInstanceArrayOutput() BaseInstanceArrayOutput

func (BaseInstanceArray) ToBaseInstanceArrayOutputWithContext 

func (i BaseInstanceArray) ToBaseInstanceArrayOutputWithContext(ctx context.Context) BaseInstanceArrayOutput

type BaseInstanceArrayInput 

type BaseInstanceArrayInput interface {
	pulumi.Input

	ToBaseInstanceArrayOutput() BaseInstanceArrayOutput
	ToBaseInstanceArrayOutputWithContext(context.Context) BaseInstanceArrayOutput
}

BaseInstanceArrayInput is an input type that accepts BaseInstanceArray and BaseInstanceArrayOutput values. You can construct a concrete instance of `BaseInstanceArrayInput` via: 

BaseInstanceArray{ BaseInstanceArgs{...} }

type BaseInstanceArrayOutput 

type BaseInstanceArrayOutput struct{ *pulumi.OutputState }

func (BaseInstanceArrayOutput) ElementType 

func (BaseInstanceArrayOutput) ElementType() reflect.Type

func (BaseInstanceArrayOutput) Index 

func (o BaseInstanceArrayOutput) Index(i pulumi.IntInput) BaseInstanceOutput

func (BaseInstanceArrayOutput) ToBaseInstanceArrayOutput 

func (o BaseInstanceArrayOutput) ToBaseInstanceArrayOutput() BaseInstanceArrayOutput

func (BaseInstanceArrayOutput) ToBaseInstanceArrayOutputWithContext 

func (o BaseInstanceArrayOutput) ToBaseInstanceArrayOutputWithContext(ctx context.Context) BaseInstanceArrayOutput

type BaseInstanceInput 

type BaseInstanceInput interface {
	pulumi.Input

	ToBaseInstanceOutput() BaseInstanceOutput
	ToBaseInstanceOutputWithContext(ctx context.Context) BaseInstanceOutput
}

type BaseInstanceMap 

type BaseInstanceMap map[string]BaseInstanceInput

func (BaseInstanceMap) ElementType 

func (BaseInstanceMap) ElementType() reflect.Type

func (BaseInstanceMap) ToBaseInstanceMapOutput 

func (i BaseInstanceMap) ToBaseInstanceMapOutput() BaseInstanceMapOutput

func (BaseInstanceMap) ToBaseInstanceMapOutputWithContext 

func (i BaseInstanceMap) ToBaseInstanceMapOutputWithContext(ctx context.Context) BaseInstanceMapOutput

type BaseInstanceMapInput 

type BaseInstanceMapInput interface {
	pulumi.Input

	ToBaseInstanceMapOutput() BaseInstanceMapOutput
	ToBaseInstanceMapOutputWithContext(context.Context) BaseInstanceMapOutput
}

BaseInstanceMapInput is an input type that accepts BaseInstanceMap and BaseInstanceMapOutput values. You can construct a concrete instance of `BaseInstanceMapInput` via: 

BaseInstanceMap{ "key": BaseInstanceArgs{...} }

type BaseInstanceMapOutput 

type BaseInstanceMapOutput struct{ *pulumi.OutputState }

func (BaseInstanceMapOutput) ElementType 

func (BaseInstanceMapOutput) ElementType() reflect.Type

func (BaseInstanceMapOutput) MapIndex 

func (o BaseInstanceMapOutput) MapIndex(k pulumi.StringInput) BaseInstanceOutput

func (BaseInstanceMapOutput) ToBaseInstanceMapOutput 

func (o BaseInstanceMapOutput) ToBaseInstanceMapOutput() BaseInstanceMapOutput

func (BaseInstanceMapOutput) ToBaseInstanceMapOutputWithContext 

func (o BaseInstanceMapOutput) ToBaseInstanceMapOutputWithContext(ctx context.Context) BaseInstanceMapOutput

type BaseInstanceOutput 

type BaseInstanceOutput struct{ *pulumi.OutputState }

func (BaseInstanceOutput) AutoRenew 

func (o BaseInstanceOutput) AutoRenew() pulumi.BoolPtrOutput

Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range: - true: automatic renewal. - false (default): no automatic renewal.

func (BaseInstanceOutput) AutoRenewPeriod 

func (o BaseInstanceOutput) AutoRenewPeriod() pulumi.IntPtrOutput

The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required. - PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}. - PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.

func (BaseInstanceOutput) BackupRetainMode 

func (o BaseInstanceOutput) BackupRetainMode() pulumi.StringPtrOutput

The backup retention policy after the cluster is deleted. The values are as follows: - receive_all: Keep all backup sets; - delete_all: delete all backup sets; - receive_last: Keep the last backup set. > **NOTE:** The default value is delete_all.

func (BaseInstanceOutput) CommodityCode 

func (o BaseInstanceOutput) CommodityCode() pulumi.StringOutput

The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.

func (BaseInstanceOutput) Cpu 

func (o BaseInstanceOutput) Cpu() pulumi.IntOutput

The number of CPU cores of the cluster.

func (BaseInstanceOutput) CreateTime 

func (o BaseInstanceOutput) CreateTime() pulumi.StringOutput

The creation time of the resource.

func (BaseInstanceOutput) DiskSize 

func (o BaseInstanceOutput) DiskSize() pulumi.IntOutput

The size of the storage space, in GB. The limits of storage space vary according to the cluster specifications, as follows:

  • 8C32GB:100GB ~ 10000GB
  • 14C70GB:200GB ~ 10000GB
  • 30C180GB:400GB ~ 10000GB
  • 62C400G:800GB ~ 10000GB. The default value of each package is its minimum value.

func (BaseInstanceOutput) DiskType added in v3.44.0 

func (o BaseInstanceOutput) DiskType() pulumi.StringOutput

The storage type of the cluster. Effective only in the standard cluster version (cloud disk). Two types are currently supported: - cloud_essd_pl1: cloud disk ESSD pl1. - cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.

func (BaseInstanceOutput) ElementType 

func (BaseInstanceOutput) ElementType() reflect.Type

func (BaseInstanceOutput) InstanceClass 

func (o BaseInstanceOutput) InstanceClass() pulumi.StringOutput

Cluster specification information. Four packages are currently supported: - 4C16GB：4cores 16GB - 8C32GB：8cores 32GB - 14C70GB：14cores 70GB - 24C120GB：24cores 120GB - 30C180GB：30cores 180GB - 62C400GB：62cores 400GB - 104C600GB：104cores 600GB - 16C70GB：16cores 70GB - 32C160GB：32cores 160GB - 64C380GB：64cores 380GB - 20C32GB：20cores 32GB - 40C64GB：40cores 64GB - 16C32GB：16cores 32GB - 32C70GB：32cores 70GB - 64C180GB：64cores 180GB - 32C180GB：32cores 180GB - 64C400GB：64cores 400GB.

func (BaseInstanceOutput) InstanceName 

func (o BaseInstanceOutput) InstanceName() pulumi.StringOutput

OceanBase cluster name.The length is 1 to 20 English or Chinese characters.If this parameter is not specified, the default value is the InstanceId of the cluster.

func (BaseInstanceOutput) NodeNum 

func (o BaseInstanceOutput) NodeNum() pulumi.StringOutput

The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.

func (BaseInstanceOutput) ObVersion added in v3.44.0 

func (o BaseInstanceOutput) ObVersion() pulumi.StringOutput

The OceanBase Server version number.

func (BaseInstanceOutput) PaymentType 

func (o BaseInstanceOutput) PaymentType() pulumi.StringOutput

The payment method of the instance. Value range: - Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned. - PayAsYouGo (default): Pay-as-you-go (default hourly billing).

func (BaseInstanceOutput) Period 

func (o BaseInstanceOutput) Period() pulumi.IntPtrOutput

The duration of the resource purchase. The unit is specified by the PeriodUnit. The parameter InstanceChargeType takes effect only when the value is PrePaid and is required. Once the DedicatedHostId is specified, the value cannot exceed the subscription duration of the dedicated host. When PeriodUnit = Week, Period values: {"1", "2", "3", "4"}. When PeriodUnit = Month, Period values: {"1", "2", "3", "4", "5", "6", "7", "8", "9", "12", "24", "36", "48", "60"}.

func (BaseInstanceOutput) PeriodUnit 

func (o BaseInstanceOutput) PeriodUnit() pulumi.StringPtrOutput

The duration of the purchase of resources.Package year and Month value range: Month.Default value: Month of the package, which is billed by volume. The default period is Hour.

func (BaseInstanceOutput) ResourceGroupId 

func (o BaseInstanceOutput) ResourceGroupId() pulumi.StringOutput

The ID of the enterprise resource group to which the instance resides.

func (BaseInstanceOutput) Series 

func (o BaseInstanceOutput) Series() pulumi.StringOutput

Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.

func (BaseInstanceOutput) Status 

func (o BaseInstanceOutput) Status() pulumi.StringOutput

The status of the resource.

func (BaseInstanceOutput) ToBaseInstanceOutput 

func (o BaseInstanceOutput) ToBaseInstanceOutput() BaseInstanceOutput

func (BaseInstanceOutput) ToBaseInstanceOutputWithContext 

func (o BaseInstanceOutput) ToBaseInstanceOutputWithContext(ctx context.Context) BaseInstanceOutput

func (BaseInstanceOutput) Zones 

func (o BaseInstanceOutput) Zones() pulumi.StringArrayOutput

Information about the zone where the cluster is deployed.

type BaseInstanceState 

type BaseInstanceState struct {
	// Whether to automatically renew.
	// It takes effect when the parameter ChargeType is PrePaid. Value range:
	// - true: automatic renewal.
	// - false (default): no automatic renewal.
	AutoRenew pulumi.BoolPtrInput
	// The duration of each auto-renewal. When the value of the AutoRenew parameter is True, this parameter is required.
	// - PeriodUnit is Week, AutoRenewPeriod is {"1", "2", "3"}.
	// - PeriodUnit is Month, AutoRenewPeriod is {"1", "2", "3", "6", "12"}.
	AutoRenewPeriod pulumi.IntPtrInput
	// The backup retention policy after the cluster is deleted. The values are as follows:
	// - receive_all: Keep all backup sets;
	// - delete_all: delete all backup sets;
	// - receive_last: Keep the last backup set.
	// > **NOTE:**   The default value is delete_all.
	BackupRetainMode pulumi.StringPtrInput
	// The product code of the OceanBase cluster._oceanbasepre_public_cn: Domestic station cloud database package Year-to-month package._oceanbasepost_public_cn: The domestic station cloud database is paid by the hour._obpre_public_intl: International Station Cloud Database Package Monthly Package.
	CommodityCode pulumi.StringPtrInput
	// The number of CPU cores of the cluster.
	Cpu pulumi.IntPtrInput
	// The creation time of the resource.
	CreateTime pulumi.StringPtrInput
	// The size of the storage space, in GB.
	// The limits of storage space vary according to the cluster specifications, as follows:
	// - 8C32GB:100GB ~ 10000GB
	// - 14C70GB:200GB ~ 10000GB
	// - 30C180GB:400GB ~ 10000GB
	// - 62C400G:800GB ~ 10000GB.
	//   The default value of each package is its minimum value.
	DiskSize pulumi.IntPtrInput
	// The storage type of the cluster. Effective only in the standard cluster version (cloud disk).
	// Two types are currently supported:
	// - cloud_essd_pl1: cloud disk ESSD pl1.
	// - cloud_essd_pl0: cloud disk ESSD pl0. The default value is cloud_essd_pl1.
	DiskType pulumi.StringPtrInput
	// Cluster specification information.
	// Four packages are currently supported:
	// - 4C16GB：4cores 16GB
	// - 8C32GB：8cores 32GB
	// - 14C70GB：14cores 70GB
	// - 24C120GB：24cores 120GB
	// - 30C180GB：30cores 180GB
	// - 62C400GB：62cores 400GB
	// - 104C600GB：104cores 600GB
	// - 16C70GB：16cores 70GB
	// - 32C160GB：32cores 160GB
	// - 64C380GB：64cores 380GB
	// - 20C32GB：20cores 32GB
	// - 40C64GB：40cores 64GB
	// - 16C32GB：16cores 32GB
	// - 32C70GB：32cores 70GB
	// - 64C180GB：64cores 180GB
	// - 32C180GB：32cores 180GB
	// - 64C400GB：64cores 400GB.
	InstanceClass pulumi.StringPtrInput
	// OceanBase cluster name.The length is 1 to 20 English or Chinese characters.If this parameter is not specified, the default value is the InstanceId of the cluster.
	InstanceName pulumi.StringPtrInput
	// The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
	NodeNum pulumi.StringPtrInput
	// The OceanBase Server version number.
	ObVersion pulumi.StringPtrInput
	// The payment method of the instance. Value range:
	// - Subscription: Package year and month. When you select this type of payment method, you must make sure that your account supports balance payment or credit payment. Otherwise, an InvalidPayMethod error message will be returned.
	// - PayAsYouGo (default): Pay-as-you-go (default hourly billing).
	PaymentType pulumi.StringPtrInput
	// The duration of the resource purchase. The unit is specified by the PeriodUnit. The parameter InstanceChargeType takes effect only when the value is PrePaid and is required. Once the DedicatedHostId is specified, the value cannot exceed the subscription duration of the dedicated host. When PeriodUnit = Week, Period values: {"1", "2", "3", "4"}. When PeriodUnit = Month, Period values: {"1", "2", "3", "4", "5", "6", "7", "8", "9", "12", "24", "36", "48", "60"}.
	Period pulumi.IntPtrInput
	// The duration of the purchase of resources.Package year and Month value range: Month.Default value: Month of the package, which is billed by volume. The default period is Hour.
	PeriodUnit pulumi.StringPtrInput
	// The ID of the enterprise resource group to which the instance resides.
	ResourceGroupId pulumi.StringPtrInput
	// Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
	Series pulumi.StringPtrInput
	// The status of the resource.
	Status pulumi.StringPtrInput
	// Information about the zone where the cluster is deployed.
	Zones pulumi.StringArrayInput
}

func (BaseInstanceState) ElementType 

func (BaseInstanceState) ElementType() reflect.Type

type GetBaseInstancesArgs 

type GetBaseInstancesArgs struct {
	EnableDetails *bool `pulumi:"enableDetails"`
	// A list of Instance IDs.
	Ids []string `pulumi:"ids"`
	// OceanBase cluster ID.
	InstanceId *string `pulumi:"instanceId"`
	// OceanBase cluster name.
	InstanceName *string `pulumi:"instanceName"`
	// A regex string to filter results by Instance name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	PageNumber *int    `pulumi:"pageNumber"`
	PageSize   *int    `pulumi:"pageSize"`
	// The ID of the enterprise resource group to which the instance resides.
	ResourceGroupId *string `pulumi:"resourceGroupId"`
	// The filter keyword for the query list.
	SearchKey *string `pulumi:"searchKey"`
	// The status of the resource.
	Status *string `pulumi:"status"`
}

A collection of arguments for invoking getBaseInstances.

type GetBaseInstancesInstance 

type GetBaseInstancesInstance struct {
	// The product code of the OceanBase cluster.
	CommodityCode string `pulumi:"commodityCode"`
	// The number of CPU cores of the cluster.
	Cpu int `pulumi:"cpu"`
	// The creation time of the resource.
	CreateTime string `pulumi:"createTime"`
	// The size of the storage space, in GB.
	DiskSize string `pulumi:"diskSize"`
	// The ID of the Instance.
	Id string `pulumi:"id"`
	// Cluster specification information.
	InstanceClass string `pulumi:"instanceClass"`
	// OceanBase cluster ID.
	InstanceId string `pulumi:"instanceId"`
	// OceanBase cluster name.
	InstanceName string `pulumi:"instanceName"`
	// The number of nodes in the cluster.
	NodeNum string `pulumi:"nodeNum"`
	// The payment method of the instance.
	PaymentType string `pulumi:"paymentType"`
	// The ID of the enterprise resource group to which the instance resides.
	ResourceGroupId string `pulumi:"resourceGroupId"`
	// Series of OceanBase clusters.
	Series string `pulumi:"series"`
	// The status of the resource.
	Status string `pulumi:"status"`
	// Information about the zone where the cluster is deployed.
	Zones []string `pulumi:"zones"`
}

type GetBaseInstancesInstanceArgs 

type GetBaseInstancesInstanceArgs struct {
	// The product code of the OceanBase cluster.
	CommodityCode pulumi.StringInput `pulumi:"commodityCode"`
	// The number of CPU cores of the cluster.
	Cpu pulumi.IntInput `pulumi:"cpu"`
	// The creation time of the resource.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The size of the storage space, in GB.
	DiskSize pulumi.StringInput `pulumi:"diskSize"`
	// The ID of the Instance.
	Id pulumi.StringInput `pulumi:"id"`
	// Cluster specification information.
	InstanceClass pulumi.StringInput `pulumi:"instanceClass"`
	// OceanBase cluster ID.
	InstanceId pulumi.StringInput `pulumi:"instanceId"`
	// OceanBase cluster name.
	InstanceName pulumi.StringInput `pulumi:"instanceName"`
	// The number of nodes in the cluster.
	NodeNum pulumi.StringInput `pulumi:"nodeNum"`
	// The payment method of the instance.
	PaymentType pulumi.StringInput `pulumi:"paymentType"`
	// The ID of the enterprise resource group to which the instance resides.
	ResourceGroupId pulumi.StringInput `pulumi:"resourceGroupId"`
	// Series of OceanBase clusters.
	Series pulumi.StringInput `pulumi:"series"`
	// The status of the resource.
	Status pulumi.StringInput `pulumi:"status"`
	// Information about the zone where the cluster is deployed.
	Zones pulumi.StringArrayInput `pulumi:"zones"`
}

func (GetBaseInstancesInstanceArgs) ElementType 

func (GetBaseInstancesInstanceArgs) ElementType() reflect.Type

func (GetBaseInstancesInstanceArgs) ToGetBaseInstancesInstanceOutput 

func (i GetBaseInstancesInstanceArgs) ToGetBaseInstancesInstanceOutput() GetBaseInstancesInstanceOutput

func (GetBaseInstancesInstanceArgs) ToGetBaseInstancesInstanceOutputWithContext 

func (i GetBaseInstancesInstanceArgs) ToGetBaseInstancesInstanceOutputWithContext(ctx context.Context) GetBaseInstancesInstanceOutput

type GetBaseInstancesInstanceArray 

type GetBaseInstancesInstanceArray []GetBaseInstancesInstanceInput

func (GetBaseInstancesInstanceArray) ElementType 

func (GetBaseInstancesInstanceArray) ElementType() reflect.Type

func (GetBaseInstancesInstanceArray) ToGetBaseInstancesInstanceArrayOutput 

func (i GetBaseInstancesInstanceArray) ToGetBaseInstancesInstanceArrayOutput() GetBaseInstancesInstanceArrayOutput

func (GetBaseInstancesInstanceArray) ToGetBaseInstancesInstanceArrayOutputWithContext 

func (i GetBaseInstancesInstanceArray) ToGetBaseInstancesInstanceArrayOutputWithContext(ctx context.Context) GetBaseInstancesInstanceArrayOutput

type GetBaseInstancesInstanceArrayInput 

type GetBaseInstancesInstanceArrayInput interface {
	pulumi.Input

	ToGetBaseInstancesInstanceArrayOutput() GetBaseInstancesInstanceArrayOutput
	ToGetBaseInstancesInstanceArrayOutputWithContext(context.Context) GetBaseInstancesInstanceArrayOutput
}

GetBaseInstancesInstanceArrayInput is an input type that accepts GetBaseInstancesInstanceArray and GetBaseInstancesInstanceArrayOutput values. You can construct a concrete instance of `GetBaseInstancesInstanceArrayInput` via: 

GetBaseInstancesInstanceArray{ GetBaseInstancesInstanceArgs{...} }

type GetBaseInstancesInstanceArrayOutput 

type GetBaseInstancesInstanceArrayOutput struct{ *pulumi.OutputState }

func (GetBaseInstancesInstanceArrayOutput) ElementType 

func (GetBaseInstancesInstanceArrayOutput) ElementType() reflect.Type

func (GetBaseInstancesInstanceArrayOutput) Index 

func (o GetBaseInstancesInstanceArrayOutput) Index(i pulumi.IntInput) GetBaseInstancesInstanceOutput

func (GetBaseInstancesInstanceArrayOutput) ToGetBaseInstancesInstanceArrayOutput 

func (o GetBaseInstancesInstanceArrayOutput) ToGetBaseInstancesInstanceArrayOutput() GetBaseInstancesInstanceArrayOutput

func (GetBaseInstancesInstanceArrayOutput) ToGetBaseInstancesInstanceArrayOutputWithContext 

func (o GetBaseInstancesInstanceArrayOutput) ToGetBaseInstancesInstanceArrayOutputWithContext(ctx context.Context) GetBaseInstancesInstanceArrayOutput

type GetBaseInstancesInstanceInput 

type GetBaseInstancesInstanceInput interface {
	pulumi.Input

	ToGetBaseInstancesInstanceOutput() GetBaseInstancesInstanceOutput
	ToGetBaseInstancesInstanceOutputWithContext(context.Context) GetBaseInstancesInstanceOutput
}

GetBaseInstancesInstanceInput is an input type that accepts GetBaseInstancesInstanceArgs and GetBaseInstancesInstanceOutput values. You can construct a concrete instance of `GetBaseInstancesInstanceInput` via: 

GetBaseInstancesInstanceArgs{...}

type GetBaseInstancesInstanceOutput 

type GetBaseInstancesInstanceOutput struct{ *pulumi.OutputState }

func (GetBaseInstancesInstanceOutput) CommodityCode 

func (o GetBaseInstancesInstanceOutput) CommodityCode() pulumi.StringOutput

The product code of the OceanBase cluster.

func (GetBaseInstancesInstanceOutput) Cpu 

func (o GetBaseInstancesInstanceOutput) Cpu() pulumi.IntOutput

The number of CPU cores of the cluster.

func (GetBaseInstancesInstanceOutput) CreateTime 

func (o GetBaseInstancesInstanceOutput) CreateTime() pulumi.StringOutput

The creation time of the resource.

func (GetBaseInstancesInstanceOutput) DiskSize 

func (o GetBaseInstancesInstanceOutput) DiskSize() pulumi.StringOutput

The size of the storage space, in GB.

func (GetBaseInstancesInstanceOutput) ElementType 

func (GetBaseInstancesInstanceOutput) ElementType() reflect.Type

func (GetBaseInstancesInstanceOutput) Id 

func (o GetBaseInstancesInstanceOutput) Id() pulumi.StringOutput

The ID of the Instance.

func (GetBaseInstancesInstanceOutput) InstanceClass 

func (o GetBaseInstancesInstanceOutput) InstanceClass() pulumi.StringOutput

Cluster specification information.

func (GetBaseInstancesInstanceOutput) InstanceId 

func (o GetBaseInstancesInstanceOutput) InstanceId() pulumi.StringOutput

OceanBase cluster ID.

func (GetBaseInstancesInstanceOutput) InstanceName 

func (o GetBaseInstancesInstanceOutput) InstanceName() pulumi.StringOutput

OceanBase cluster name.

func (GetBaseInstancesInstanceOutput) NodeNum 

func (o GetBaseInstancesInstanceOutput) NodeNum() pulumi.StringOutput

The number of nodes in the cluster.

func (GetBaseInstancesInstanceOutput) PaymentType 

func (o GetBaseInstancesInstanceOutput) PaymentType() pulumi.StringOutput

The payment method of the instance.

func (GetBaseInstancesInstanceOutput) ResourceGroupId 

func (o GetBaseInstancesInstanceOutput) ResourceGroupId() pulumi.StringOutput

The ID of the enterprise resource group to which the instance resides.

func (GetBaseInstancesInstanceOutput) Series 

func (o GetBaseInstancesInstanceOutput) Series() pulumi.StringOutput

Series of OceanBase clusters.

func (GetBaseInstancesInstanceOutput) Status 

func (o GetBaseInstancesInstanceOutput) Status() pulumi.StringOutput

The status of the resource.

func (GetBaseInstancesInstanceOutput) ToGetBaseInstancesInstanceOutput 

func (o GetBaseInstancesInstanceOutput) ToGetBaseInstancesInstanceOutput() GetBaseInstancesInstanceOutput

func (GetBaseInstancesInstanceOutput) ToGetBaseInstancesInstanceOutputWithContext 

func (o GetBaseInstancesInstanceOutput) ToGetBaseInstancesInstanceOutputWithContext(ctx context.Context) GetBaseInstancesInstanceOutput

func (GetBaseInstancesInstanceOutput) Zones 

func (o GetBaseInstancesInstanceOutput) Zones() pulumi.StringArrayOutput

Information about the zone where the cluster is deployed.

type GetBaseInstancesOutputArgs 

type GetBaseInstancesOutputArgs struct {
	EnableDetails pulumi.BoolPtrInput `pulumi:"enableDetails"`
	// A list of Instance IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// OceanBase cluster ID.
	InstanceId pulumi.StringPtrInput `pulumi:"instanceId"`
	// OceanBase cluster name.
	InstanceName pulumi.StringPtrInput `pulumi:"instanceName"`
	// A regex string to filter results by Instance name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	PageNumber pulumi.IntPtrInput    `pulumi:"pageNumber"`
	PageSize   pulumi.IntPtrInput    `pulumi:"pageSize"`
	// The ID of the enterprise resource group to which the instance resides.
	ResourceGroupId pulumi.StringPtrInput `pulumi:"resourceGroupId"`
	// The filter keyword for the query list.
	SearchKey pulumi.StringPtrInput `pulumi:"searchKey"`
	// The status of the resource.
	Status pulumi.StringPtrInput `pulumi:"status"`
}

A collection of arguments for invoking getBaseInstances.

func (GetBaseInstancesOutputArgs) ElementType 

func (GetBaseInstancesOutputArgs) ElementType() reflect.Type

type GetBaseInstancesResult 

type GetBaseInstancesResult struct {
	EnableDetails *bool `pulumi:"enableDetails"`
	// The provider-assigned unique ID for this managed resource.
	Id              string                     `pulumi:"id"`
	Ids             []string                   `pulumi:"ids"`
	InstanceId      *string                    `pulumi:"instanceId"`
	InstanceName    *string                    `pulumi:"instanceName"`
	Instances       []GetBaseInstancesInstance `pulumi:"instances"`
	NameRegex       *string                    `pulumi:"nameRegex"`
	Names           []string                   `pulumi:"names"`
	OutputFile      *string                    `pulumi:"outputFile"`
	PageNumber      *int                       `pulumi:"pageNumber"`
	PageSize        *int                       `pulumi:"pageSize"`
	ResourceGroupId *string                    `pulumi:"resourceGroupId"`
	SearchKey       *string                    `pulumi:"searchKey"`
	Status          *string                    `pulumi:"status"`
}

A collection of values returned by getBaseInstances.

func GetBaseInstances 

func GetBaseInstances(ctx *pulumi.Context, args *GetBaseInstancesArgs, opts ...pulumi.InvokeOption) (*GetBaseInstancesResult, error)

This data source provides the Ocean Base Instances of the current Alibaba Cloud user.

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

## Example Usage

Basic Usage

```go package main

import ( 

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

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := ocean.GetBaseInstances(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("oceanBaseInstanceId1", ids.Instances[0].Id)
		nameRegex, err := ocean.GetBaseInstances(ctx, &ocean.GetBaseInstancesArgs{
			NameRegex: pulumi.StringRef("^my-Instance"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("oceanBaseInstanceId2", nameRegex.Instances[0].Id)
		return nil
	})
}

```

type GetBaseInstancesResultOutput 

type GetBaseInstancesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getBaseInstances.

func GetBaseInstancesOutput 

func GetBaseInstancesOutput(ctx *pulumi.Context, args GetBaseInstancesOutputArgs, opts ...pulumi.InvokeOption) GetBaseInstancesResultOutput

func (GetBaseInstancesResultOutput) ElementType 

func (GetBaseInstancesResultOutput) ElementType() reflect.Type

func (GetBaseInstancesResultOutput) EnableDetails 

func (o GetBaseInstancesResultOutput) EnableDetails() pulumi.BoolPtrOutput

func (GetBaseInstancesResultOutput) Id 

func (o GetBaseInstancesResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetBaseInstancesResultOutput) Ids 

func (o GetBaseInstancesResultOutput) Ids() pulumi.StringArrayOutput

func (GetBaseInstancesResultOutput) InstanceId 

func (o GetBaseInstancesResultOutput) InstanceId() pulumi.StringPtrOutput

func (GetBaseInstancesResultOutput) InstanceName 

func (o GetBaseInstancesResultOutput) InstanceName() pulumi.StringPtrOutput

func (GetBaseInstancesResultOutput) Instances 

func (o GetBaseInstancesResultOutput) Instances() GetBaseInstancesInstanceArrayOutput

func (GetBaseInstancesResultOutput) NameRegex 

func (o GetBaseInstancesResultOutput) NameRegex() pulumi.StringPtrOutput

func (GetBaseInstancesResultOutput) Names 

func (o GetBaseInstancesResultOutput) Names() pulumi.StringArrayOutput

func (GetBaseInstancesResultOutput) OutputFile 

func (o GetBaseInstancesResultOutput) OutputFile() pulumi.StringPtrOutput

func (GetBaseInstancesResultOutput) PageNumber 

func (o GetBaseInstancesResultOutput) PageNumber() pulumi.IntPtrOutput

func (GetBaseInstancesResultOutput) PageSize 

func (o GetBaseInstancesResultOutput) PageSize() pulumi.IntPtrOutput

func (GetBaseInstancesResultOutput) ResourceGroupId 

func (o GetBaseInstancesResultOutput) ResourceGroupId() pulumi.StringPtrOutput

func (GetBaseInstancesResultOutput) SearchKey 

func (o GetBaseInstancesResultOutput) SearchKey() pulumi.StringPtrOutput

func (GetBaseInstancesResultOutput) Status 

func (o GetBaseInstancesResultOutput) Status() pulumi.StringPtrOutput

func (GetBaseInstancesResultOutput) ToGetBaseInstancesResultOutput 

func (o GetBaseInstancesResultOutput) ToGetBaseInstancesResultOutput() GetBaseInstancesResultOutput

func (GetBaseInstancesResultOutput) ToGetBaseInstancesResultOutputWithContext 

func (o GetBaseInstancesResultOutput) ToGetBaseInstancesResultOutputWithContext(ctx context.Context) GetBaseInstancesResultOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

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