1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. ocean
  5. BaseInstance
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi

alicloud.ocean.BaseInstance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi

    Provides a Ocean Base Instance resource.

    For information about Ocean Base Instance and how to use it, see What is Instance.

    NOTE: Available since v1.203.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const defaultZones = alicloud.getZones({});
    const defaultResourceGroups = alicloud.resourcemanager.getResourceGroups({});
    const defaultBaseInstance = new alicloud.ocean.BaseInstance("defaultBaseInstance", {
        resourceGroupId: defaultResourceGroups.then(defaultResourceGroups => defaultResourceGroups.ids?.[0]),
        zones: [
            Promise.all([defaultZones, defaultZones.then(defaultZones => defaultZones.ids).length]).then(([defaultZones, length]) => defaultZones.ids[length - 2]),
            Promise.all([defaultZones, defaultZones.then(defaultZones => defaultZones.ids).length]).then(([defaultZones, length]) => defaultZones.ids[length - 3]),
            Promise.all([defaultZones, defaultZones.then(defaultZones => defaultZones.ids).length]).then(([defaultZones, length]) => defaultZones.ids[length - 4]),
        ],
        autoRenew: false,
        diskSize: 100,
        paymentType: "PayAsYouGo",
        instanceClass: "8C32GB",
        backupRetainMode: "delete_all",
        series: "normal",
        instanceName: name,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default_zones = alicloud.get_zones()
    default_resource_groups = alicloud.resourcemanager.get_resource_groups()
    default_base_instance = alicloud.ocean.BaseInstance("defaultBaseInstance",
        resource_group_id=default_resource_groups.ids[0],
        zones=[
            default_zones.ids[len(default_zones.ids) - 2],
            default_zones.ids[len(default_zones.ids) - 3],
            default_zones.ids[len(default_zones.ids) - 4],
        ],
        auto_renew=False,
        disk_size=100,
        payment_type="PayAsYouGo",
        instance_class="8C32GB",
        backup_retain_mode="delete_all",
        series="normal",
        instance_name=name)
    
    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
    		}
    		defaultZones, err := alicloud.GetZones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		defaultResourceGroups, err := resourcemanager.GetResourceGroups(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		_, err = ocean.NewBaseInstance(ctx, "defaultBaseInstance", &ocean.BaseInstanceArgs{
    			ResourceGroupId: pulumi.String(defaultResourceGroups.Ids[0]),
    			Zones: pulumi.StringArray{
    				defaultZones.Ids[len(defaultZones.Ids)-2],
    				defaultZones.Ids[len(defaultZones.Ids)-3],
    				defaultZones.Ids[len(defaultZones.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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var defaultZones = AliCloud.GetZones.Invoke();
    
        var defaultResourceGroups = AliCloud.ResourceManager.GetResourceGroups.Invoke();
    
        var defaultBaseInstance = new AliCloud.Ocean.BaseInstance("defaultBaseInstance", new()
        {
            ResourceGroupId = defaultResourceGroups.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[0]),
            Zones = new[]
            {
                Output.Tuple(defaultZones, defaultZones.Apply(getZonesResult => getZonesResult.Ids).Length).Apply(values =>
                {
                    var defaultZones = values.Item1;
                    var length = values.Item2;
                    return defaultZones.Apply(getZonesResult => getZonesResult.Ids)[length - 2];
                }),
                Output.Tuple(defaultZones, defaultZones.Apply(getZonesResult => getZonesResult.Ids).Length).Apply(values =>
                {
                    var defaultZones = values.Item1;
                    var length = values.Item2;
                    return defaultZones.Apply(getZonesResult => getZonesResult.Ids)[length - 3];
                }),
                Output.Tuple(defaultZones, defaultZones.Apply(getZonesResult => getZonesResult.Ids).Length).Apply(values =>
                {
                    var defaultZones = values.Item1;
                    var length = values.Item2;
                    return defaultZones.Apply(getZonesResult => getZonesResult.Ids)[length - 4];
                }),
            },
            AutoRenew = false,
            DiskSize = 100,
            PaymentType = "PayAsYouGo",
            InstanceClass = "8C32GB",
            BackupRetainMode = "delete_all",
            Series = "normal",
            InstanceName = name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.AlicloudFunctions;
    import com.pulumi.alicloud.inputs.GetZonesArgs;
    import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
    import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
    import com.pulumi.alicloud.ocean.BaseInstance;
    import com.pulumi.alicloud.ocean.BaseInstanceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var config = ctx.config();
            final var name = config.get("name").orElse("terraform-example");
            final var defaultZones = AlicloudFunctions.getZones();
    
            final var defaultResourceGroups = ResourcemanagerFunctions.getResourceGroups();
    
            var defaultBaseInstance = new BaseInstance("defaultBaseInstance", BaseInstanceArgs.builder()        
                .resourceGroupId(defaultResourceGroups.applyValue(getResourceGroupsResult -> getResourceGroupsResult.ids()[0]))
                .zones(            
                    defaultZones.applyValue(getZonesResult -> getZonesResult.ids())[defaultZones.applyValue(getZonesResult -> getZonesResult.ids()).length() - 2],
                    defaultZones.applyValue(getZonesResult -> getZonesResult.ids())[defaultZones.applyValue(getZonesResult -> getZonesResult.ids()).length() - 3],
                    defaultZones.applyValue(getZonesResult -> getZonesResult.ids())[defaultZones.applyValue(getZonesResult -> getZonesResult.ids()).length() - 4])
                .autoRenew("false")
                .diskSize("100")
                .paymentType("PayAsYouGo")
                .instanceClass("8C32GB")
                .backupRetainMode("delete_all")
                .series("normal")
                .instanceName(name)
                .build());
    
        }
    }
    
    Coming soon!
    

    Create BaseInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BaseInstance(name: string, args: BaseInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def BaseInstance(resource_name: str,
                     args: BaseInstanceArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def BaseInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     payment_type: Optional[str] = None,
                     instance_class: Optional[str] = None,
                     zones: Optional[Sequence[str]] = None,
                     disk_size: Optional[int] = None,
                     series: Optional[str] = None,
                     ob_version: Optional[str] = None,
                     auto_renew_period: Optional[int] = None,
                     node_num: Optional[str] = None,
                     instance_name: Optional[str] = None,
                     auto_renew: Optional[bool] = None,
                     period: Optional[int] = None,
                     period_unit: Optional[str] = None,
                     resource_group_id: Optional[str] = None,
                     disk_type: Optional[str] = None,
                     backup_retain_mode: Optional[str] = None)
    func NewBaseInstance(ctx *Context, name string, args BaseInstanceArgs, opts ...ResourceOption) (*BaseInstance, error)
    public BaseInstance(string name, BaseInstanceArgs args, CustomResourceOptions? opts = null)
    public BaseInstance(String name, BaseInstanceArgs args)
    public BaseInstance(String name, BaseInstanceArgs args, CustomResourceOptions options)
    
    type: alicloud:ocean:BaseInstance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BaseInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BaseInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BaseInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BaseInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BaseInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var baseInstanceResource = new AliCloud.Ocean.BaseInstance("baseInstanceResource", new()
    {
        PaymentType = "string",
        InstanceClass = "string",
        Zones = new[]
        {
            "string",
        },
        DiskSize = 0,
        Series = "string",
        ObVersion = "string",
        AutoRenewPeriod = 0,
        NodeNum = "string",
        InstanceName = "string",
        AutoRenew = false,
        Period = 0,
        PeriodUnit = "string",
        ResourceGroupId = "string",
        DiskType = "string",
        BackupRetainMode = "string",
    });
    
    example, err := ocean.NewBaseInstance(ctx, "baseInstanceResource", &ocean.BaseInstanceArgs{
    	PaymentType:   pulumi.String("string"),
    	InstanceClass: pulumi.String("string"),
    	Zones: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DiskSize:         pulumi.Int(0),
    	Series:           pulumi.String("string"),
    	ObVersion:        pulumi.String("string"),
    	AutoRenewPeriod:  pulumi.Int(0),
    	NodeNum:          pulumi.String("string"),
    	InstanceName:     pulumi.String("string"),
    	AutoRenew:        pulumi.Bool(false),
    	Period:           pulumi.Int(0),
    	PeriodUnit:       pulumi.String("string"),
    	ResourceGroupId:  pulumi.String("string"),
    	DiskType:         pulumi.String("string"),
    	BackupRetainMode: pulumi.String("string"),
    })
    
    var baseInstanceResource = new BaseInstance("baseInstanceResource", BaseInstanceArgs.builder()        
        .paymentType("string")
        .instanceClass("string")
        .zones("string")
        .diskSize(0)
        .series("string")
        .obVersion("string")
        .autoRenewPeriod(0)
        .nodeNum("string")
        .instanceName("string")
        .autoRenew(false)
        .period(0)
        .periodUnit("string")
        .resourceGroupId("string")
        .diskType("string")
        .backupRetainMode("string")
        .build());
    
    base_instance_resource = alicloud.ocean.BaseInstance("baseInstanceResource",
        payment_type="string",
        instance_class="string",
        zones=["string"],
        disk_size=0,
        series="string",
        ob_version="string",
        auto_renew_period=0,
        node_num="string",
        instance_name="string",
        auto_renew=False,
        period=0,
        period_unit="string",
        resource_group_id="string",
        disk_type="string",
        backup_retain_mode="string")
    
    const baseInstanceResource = new alicloud.ocean.BaseInstance("baseInstanceResource", {
        paymentType: "string",
        instanceClass: "string",
        zones: ["string"],
        diskSize: 0,
        series: "string",
        obVersion: "string",
        autoRenewPeriod: 0,
        nodeNum: "string",
        instanceName: "string",
        autoRenew: false,
        period: 0,
        periodUnit: "string",
        resourceGroupId: "string",
        diskType: "string",
        backupRetainMode: "string",
    });
    
    type: alicloud:ocean:BaseInstance
    properties:
        autoRenew: false
        autoRenewPeriod: 0
        backupRetainMode: string
        diskSize: 0
        diskType: string
        instanceClass: string
        instanceName: string
        nodeNum: string
        obVersion: string
        paymentType: string
        period: 0
        periodUnit: string
        resourceGroupId: string
        series: string
        zones:
            - string
    

    BaseInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BaseInstance resource accepts the following input properties:

    DiskSize int
    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.
    InstanceClass string
    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.
    PaymentType string
    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).
    Series string
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    Zones List<string>
    Information about the zone where the cluster is deployed.
    AutoRenew bool
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    AutoRenewPeriod int
    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"}.
    BackupRetainMode string

    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.

    DiskType string
    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.
    InstanceName string
    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.
    NodeNum string
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    ObVersion string
    The OceanBase Server version number.
    Period int
    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"}.
    PeriodUnit string
    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.
    ResourceGroupId string
    The ID of the enterprise resource group to which the instance resides.
    DiskSize int
    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.
    InstanceClass string
    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.
    PaymentType string
    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).
    Series string
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    Zones []string
    Information about the zone where the cluster is deployed.
    AutoRenew bool
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    AutoRenewPeriod int
    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"}.
    BackupRetainMode string

    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.

    DiskType string
    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.
    InstanceName string
    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.
    NodeNum string
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    ObVersion string
    The OceanBase Server version number.
    Period int
    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"}.
    PeriodUnit string
    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.
    ResourceGroupId string
    The ID of the enterprise resource group to which the instance resides.
    diskSize Integer
    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.
    instanceClass String
    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.
    paymentType String
    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).
    series String
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    zones List<String>
    Information about the zone where the cluster is deployed.
    autoRenew Boolean
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    autoRenewPeriod Integer
    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"}.
    backupRetainMode String

    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.

    diskType String
    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.
    instanceName String
    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.
    nodeNum String
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    obVersion String
    The OceanBase Server version number.
    period Integer
    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"}.
    periodUnit String
    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.
    resourceGroupId String
    The ID of the enterprise resource group to which the instance resides.
    diskSize number
    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.
    instanceClass string
    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.
    paymentType string
    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).
    series string
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    zones string[]
    Information about the zone where the cluster is deployed.
    autoRenew boolean
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    autoRenewPeriod number
    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"}.
    backupRetainMode string

    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.

    diskType string
    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.
    instanceName string
    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.
    nodeNum string
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    obVersion string
    The OceanBase Server version number.
    period number
    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"}.
    periodUnit string
    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.
    resourceGroupId string
    The ID of the enterprise resource group to which the instance resides.
    disk_size int
    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.
    instance_class str
    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.
    payment_type str
    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).
    series str
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    zones Sequence[str]
    Information about the zone where the cluster is deployed.
    auto_renew bool
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    auto_renew_period int
    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"}.
    backup_retain_mode str

    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.

    disk_type str
    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.
    instance_name str
    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.
    node_num str
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    ob_version str
    The OceanBase Server version number.
    period int
    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_unit str
    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.
    resource_group_id str
    The ID of the enterprise resource group to which the instance resides.
    diskSize Number
    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.
    instanceClass String
    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.
    paymentType String
    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).
    series String
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    zones List<String>
    Information about the zone where the cluster is deployed.
    autoRenew Boolean
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    autoRenewPeriod Number
    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"}.
    backupRetainMode String

    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.

    diskType String
    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.
    instanceName String
    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.
    nodeNum String
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    obVersion String
    The OceanBase Server version number.
    period Number
    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"}.
    periodUnit String
    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.
    resourceGroupId String
    The ID of the enterprise resource group to which the instance resides.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BaseInstance resource produces the following output properties:

    CommodityCode string
    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.
    Cpu int
    The number of CPU cores of the cluster.
    CreateTime string
    The creation time of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource.
    CommodityCode string
    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.
    Cpu int
    The number of CPU cores of the cluster.
    CreateTime string
    The creation time of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the resource.
    commodityCode String
    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.
    cpu Integer
    The number of CPU cores of the cluster.
    createTime String
    The creation time of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource.
    commodityCode string
    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.
    cpu number
    The number of CPU cores of the cluster.
    createTime string
    The creation time of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the resource.
    commodity_code str
    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.
    cpu int
    The number of CPU cores of the cluster.
    create_time str
    The creation time of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the resource.
    commodityCode String
    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.
    cpu Number
    The number of CPU cores of the cluster.
    createTime String
    The creation time of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the resource.

    Look up Existing BaseInstance Resource

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

    public static get(name: string, id: Input<ID>, state?: BaseInstanceState, opts?: CustomResourceOptions): BaseInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_renew: Optional[bool] = None,
            auto_renew_period: Optional[int] = None,
            backup_retain_mode: Optional[str] = None,
            commodity_code: Optional[str] = None,
            cpu: Optional[int] = None,
            create_time: Optional[str] = None,
            disk_size: Optional[int] = None,
            disk_type: Optional[str] = None,
            instance_class: Optional[str] = None,
            instance_name: Optional[str] = None,
            node_num: Optional[str] = None,
            ob_version: Optional[str] = None,
            payment_type: Optional[str] = None,
            period: Optional[int] = None,
            period_unit: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            series: Optional[str] = None,
            status: Optional[str] = None,
            zones: Optional[Sequence[str]] = None) -> BaseInstance
    func GetBaseInstance(ctx *Context, name string, id IDInput, state *BaseInstanceState, opts ...ResourceOption) (*BaseInstance, error)
    public static BaseInstance Get(string name, Input<string> id, BaseInstanceState? state, CustomResourceOptions? opts = null)
    public static BaseInstance get(String name, Output<String> id, BaseInstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoRenew bool
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    AutoRenewPeriod int
    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"}.
    BackupRetainMode string

    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.

    CommodityCode string
    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.
    Cpu int
    The number of CPU cores of the cluster.
    CreateTime string
    The creation time of the resource.
    DiskSize int
    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.
    DiskType string
    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.
    InstanceClass string
    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.
    InstanceName string
    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.
    NodeNum string
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    ObVersion string
    The OceanBase Server version number.
    PaymentType string
    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).
    Period int
    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"}.
    PeriodUnit string
    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.
    ResourceGroupId string
    The ID of the enterprise resource group to which the instance resides.
    Series string
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    Status string
    The status of the resource.
    Zones List<string>
    Information about the zone where the cluster is deployed.
    AutoRenew bool
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    AutoRenewPeriod int
    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"}.
    BackupRetainMode string

    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.

    CommodityCode string
    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.
    Cpu int
    The number of CPU cores of the cluster.
    CreateTime string
    The creation time of the resource.
    DiskSize int
    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.
    DiskType string
    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.
    InstanceClass string
    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.
    InstanceName string
    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.
    NodeNum string
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    ObVersion string
    The OceanBase Server version number.
    PaymentType string
    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).
    Period int
    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"}.
    PeriodUnit string
    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.
    ResourceGroupId string
    The ID of the enterprise resource group to which the instance resides.
    Series string
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    Status string
    The status of the resource.
    Zones []string
    Information about the zone where the cluster is deployed.
    autoRenew Boolean
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    autoRenewPeriod Integer
    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"}.
    backupRetainMode String

    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.

    commodityCode String
    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.
    cpu Integer
    The number of CPU cores of the cluster.
    createTime String
    The creation time of the resource.
    diskSize Integer
    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.
    diskType String
    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.
    instanceClass String
    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.
    instanceName String
    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.
    nodeNum String
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    obVersion String
    The OceanBase Server version number.
    paymentType String
    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).
    period Integer
    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"}.
    periodUnit String
    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.
    resourceGroupId String
    The ID of the enterprise resource group to which the instance resides.
    series String
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    status String
    The status of the resource.
    zones List<String>
    Information about the zone where the cluster is deployed.
    autoRenew boolean
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    autoRenewPeriod number
    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"}.
    backupRetainMode string

    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.

    commodityCode string
    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.
    cpu number
    The number of CPU cores of the cluster.
    createTime string
    The creation time of the resource.
    diskSize number
    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.
    diskType string
    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.
    instanceClass string
    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.
    instanceName string
    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.
    nodeNum string
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    obVersion string
    The OceanBase Server version number.
    paymentType string
    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).
    period number
    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"}.
    periodUnit string
    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.
    resourceGroupId string
    The ID of the enterprise resource group to which the instance resides.
    series string
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    status string
    The status of the resource.
    zones string[]
    Information about the zone where the cluster is deployed.
    auto_renew bool
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    auto_renew_period int
    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"}.
    backup_retain_mode str

    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.

    commodity_code str
    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.
    cpu int
    The number of CPU cores of the cluster.
    create_time str
    The creation time of the resource.
    disk_size int
    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.
    disk_type str
    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.
    instance_class str
    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.
    instance_name str
    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.
    node_num str
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    ob_version str
    The OceanBase Server version number.
    payment_type str
    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).
    period int
    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_unit str
    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.
    resource_group_id str
    The ID of the enterprise resource group to which the instance resides.
    series str
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    status str
    The status of the resource.
    zones Sequence[str]
    Information about the zone where the cluster is deployed.
    autoRenew Boolean
    Whether to automatically renew. It takes effect when the parameter ChargeType is PrePaid. Value range:

    • true: automatic renewal.
    • false (default): no automatic renewal.
    autoRenewPeriod Number
    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"}.
    backupRetainMode String

    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.

    commodityCode String
    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.
    cpu Number
    The number of CPU cores of the cluster.
    createTime String
    The creation time of the resource.
    diskSize Number
    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.
    diskType String
    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.
    instanceClass String
    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.
    instanceName String
    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.
    nodeNum String
    The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n * 3.
    obVersion String
    The OceanBase Server version number.
    paymentType String
    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).
    period Number
    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"}.
    periodUnit String
    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.
    resourceGroupId String
    The ID of the enterprise resource group to which the instance resides.
    series String
    Series of OceanBase cluster instances-normal (default): Standard cluster version (cloud disk)-normal_SSD: Standard cluster version (local disk)-history: history Library cluster version.
    status String
    The status of the resource.
    zones List<String>
    Information about the zone where the cluster is deployed.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi