Skip to content

DBInstanceProps

Properties for defining a DBInstance.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkgpdb"
&alicloudroscdkgpdb.DBInstanceProps {
    EngineVersion: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
    AiNodeSpecInfos: interface{},
    BackupId: interface{},
    CacheStorageSize: interface{},
    CreateSampleData: interface{},
    DbInstanceCategory: interface{},
    DbInstanceClass: interface{},
    DbInstanceDescription: interface{},
    DbInstanceGroupCount: interface{},
    DbInstanceMode: interface{},
    DeployMode: interface{},
    EnableSsl: interface{},
    EncryptionKey: interface{},
    EncryptionType: interface{},
    IdleTime: interface{},
    InstanceSpec: interface{},
    MasterAiSpec: interface{},
    MasterCu: interface{},
    MasterNodeNum: interface{},
    PayType: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    PrivateIpAddress: interface{},
    ProdType: interface{},
    ResourceGroupId: interface{},
    SecurityIpList: interface{},
    SegDiskPerformanceLevel: interface{},
    SegNodeNum: interface{},
    SegStorageType: interface{},
    ServerlessMode: interface{},
    ServerlessResource: interface{},
    SrcDbInstanceName: interface{},
    StandbyVSwitchId: interface{},
    StandbyZoneId: interface{},
    StorageSize: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkgpdb.RosDBInstance.TagsProperty,
    VectorConfigurationStatus: interface{},
    VpcId: interface{},
}

Properties

Name Type Description
EngineVersion interface{} Property engineVersion: The version of the database engine.
VSwitchId interface{} Property vSwitchId: The vSwitch ID.
ZoneId interface{} Property zoneId: The zone ID of the instance, such as cn-hangzhou-d.
AiNodeSpecInfos interface{} Property aiNodeSpecInfos: AI node spec infos.
BackupId interface{} Property backupId: Backup set ID.
CacheStorageSize interface{} Property cacheStorageSize: The cache size for a serverless instance, in GB.
CreateSampleData interface{} Property createSampleData: Whether to load the sample data set after the instance is created.
DbInstanceCategory interface{} Property dbInstanceCategory: The instance edition.
DbInstanceClass interface{} Property dbInstanceClass: The instance type.
DbInstanceDescription interface{} Property dbInstanceDescription: The description of the instance.
DbInstanceGroupCount interface{} Property dbInstanceGroupCount: The number of compute groups.
DbInstanceMode interface{} Property dbInstanceMode: The db instance mode.
DeployMode interface{} Property deployMode: The deployment mode.
EnableSsl interface{} Property enableSsl: Whether to enable SSL encryption.
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.
IdleTime interface{} Property idleTime: The period of inactivity, in seconds, after which the instance is considered idle.
InstanceSpec interface{} Property instanceSpec: The instance type for the compute nodes.
MasterAiSpec interface{} Property masterAiSpec: If you need to change the Master node to MasterAI node, specify this parameter.
MasterCu interface{} Property masterCu: The resources for the coordinator node.
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.
ProdType interface{} Property prodType: Prod type.
ResourceGroupId interface{} Property resourceGroupId: The ID of the resource group.
SecurityIpList interface{} Property securityIpList: The IP address whitelist for the instance.
SegDiskPerformanceLevel interface{} Property segDiskPerformanceLevel: The performance level of the ESSDs.
SegNodeNum interface{} Property segNodeNum: Calculate the number of nodes.
SegStorageType interface{} Property segStorageType: The disk type of segment nodes.
ServerlessMode interface{} Property serverlessMode: Mode of the Serverless instance.
ServerlessResource interface{} Property serverlessResource: The threshold for computing resources, in AnalyticDB Compute Units (ACUs).
SrcDbInstanceName interface{} Property srcDbInstanceName: Clone source instance ID.
StandbyVSwitchId interface{} Property standbyVSwitchId: The ID of the vSwitch in the standby zone.
StandbyZoneId interface{} Property standbyZoneId: The ID of the standby zone.
StorageSize interface{} Property storageSize: The storage capacity for the instance, in GB.
Tags *[]TagsProperty Property tags: The list of instance tags in the form of key\/value pairs.
VectorConfigurationStatus interface{} Property vectorConfigurationStatus: the status of vector configuration.
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


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.


AiNodeSpecInfosOptional

AiNodeSpecInfos interface{}
  • Type: interface{}

Property aiNodeSpecInfos: AI node spec infos.


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.


CacheStorageSizeOptional

CacheStorageSize interface{}
  • Type: interface{}

Property cacheStorageSize: The cache size for a serverless instance, in GB.


CreateSampleDataOptional

CreateSampleData interface{}
  • Type: interface{}

Property createSampleData: Whether to load the sample data set after the instance is created.

The value can be: true: load the sample dataset. false: not to load the sample dataset


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.


DbInstanceClassOptional

DbInstanceClass interface{}
  • Type: interface{}

Property dbInstanceClass: The instance type.

For more information, see the description of the DBInstanceClass parameter.

This parameter is required for instances in reserved storage mode.


DbInstanceDescriptionOptional

DbInstanceDescription interface{}
  • Type: interface{}

Property dbInstanceDescription: The description of the instance.

The description cannot exceed 256 characters in length.


DbInstanceGroupCountOptional

DbInstanceGroupCount interface{}
  • Type: interface{}

Property dbInstanceGroupCount: The number of compute groups.

Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, and 128.

