alicloud.adb.DBCluster
Explore with Pulumi AI
Provides a AnalyticDB for MySQL (ADB) DBCluster resource.
For information about AnalyticDB for MySQL (ADB) DBCluster and how to use it, see What is DBCluster.
NOTE: Available in v1.121.0+.
Example Usage
Basic Usage
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") ?? "adbClusterconfig";
var creation = config.Get("creation") ?? "ADB";
var defaultZones = AliCloud.GetZones.Invoke(new()
{
AvailableResourceCreation = creation,
});
var defaultNetwork = new AliCloud.Vpc.Network("defaultNetwork", new()
{
VpcName = name,
CidrBlock = "172.16.0.0/16",
});
var defaultSwitch = new AliCloud.Vpc.Switch("defaultSwitch", new()
{
VpcId = defaultNetwork.Id,
CidrBlock = "172.16.0.0/24",
ZoneId = defaultZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
VswitchName = name,
});
var @this = new AliCloud.Adb.DBCluster("this", new()
{
DbClusterCategory = "Cluster",
DbNodeClass = "C8",
DbNodeCount = 4,
DbNodeStorage = 400,
Mode = "reserver",
DbClusterVersion = "3.0",
PaymentType = "PayAsYouGo",
VswitchId = defaultSwitch.Id,
Description = "Test new adb again.",
MaintainTime = "23:00Z-00:00Z",
Tags =
{
{ "Created", "TF-update" },
{ "For", "acceptance-test-update" },
},
ResourceGroupId = "rg-aek2s7ylxx6****",
SecurityIps = new[]
{
"10.168.1.12",
"10.168.1.11",
},
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/adb"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "adbClusterconfig"
if param := cfg.Get("name"); param != "" {
name = param
}
creation := "ADB"
if param := cfg.Get("creation"); param != "" {
creation = param
}
defaultZones, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
AvailableResourceCreation: pulumi.StringRef(creation),
}, nil)
if err != nil {
return err
}
defaultNetwork, err := vpc.NewNetwork(ctx, "defaultNetwork", &vpc.NetworkArgs{
VpcName: pulumi.String(name),
CidrBlock: pulumi.String("172.16.0.0/16"),
})
if err != nil {
return err
}
defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &vpc.SwitchArgs{
VpcId: defaultNetwork.ID(),
CidrBlock: pulumi.String("172.16.0.0/24"),
ZoneId: *pulumi.String(defaultZones.Zones[0].Id),
VswitchName: pulumi.String(name),
})
if err != nil {
return err
}
_, err = adb.NewDBCluster(ctx, "this", &adb.DBClusterArgs{
DbClusterCategory: pulumi.String("Cluster"),
DbNodeClass: pulumi.String("C8"),
DbNodeCount: pulumi.Int(4),
DbNodeStorage: pulumi.Int(400),
Mode: pulumi.String("reserver"),
DbClusterVersion: pulumi.String("3.0"),
PaymentType: pulumi.String("PayAsYouGo"),
VswitchId: defaultSwitch.ID(),
Description: pulumi.String("Test new adb again."),
MaintainTime: pulumi.String("23:00Z-00:00Z"),
Tags: pulumi.AnyMap{
"Created": pulumi.Any("TF-update"),
"For": pulumi.Any("acceptance-test-update"),
},
ResourceGroupId: pulumi.String("rg-aek2s7ylxx6****"),
SecurityIps: pulumi.StringArray{
pulumi.String("10.168.1.12"),
pulumi.String("10.168.1.11"),
},
})
if err != nil {
return err
}
return nil
})
}
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.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.adb.DBCluster;
import com.pulumi.alicloud.adb.DBClusterArgs;
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("adbClusterconfig");
final var creation = config.get("creation").orElse("ADB");
final var defaultZones = AlicloudFunctions.getZones(GetZonesArgs.builder()
.availableResourceCreation(creation)
.build());
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.vpcName(name)
.cidrBlock("172.16.0.0/16")
.build());
var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
.vpcId(defaultNetwork.id())
.cidrBlock("172.16.0.0/24")
.zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.vswitchName(name)
.build());
var this_ = new DBCluster("this", DBClusterArgs.builder()
.dbClusterCategory("Cluster")
.dbNodeClass("C8")
.dbNodeCount("4")
.dbNodeStorage("400")
.mode("reserver")
.dbClusterVersion("3.0")
.paymentType("PayAsYouGo")
.vswitchId(defaultSwitch.id())
.description("Test new adb again.")
.maintainTime("23:00Z-00:00Z")
.tags(Map.ofEntries(
Map.entry("Created", "TF-update"),
Map.entry("For", "acceptance-test-update")
))
.resourceGroupId("rg-aek2s7ylxx6****")
.securityIps(
"10.168.1.12",
"10.168.1.11")
.build());
}
}
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "adbClusterconfig"
creation = config.get("creation")
if creation is None:
creation = "ADB"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork",
vpc_name=name,
cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
vpc_id=default_network.id,
cidr_block="172.16.0.0/24",
zone_id=default_zones.zones[0].id,
vswitch_name=name)
this = alicloud.adb.DBCluster("this",
db_cluster_category="Cluster",
db_node_class="C8",
db_node_count=4,
db_node_storage=400,
mode="reserver",
db_cluster_version="3.0",
payment_type="PayAsYouGo",
vswitch_id=default_switch.id,
description="Test new adb again.",
maintain_time="23:00Z-00:00Z",
tags={
"Created": "TF-update",
"For": "acceptance-test-update",
},
resource_group_id="rg-aek2s7ylxx6****",
security_ips=[
"10.168.1.12",
"10.168.1.11",
])
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "adbClusterconfig";
const creation = config.get("creation") || "ADB";
const defaultZones = alicloud.getZones({
availableResourceCreation: creation,
});
const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {
vpcName: name,
cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
vpcId: defaultNetwork.id,
cidrBlock: "172.16.0.0/24",
zoneId: defaultZones.then(defaultZones => defaultZones.zones?.[0]?.id),
vswitchName: name,
});
const _this = new alicloud.adb.DBCluster("this", {
dbClusterCategory: "Cluster",
dbNodeClass: "C8",
dbNodeCount: 4,
dbNodeStorage: 400,
mode: "reserver",
dbClusterVersion: "3.0",
paymentType: "PayAsYouGo",
vswitchId: defaultSwitch.id,
description: "Test new adb again.",
maintainTime: "23:00Z-00:00Z",
tags: {
Created: "TF-update",
For: "acceptance-test-update",
},
resourceGroupId: "rg-aek2s7ylxx6****",
securityIps: [
"10.168.1.12",
"10.168.1.11",
],
});
configuration:
name:
type: string
default: adbClusterconfig
creation:
type: string
default: ADB
resources:
defaultNetwork:
type: alicloud:vpc:Network
properties:
vpcName: ${name}
cidrBlock: 172.16.0.0/16
defaultSwitch:
type: alicloud:vpc:Switch
properties:
vpcId: ${defaultNetwork.id}
cidrBlock: 172.16.0.0/24
zoneId: ${defaultZones.zones[0].id}
vswitchName: ${name}
this:
type: alicloud:adb:DBCluster
properties:
dbClusterCategory: Cluster
dbNodeClass: C8
dbNodeCount: '4'
dbNodeStorage: '400'
mode: reserver
dbClusterVersion: '3.0'
paymentType: PayAsYouGo
vswitchId: ${defaultSwitch.id}
description: Test new adb again.
maintainTime: 23:00Z-00:00Z
tags:
Created: TF-update
For: acceptance-test-update
resourceGroupId: rg-aek2s7ylxx6****
securityIps:
- 10.168.1.12
- 10.168.1.11
variables:
defaultZones:
fn::invoke:
Function: alicloud:getZones
Arguments:
availableResourceCreation: ${creation}
Create DBCluster Resource
new DBCluster(name: string, args: DBClusterArgs, opts?: CustomResourceOptions);
@overload
def DBCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_renew_period: Optional[int] = None,
compute_resource: Optional[str] = None,
db_cluster_category: Optional[str] = None,
db_cluster_class: Optional[str] = None,
db_cluster_version: Optional[str] = None,
db_node_class: Optional[str] = None,
db_node_count: Optional[int] = None,
db_node_storage: Optional[int] = None,
description: Optional[str] = None,
elastic_io_resource: Optional[int] = None,
maintain_time: Optional[str] = None,
mode: Optional[str] = None,
modify_type: Optional[str] = None,
pay_type: Optional[str] = None,
payment_type: Optional[str] = None,
period: Optional[int] = None,
renewal_status: Optional[str] = None,
resource_group_id: Optional[str] = None,
security_ips: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, Any]] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None,
zone_id: Optional[str] = None)
@overload
def DBCluster(resource_name: str,
args: DBClusterArgs,
opts: Optional[ResourceOptions] = None)
func NewDBCluster(ctx *Context, name string, args DBClusterArgs, opts ...ResourceOption) (*DBCluster, error)
public DBCluster(string name, DBClusterArgs args, CustomResourceOptions? opts = null)
public DBCluster(String name, DBClusterArgs args)
public DBCluster(String name, DBClusterArgs args, CustomResourceOptions options)
type: alicloud:adb:DBCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DBClusterArgs
- 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 DBClusterArgs
- 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 DBClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DBClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DBClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DBCluster 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 DBCluster resource accepts the following input properties:
- Db
Cluster stringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- Mode string
The mode of the cluster. Valid values:
reserver
,flexible
.- Auto
Renew intPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- Compute
Resource string The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- Db
Cluster stringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- Db
Cluster stringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- Db
Node stringClass The db node class. For more information, see DBClusterClass
- Db
Node intCount The db node count.
- Db
Node intStorage The db node storage.
- Description string
The description of DBCluster.
- Elastic
Io intResource The elastic io resource.
- Maintain
Time string The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- Modify
Type string The modify type.
- Pay
Type string Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- Payment
Type string The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- Period int
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- Renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- Resource
Group stringId The ID of the resource group.
- Security
Ips List<string> List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- Vpc
Id string The vpc ID of the resource.
- Vswitch
Id string The vswitch id.
- Zone
Id string The zone ID of the resource.
- Db
Cluster stringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- Mode string
The mode of the cluster. Valid values:
reserver
,flexible
.- Auto
Renew intPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- Compute
Resource string The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- Db
Cluster stringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- Db
Cluster stringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- Db
Node stringClass The db node class. For more information, see DBClusterClass
- Db
Node intCount The db node count.
- Db
Node intStorage The db node storage.
- Description string
The description of DBCluster.
- Elastic
Io intResource The elastic io resource.
- Maintain
Time string The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- Modify
Type string The modify type.
- Pay
Type string Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- Payment
Type string The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- Period int
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- Renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- Resource
Group stringId The ID of the resource group.
- Security
Ips []string List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- map[string]interface{}
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- Vpc
Id string The vpc ID of the resource.
- Vswitch
Id string The vswitch id.
- Zone
Id string The zone ID of the resource.
- db
Cluster StringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- mode String
The mode of the cluster. Valid values:
reserver
,flexible
.- auto
Renew IntegerPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- compute
Resource String The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- db
Cluster StringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- db
Cluster StringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- db
Node StringClass The db node class. For more information, see DBClusterClass
- db
Node IntegerCount The db node count.
- db
Node IntegerStorage The db node storage.
- description String
The description of DBCluster.
- elastic
Io IntegerResource The elastic io resource.
- maintain
Time String The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- modify
Type String The modify type.
- pay
Type String Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- payment
Type String The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- period Integer
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- renewal
Status String Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group StringId The ID of the resource group.
- security
Ips List<String> List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- Map<String,Object>
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- vpc
Id String The vpc ID of the resource.
- vswitch
Id String The vswitch id.
- zone
Id String The zone ID of the resource.
- db
Cluster stringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- mode string
The mode of the cluster. Valid values:
reserver
,flexible
.- auto
Renew numberPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- compute
Resource string The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- db
Cluster stringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- db
Cluster stringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- db
Node stringClass The db node class. For more information, see DBClusterClass
- db
Node numberCount The db node count.
- db
Node numberStorage The db node storage.
- description string
The description of DBCluster.
- elastic
Io numberResource The elastic io resource.
- maintain
Time string The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- modify
Type string The modify type.
- pay
Type string Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- payment
Type string The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- period number
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group stringId The ID of the resource group.
- security
Ips string[] List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- {[key: string]: any}
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- vpc
Id string The vpc ID of the resource.
- vswitch
Id string The vswitch id.
- zone
Id string The zone ID of the resource.
- db_
cluster_ strcategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- mode str
The mode of the cluster. Valid values:
reserver
,flexible
.- auto_
renew_ intperiod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- compute_
resource str The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- db_
cluster_ strclass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- db_
cluster_ strversion The db cluster version. Value options:
3.0
, Default to3.0
.- db_
node_ strclass The db node class. For more information, see DBClusterClass
- db_
node_ intcount The db node count.
- db_
node_ intstorage The db node storage.
- description str
The description of DBCluster.
- elastic_
io_ intresource The elastic io resource.
- maintain_
time str The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- modify_
type str The modify type.
- pay_
type str Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- payment_
type str The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- period int
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- renewal_
status str Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource_
group_ strid The ID of the resource group.
- security_
ips Sequence[str] List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- Mapping[str, Any]
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- vpc_
id str The vpc ID of the resource.
- vswitch_
id str The vswitch id.
- zone_
id str The zone ID of the resource.
- db
Cluster StringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- mode String
The mode of the cluster. Valid values:
reserver
,flexible
.- auto
Renew NumberPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- compute
Resource String The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- db
Cluster StringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- db
Cluster StringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- db
Node StringClass The db node class. For more information, see DBClusterClass
- db
Node NumberCount The db node count.
- db
Node NumberStorage The db node storage.
- description String
The description of DBCluster.
- elastic
Io NumberResource The elastic io resource.
- maintain
Time String The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- modify
Type String The modify type.
- pay
Type String Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- payment
Type String The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- period Number
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- renewal
Status String Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group StringId The ID of the resource group.
- security
Ips List<String> List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- Map<Any>
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- vpc
Id String The vpc ID of the resource.
- vswitch
Id String The vswitch id.
- zone
Id String The zone ID of the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the DBCluster resource produces the following output properties:
- Connection
String string The connection string of the cluster.
- Id string
The provider-assigned unique ID for this managed resource.
- Port string
(Available in 1.196.0+) The connection port of the ADB cluster.
- Status string
The status of the resource.
- Connection
String string The connection string of the cluster.
- Id string
The provider-assigned unique ID for this managed resource.
- Port string
(Available in 1.196.0+) The connection port of the ADB cluster.
- Status string
The status of the resource.
- connection
String String The connection string of the cluster.
- id String
The provider-assigned unique ID for this managed resource.
- port String
(Available in 1.196.0+) The connection port of the ADB cluster.
- status String
The status of the resource.
- connection
String string The connection string of the cluster.
- id string
The provider-assigned unique ID for this managed resource.
- port string
(Available in 1.196.0+) The connection port of the ADB cluster.
- status string
The status of the resource.
- connection_
string str The connection string of the cluster.
- id str
The provider-assigned unique ID for this managed resource.
- port str
(Available in 1.196.0+) The connection port of the ADB cluster.
- status str
The status of the resource.
- connection
String String The connection string of the cluster.
- id String
The provider-assigned unique ID for this managed resource.
- port String
(Available in 1.196.0+) The connection port of the ADB cluster.
- status String
The status of the resource.
Look up Existing DBCluster Resource
Get an existing DBCluster 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?: DBClusterState, opts?: CustomResourceOptions): DBCluster
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_renew_period: Optional[int] = None,
compute_resource: Optional[str] = None,
connection_string: Optional[str] = None,
db_cluster_category: Optional[str] = None,
db_cluster_class: Optional[str] = None,
db_cluster_version: Optional[str] = None,
db_node_class: Optional[str] = None,
db_node_count: Optional[int] = None,
db_node_storage: Optional[int] = None,
description: Optional[str] = None,
elastic_io_resource: Optional[int] = None,
maintain_time: Optional[str] = None,
mode: Optional[str] = None,
modify_type: Optional[str] = None,
pay_type: Optional[str] = None,
payment_type: Optional[str] = None,
period: Optional[int] = None,
port: Optional[str] = None,
renewal_status: Optional[str] = None,
resource_group_id: Optional[str] = None,
security_ips: Optional[Sequence[str]] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None,
vpc_id: Optional[str] = None,
vswitch_id: Optional[str] = None,
zone_id: Optional[str] = None) -> DBCluster
func GetDBCluster(ctx *Context, name string, id IDInput, state *DBClusterState, opts ...ResourceOption) (*DBCluster, error)
public static DBCluster Get(string name, Input<string> id, DBClusterState? state, CustomResourceOptions? opts = null)
public static DBCluster get(String name, Output<String> id, DBClusterState 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.
- Auto
Renew intPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- Compute
Resource string The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- Connection
String string The connection string of the cluster.
- Db
Cluster stringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- Db
Cluster stringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- Db
Cluster stringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- Db
Node stringClass The db node class. For more information, see DBClusterClass
- Db
Node intCount The db node count.
- Db
Node intStorage The db node storage.
- Description string
The description of DBCluster.
- Elastic
Io intResource The elastic io resource.
- Maintain
Time string The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- Mode string
The mode of the cluster. Valid values:
reserver
,flexible
.- Modify
Type string The modify type.
- Pay
Type string Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- Payment
Type string The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- Period int
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- Port string
(Available in 1.196.0+) The connection port of the ADB cluster.
- Renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- Resource
Group stringId The ID of the resource group.
- Security
Ips List<string> List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- Status string
The status of the resource.
- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- Vpc
Id string The vpc ID of the resource.
- Vswitch
Id string The vswitch id.
- Zone
Id string The zone ID of the resource.
- Auto
Renew intPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- Compute
Resource string The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- Connection
String string The connection string of the cluster.
- Db
Cluster stringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- Db
Cluster stringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- Db
Cluster stringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- Db
Node stringClass The db node class. For more information, see DBClusterClass
- Db
Node intCount The db node count.
- Db
Node intStorage The db node storage.
- Description string
The description of DBCluster.
- Elastic
Io intResource The elastic io resource.
- Maintain
Time string The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- Mode string
The mode of the cluster. Valid values:
reserver
,flexible
.- Modify
Type string The modify type.
- Pay
Type string Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- Payment
Type string The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- Period int
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- Port string
(Available in 1.196.0+) The connection port of the ADB cluster.
- Renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- Resource
Group stringId The ID of the resource group.
- Security
Ips []string List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- Status string
The status of the resource.
- map[string]interface{}
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- Vpc
Id string The vpc ID of the resource.
- Vswitch
Id string The vswitch id.
- Zone
Id string The zone ID of the resource.
- auto
Renew IntegerPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- compute
Resource String The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- connection
String String The connection string of the cluster.
- db
Cluster StringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- db
Cluster StringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- db
Cluster StringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- db
Node StringClass The db node class. For more information, see DBClusterClass
- db
Node IntegerCount The db node count.
- db
Node IntegerStorage The db node storage.
- description String
The description of DBCluster.
- elastic
Io IntegerResource The elastic io resource.
- maintain
Time String The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- mode String
The mode of the cluster. Valid values:
reserver
,flexible
.- modify
Type String The modify type.
- pay
Type String Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- payment
Type String The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- period Integer
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- port String
(Available in 1.196.0+) The connection port of the ADB cluster.
- renewal
Status String Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group StringId The ID of the resource group.
- security
Ips List<String> List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- status String
The status of the resource.
- Map<String,Object>
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- vpc
Id String The vpc ID of the resource.
- vswitch
Id String The vswitch id.
- zone
Id String The zone ID of the resource.
- auto
Renew numberPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- compute
Resource string The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- connection
String string The connection string of the cluster.
- db
Cluster stringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- db
Cluster stringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- db
Cluster stringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- db
Node stringClass The db node class. For more information, see DBClusterClass
- db
Node numberCount The db node count.
- db
Node numberStorage The db node storage.
- description string
The description of DBCluster.
- elastic
Io numberResource The elastic io resource.
- maintain
Time string The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- mode string
The mode of the cluster. Valid values:
reserver
,flexible
.- modify
Type string The modify type.
- pay
Type string Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- payment
Type string The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- period number
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- port string
(Available in 1.196.0+) The connection port of the ADB cluster.
- renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group stringId The ID of the resource group.
- security
Ips string[] List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- status string
The status of the resource.
- {[key: string]: any}
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- vpc
Id string The vpc ID of the resource.
- vswitch
Id string The vswitch id.
- zone
Id string The zone ID of the resource.
- auto_
renew_ intperiod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- compute_
resource str The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- connection_
string str The connection string of the cluster.
- db_
cluster_ strcategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- db_
cluster_ strclass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- db_
cluster_ strversion The db cluster version. Value options:
3.0
, Default to3.0
.- db_
node_ strclass The db node class. For more information, see DBClusterClass
- db_
node_ intcount The db node count.
- db_
node_ intstorage The db node storage.
- description str
The description of DBCluster.
- elastic_
io_ intresource The elastic io resource.
- maintain_
time str The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- mode str
The mode of the cluster. Valid values:
reserver
,flexible
.- modify_
type str The modify type.
- pay_
type str Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- payment_
type str The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- period int
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- port str
(Available in 1.196.0+) The connection port of the ADB cluster.
- renewal_
status str Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource_
group_ strid The ID of the resource group.
- security_
ips Sequence[str] List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- status str
The status of the resource.
- Mapping[str, Any]
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- vpc_
id str The vpc ID of the resource.
- vswitch_
id str The vswitch id.
- zone_
id str The zone ID of the resource.
- auto
Renew NumberPeriod Auto-renewal period of an cluster, in the unit of the month. It is valid when
payment_type
isSubscription
. Valid values:1
,2
,3
,6
,12
,24
,36
. Default to1
.- compute
Resource String The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
- connection
String String The connection string of the cluster.
- db
Cluster StringCategory The db cluster category. Valid values:
Basic
,Cluster
,MixedStorage
.- db
Cluster StringClass It duplicates with attribute db_node_class and is deprecated from 1.121.2.
It duplicates with attribute db_node_class and is deprecated from 1.121.2.
- db
Cluster StringVersion The db cluster version. Value options:
3.0
, Default to3.0
.- db
Node StringClass The db node class. For more information, see DBClusterClass
- db
Node NumberCount The db node count.
- db
Node NumberStorage The db node storage.
- description String
The description of DBCluster.
- elastic
Io NumberResource The elastic io resource.
- maintain
Time String The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
- mode String
The mode of the cluster. Valid values:
reserver
,flexible
.- modify
Type String The modify type.
- pay
Type String Field
pay_type
has been deprecated. New fieldpayment_type
instead.Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.
- payment
Type String The payment type of the resource. Valid values are
PayAsYouGo
andSubscription
. Default toPayAsYouGo
. Note: Thepayment_type
supports updating from v1.166.0+.- period Number
The duration that you will buy DB cluster (in month). It is valid when
payment_type
isSubscription
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not affect the resource.- port String
(Available in 1.196.0+) The connection port of the ADB cluster.
- renewal
Status String Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group StringId The ID of the resource group.
- security
Ips List<String> List of IP addresses allowed to access all databases of an cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- status String
The status of the resource.
- Map<Any>
A mapping of tags to assign to the resource.
- Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
- Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~30 minutes. Please make full preparation before changing them.
- vpc
Id String The vpc ID of the resource.
- vswitch
Id String The vswitch id.
- zone
Id String The zone ID of the resource.
Import
AnalyticDB for MySQL (ADB) DBCluster can be imported using the id, e.g.
$ pulumi import alicloud:adb/dBCluster:DBCluster example <id>
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.