ElasticDBInstanceProps
Properties for defining a ElasticDBInstance.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-gpdb-elasticdbinstance
Initializer
using AlibabaCloud.SDK.ROS.CDK.Gpdb;
new ElasticDBInstanceProps {
object EngineVersion,
object InstanceSpec,
object SegNodeNum,
object SegStorageType,
object StorageSize,
object VSwitchId,
object ZoneId,
object BackupId = null,
object DbInstanceCategory = null,
object DbInstanceDescription = null,
object DbInstanceMode = null,
object EncryptionKey = null,
object EncryptionType = null,
object MasterNodeNum = null,
object PayType = null,
object Period = null,
object PeriodUnit = null,
object PrivateIpAddress = null,
object SecurityIpList = null,
object SrcDbInstanceName = null,
TagsProperty[] Tags = null,
object VpcId = null
};
Properties
| Name | Type | Description |
|---|---|---|
EngineVersion | object | Property engineVersion: The version of the database engine. |
InstanceSpec | object | Property instanceSpec: The specification of segment nodes. |
SegNodeNum | object | Property segNodeNum: The number of segment nodes. |
SegStorageType | object | Property segStorageType: The disk type of segment nodes. |
StorageSize | object | Property storageSize: The storage capacity of per segment node. |
VSwitchId | object | Property vSwitchId: The vSwitch ID. |
ZoneId | object | Property zoneId: The zone ID of the instance, such as cn-hangzhou-d. |
BackupId | object | Property backupId: Backup set ID. |
DbInstanceCategory | object | Property dbInstanceCategory: The instance edition. |
DbInstanceDescription | object | Property dbInstanceDescription: The description of the instance. |
DbInstanceMode | object | Property dbInstanceMode: The db instance mode. |
EncryptionKey | object | Property encryptionKey: If the EncryptionType parameter is set to CloudDisk, you must specify this parameter to the encryption key that is in the same region with the disks that is specified by the EncryptionType parameter. |
EncryptionType | object | Property encryptionType: The type of the encryption. |
MasterNodeNum | object | Property masterNodeNum: The number of master nodes. |
PayType | object | Property payType: The billing method of the instance. |
Period | object | Property period: The subscription period. |
PeriodUnit | object | Property periodUnit: Unit of subscription period, it could be Month\/Year. |
PrivateIpAddress | object | Property privateIpAddress: This parameter is deprecated. |
SecurityIpList | object | Property securityIpList: The IP address whitelist for the instance. |
SrcDbInstanceName | object | Property srcDbInstanceName: Clone source instance ID. |
Tags | TagsProperty[] | Property tags: The list of instance tags in the form of key\/value pairs. |
VpcId | object | Property vpcId: The VPC ID of the instance. |
EngineVersionRequired
public object EngineVersion { get; set; }
- Type: object
Property engineVersion: The version of the database engine.
For example: 6.0、7.0
InstanceSpecRequired
public object InstanceSpec { get; set; }
- Type: object
Property instanceSpec: The specification of segment nodes.
For example: 2C16G, 4C32G, 16C128G.
SegNodeNumRequired
public object SegNodeNum { get; set; }
- Type: object
Property segNodeNum: The number of segment nodes.
For the high availability version, the value ranges from 4 to 512. The basic version ranges from 2 to 512.
SegStorageTypeRequired
public object SegStorageType { get; set; }
- Type: object
Property segStorageType: The disk type of segment nodes.
For example: cloud_essd, cloud_efficiency.
StorageSizeRequired
public object StorageSize { get; set; }
- Type: object
Property storageSize: The storage capacity of per segment node.
Unit: GB. Minimum is 50, max is 4000, step is 50.
VSwitchIdRequired
public object VSwitchId { get; set; }
- Type: object
Property vSwitchId: The vSwitch ID.
- This parameter is required.
- The vSwitch must be in the zone specified by
ZoneId.
ZoneIdRequired
public object ZoneId { get; set; }
- Type: object
Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.
You can call the DescribeRegions operation to query the most recent zone list.
BackupIdOptional
public object BackupId { get; set; }
- Type: object
Property backupId: Backup set ID.
You can call DescribeDataBackups to view the backup set IDs of all backup sets under the target instance.
DbInstanceCategoryOptional
public object DbInstanceCategory { get; set; }
- Type: object
Property dbInstanceCategory: The instance edition.
Valid values:
- HighAvailability: High-availability Edition
- Basic: Basic Edition
This parameter is required for instances in elastic storage mode.
DbInstanceDescriptionOptional
public object DbInstanceDescription { get; set; }
- Type: object
Property dbInstanceDescription: The description of the instance.
The description cannot exceed 256 characters in length.
DbInstanceModeOptional
public object DbInstanceMode { get; set; }
- Type: object
Property dbInstanceMode: The db instance mode.
Valid values: StorageElastic, Serverless, Classic.
EncryptionKeyOptional
public object EncryptionKey { get; set; }
- Type: object
Property encryptionKey: If the EncryptionType parameter is set to CloudDisk, you must specify this parameter to the encryption key that is in the same region with the disks that is specified by the EncryptionType parameter.
Otherwise, leave this parameter empty.
EncryptionTypeOptional
public object EncryptionType { get; set; }
- Type: object
Property encryptionType: The type of the encryption.
Default value: NULL. Valid values: NULL: Encryption is disabled. CloudDisk: Encryption is enabled on disks and the encryption key is specified by using the EncryptionKey parameter. Note: Disk encryption cannot be disabled after it is enabled.
MasterNodeNumOptional
public object MasterNodeNum { get; set; }
- Type: object
Property masterNodeNum: The number of master nodes.
Minimum is 1, max is 2.
PayTypeOptional
public object PayType { get; set; }
- Type: object
Property payType: The billing method of the instance.
Default value: Postpaid. Valid values: Postpaid: pay-as-you-go Prepaid: subscription
PeriodOptional
public object Period { get; set; }
- Type: object
Property period: The subscription period.
While choose by pay by month, it could be from 1 to 11. While choose pay by year, it could be from 1 to 3.
PeriodUnitOptional
public object PeriodUnit { get; set; }
- Type: object
Property periodUnit: Unit of subscription period, it could be Month\/Year.
Default value is Month.
PrivateIpAddressOptional
public object PrivateIpAddress { get; set; }
- Type: object
Property privateIpAddress: This parameter is deprecated.
SecurityIpListOptional
public object SecurityIpList { get; set; }
- Type: object
Property securityIpList: The IP address whitelist for the instance.
A value of 127.0.0.1 blocks all external access. After you create the instance, you can call the ModifySecurityIps operation to modify the IP address whitelist.
SrcDbInstanceNameOptional
public object SrcDbInstanceName { get; set; }
- Type: object
Property srcDbInstanceName: Clone source instance ID.
You can call the DescribeDBInstances interface to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.
TagsOptional
public TagsProperty[] Tags { get; set; }
- Type: TagsProperty[]
Property tags: The list of instance tags in the form of key\/value pairs.
You can define a maximum of 20 tags for instance.
VpcIdOptional
public object VpcId { get; set; }
- Type: object
Property vpcId: The VPC ID of the instance.
If you set the InstanceNetworkType parameter to VPC, you must also specify the VPCId parameter. The specified region of the VPC must be the same as the RegionId value.