This parameter is required for instances in reserved storage mode.


DbInstanceModeOptional

DbInstanceMode interface{}
  • Type: interface{}

Property dbInstanceMode: The db instance mode.

Valid values: StorageElastic, Serverless, Classic.


DeployModeOptional

DeployMode interface{}
  • Type: interface{}

Property deployMode: The deployment mode.

Valid values:

  • multiple: multi-AZ deployment.
  • single: single-AZ deployment.
  • If this parameter is not specified, the default value is single.
  • Defaults to single (single-AZ deployment), which is the only mode currently supported.

EnableSslOptional

EnableSsl interface{}
  • Type: interface{}

Property enableSsl: Whether to enable SSL encryption.

Valid values: true: Enable SSL encryption. false (default): Do not enable SSL encryption.


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.


IdleTimeOptional

IdleTime interface{}
  • Type: interface{}

Property idleTime: The period of inactivity, in seconds, after which the instance is considered idle.

Minimum value: 60. Default value: 600.

This parameter is required only for serverless instances that use auto-scheduling.


InstanceSpecOptional

InstanceSpec interface{}
  • Type: interface{}

Property instanceSpec: The instance type for the compute nodes.

Valid values for a High-availability Edition instance in elastic storage mode:

  • 2C16G
  • 4C32G
  • 16C128G Valid values for a Basic Edition instance in elastic storage mode:
  • 2C8G
  • 4C16G
  • 8C32G
  • 16C64G Valid values for a serverless instance:
  • 4C16G
  • 8C32G

This parameter is required for instances in elastic storage mode or serverless mode.


MasterAiSpecOptional

MasterAiSpec interface{}
  • Type: interface{}

Property masterAiSpec: If you need to change the Master node to MasterAI node, specify this parameter.

This parameter cannot be specified at the same time as MasterCU. Only some regions and availability zones support changing the Master node to MasterAI node. Only Basic edition instances of AnalyticDB PostgreSQL 7.0 support MasterAI nodes. You can query all possible values of this parameter on the Master node reconfiguration sales page.


MasterCuOptional

MasterCu interface{}
  • Type: interface{}

Property masterCu: The resources for the coordinator node.

Valid values:

  • 2 CU
  • 4 CU
  • 8 CU
  • 16 CU
  • 32 CU

You are charged for coordinator node resources of 8 CUs or more.


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.


ProdTypeOptional

ProdType interface{}
  • Type: interface{}

Property prodType: Prod type.

The value can be: standard, cost-effective. The default value is standard.


ResourceGroupIdOptional

ResourceGroupId interface{}
  • Type: interface{}

Property resourceGroupId: The ID of the resource group.


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.


SegDiskPerformanceLevelOptional

SegDiskPerformanceLevel interface{}
  • Type: interface{}

Property segDiskPerformanceLevel: The performance level of the ESSDs.

Valid values:

  • pl0: PL0
  • pl1: PL1
  • pl2: PL2
  • This parameter applies only if the segment node storage type is ESSD.
  • If this parameter is not specified, pl1 is used by default.

SegNodeNumOptional

SegNodeNum interface{}
  • Type: interface{}

Property segNodeNum: Calculate the number of nodes.

The value can be:

  • When DBInstanceMode is StorageElastic and DBInstanceCategory is HighAvailability, the value ranges from 4 to 512. The value must be a multiple of 4.
  • When DBInstanceMode is StorageElastic and DBInstanceCategory is Basic, the value ranges from 2 to 512. The value must be a multiple of 2.
  • When DBInstanceMode is Serverless, The value ranges from 2 to 512. The value must be a multiple of 2.

SegStorageTypeOptional

SegStorageType interface{}
  • Type: interface{}

Property segStorageType: The disk type of segment nodes.

For example: cloud_essd, cloud_efficiency. This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.


ServerlessModeOptional

ServerlessMode interface{}
  • Type: interface{}

Property serverlessMode: Mode of the Serverless instance.

The value can be: Manual: manual scheduling is the default value. Auto: indicates automatic scheduling.


ServerlessResourceOptional

ServerlessResource interface{}
  • Type: interface{}

Property serverlessResource: The threshold for computing resources, in AnalyticDB Compute Units (ACUs).

The value must be a multiple of 8, ranging from 8 to 32. The default value is 32.

This parameter is required only for serverless instances that use auto-scheduling.


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.


StandbyVSwitchIdOptional

StandbyVSwitchId interface{}
  • Type: interface{}

Property standbyVSwitchId: The ID of the vSwitch in the standby zone.

  • This parameter is required only for a multi-AZ deployment.
  • The vSwitch must be in the standby zone specified in StandbyZoneId.

StandbyZoneIdOptional

StandbyZoneId interface{}
  • Type: interface{}

Property standbyZoneId: The ID of the standby zone.

  • This parameter is required only for a multi-AZ deployment.
  • You can call the DescribeRegions operation to query the IDs of available zones.
  • The standby zone must be different from the primary zone.

StorageSizeOptional

StorageSize interface{}
  • Type: interface{}

Property storageSize: The storage capacity for the instance, in GB.

Valid values: .

This parameter is required for instances in elastic storage mode.


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.


VectorConfigurationStatusOptional

VectorConfigurationStatus interface{}
  • Type: interface{}

Property vectorConfigurationStatus: the status of vector configuration.

The value can be:Y: Turn on vector engine optimization.N: Turn off vector engine optimization (default value).


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.