Skip to content

ElasticDBInstanceProps

Properties for defining a ElasticDBInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-gpdb-elasticdbinstance

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkgpdb"
&alicloudroscdkgpdb.ElasticDBInstanceProps {
    EngineVersion: interface{},
    InstanceSpec: interface{},
    SegNodeNum: interface{},
    SegStorageType: interface{},
    StorageSize: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
    BackupId: interface{},
    DbInstanceCategory: interface{},
    DbInstanceDescription: interface{},
    DbInstanceMode: interface{},
    EncryptionKey: interface{},
    EncryptionType: interface{},
    MasterNodeNum: interface{},
    PayType: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    PrivateIpAddress: interface{},
    SecurityIpList: interface{},
    SrcDbInstanceName: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkgpdb.RosElasticDBInstance.TagsProperty,
    VpcId: interface{},
}

Properties

Name Type Description
EngineVersion interface{} Property engineVersion: The version of the database engine.
InstanceSpec interface{} Property instanceSpec: The specification of segment nodes.
SegNodeNum interface{} Property segNodeNum: The number of segment nodes.
SegStorageType interface{} Property segStorageType: The disk type of segment nodes.
StorageSize interface{} Property storageSize: The storage capacity of per segment node.
VSwitchId interface{} Property vSwitchId: The vSwitch ID.
ZoneId interface{} Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.
BackupId interface{} Property backupId: Backup set ID.
DbInstanceCategory interface{} Property dbInstanceCategory: The instance edition.
DbInstanceDescription interface{} Property dbInstanceDescription: The description of the instance.
DbInstanceMode interface{} Property dbInstanceMode: The db instance mode.
EncryptionKey interface{} 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 interface{} Property encryptionType: The type of the encryption.
MasterNodeNum interface{} Property masterNodeNum: The number of master nodes.
PayType interface{} Property payType: The billing method of the instance.
Period interface{} Property period: The subscription period.
PeriodUnit interface{} Property periodUnit: Unit of subscription period, it could be Month\/Year.
PrivateIpAddress interface{} Property privateIpAddress: This parameter is deprecated.
SecurityIpList interface{} Property securityIpList: The IP address whitelist for the instance.
SrcDbInstanceName interface{} Property srcDbInstanceName: Clone source instance ID.
Tags *[]TagsProperty Property tags: The list of instance tags in the form of key\/value pairs.
VpcId interface{} Property vpcId: The VPC ID of the instance.

EngineVersionRequired

EngineVersion interface{}
  • Type: interface{}

Property engineVersion: The version of the database engine.

For example: 6.0、7.0


InstanceSpecRequired

InstanceSpec interface{}
  • Type: interface{}

Property instanceSpec: The specification of segment nodes.

For example: 2C16G, 4C32G, 16C128G.


SegNodeNumRequired

SegNodeNum interface{}
  • Type: interface{}

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

SegStorageType interface{}
  • Type: interface{}

Property segStorageType: The disk type of segment nodes.

For example: cloud_essd, cloud_efficiency.


StorageSizeRequired

StorageSize interface{}
  • Type: interface{}

Property storageSize: The storage capacity of per segment node.

Unit: GB. Minimum is 50, max is 4000, step is 50.


VSwitchIdRequired

VSwitchId interface{}
  • Type: interface{}

Property vSwitchId: The vSwitch ID.

  • This parameter is required.
  • The vSwitch must be in the zone specified by ZoneId.

ZoneIdRequired

ZoneId interface{}
  • Type: interface{}

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

BackupId interface{}
  • Type: interface{}

Property backupId: Backup set ID.

You can call DescribeDataBackups to view the backup set IDs of all backup sets under the target instance.


DbInstanceCategoryOptional

DbInstanceCategory interface{}
  • Type: interface{}

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

DbInstanceDescription interface{}
  • Type: interface{}

Property dbInstanceDescription: The description of the instance.

The description cannot exceed 256 characters in length.


DbInstanceModeOptional

DbInstanceMode interface{}
  • Type: interface{}

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.


EncryptionKeyOptional

EncryptionKey interface{}
  • Type: interface{}

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

EncryptionType interface{}
  • Type: interface{}

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

MasterNodeNum interface{}
  • Type: interface{}

Property masterNodeNum: The number of master nodes.

Minimum is 1, max is 2.


PayTypeOptional

PayType interface{}
  • Type: interface{}

Property payType: The billing method of the instance.

Default value: Postpaid. Valid values: Postpaid: pay-as-you-go Prepaid: subscription


PeriodOptional

Period interface{}
  • Type: interface{}

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

PeriodUnit interface{}
  • Type: interface{}

Property periodUnit: Unit of subscription period, it could be Month\/Year.

Default value is Month.


PrivateIpAddressOptional

PrivateIpAddress interface{}
  • Type: interface{}

Property privateIpAddress: This parameter is deprecated.


SecurityIpListOptional

SecurityIpList interface{}
  • Type: interface{}

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

SrcDbInstanceName interface{}
  • Type: interface{}

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

Tags *[]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

VpcId interface{}
  • Type: interface{}

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.