ALIYUN::Hologram::Instance is used to create a Hologres instance.
Syntax
{
"Type": "ALIYUN::Hologram::Instance",
"Properties": {
"ColdStorageSize": Integer,
"ResourceGroupId": String,
"ZoneId": String,
"ProductCode": String,
"PricingCycle": String,
"ScaleType": String,
"StorageSize": Integer,
"Cpu": Integer,
"Duration": Integer,
"AutoPay": Boolean,
"Endpoints": List,
"InstanceName": String,
"GatewayCount": Integer,
"PaymentType": String,
"InstanceType": String,
"Tags": List,
"LeaderInstanceId": String,
"InitialDatabases": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
ColdStorageSize | Integer | No | Yes | The infrequent access (IA) storage space of the instance. | Unit: GB. Note This property is invalid for pay-as-you-go instances. |
ResourceGroupId | String | No | Yes | The ID of the resource group. | If you leave this property empty, the default resource group within your account is used. |
ZoneId | String | Yes | No | The zone ID. | For more information, see the "Operation Description" section of the CreateInstance topic. |
ProductCode | String | No | No | The product code. | Valid values:
|
PricingCycle | String | No | No | The billing cycle. | Valid values:
|
ScaleType | String | No | No | The specification change type. | Valid values:
|
StorageSize | Integer | No | Yes | The standard storage space of the instance. | Unit: GB. Note This property is invalid for pay-as-you-go instances. |
Cpu | Integer | No | Yes | The instance specifications. | The following types of instance specifications are supported:
Note Specify the number of vCPUs for this property. If you want to set this property to instance specifications that have larger than 1,024 GB of memory, you must submit a ticket. You do not need to specify this property when you create a shared instance. The instance specifications of 8 vCPUs and 32 GB of memory (number of compute nodes: 1) are suitable only for trial use and cannot be used in a production environment. |
Duration | Integer | No | No | The subscription duration. | You do not need to specify this property for pay-as-you-go instances. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, and 60. |
AutoPay | Boolean | No | No | Specifies whether to enable automatic payment. | Valid values:
Note If your account balance is insufficient, you can set AutoPay to false. In this case, an unpaid order is generated. You can log on to the User Center to pay for the order. |
Endpoints | List | Yes | Yes | The endpoints. | For more information, see Endpoints properties. |
InstanceName | String | Yes | Yes | The instance name. | The instance name must be 2 to 64 characters in length. |
GatewayCount | Integer | No | Yes | The number of gateways. | Valid values: 2 to 50. Note You must specify this property only when InstanceType is set to Warehouse. |
PaymentType | String | Yes | No | The billing method of the instance. |
|
InstanceType | String | Yes | No | The type of the instance. | Valid values:
|
Tags | List | No | Yes | The tags of the instance. | You can add up to 20 tags. For more information, see Tags properties. |
LeaderInstanceId | String | No | No | The ID of the primary instance. | None. |
InitialDatabases | String | No | No | The names of the databases that are split after the database is initialized. | Separate the database names with commas (,). |
Endpoints syntax
"Endpoints": [
{
"Type": String,
"Endpoint": String,
"VpcId": String,
"VSwitchId": String,
"Enabled": Boolean,
"VpcInstanceId": String,
"AlternativeEndpoints": String
}
]
Endpoints properties
Property | Type | Required | Editable | Description | Constraint |
Type | String | No | Yes | The network type. | Valid values:
|
Endpoint | String | No | No | The endpoint. | Example: |
VpcId | String | Yes | Yes | The VPC ID. | Example: |
VSwitchId | String | Yes | Yes | The vSwitch ID. | None. |
Enabled | Boolean | No | No | Specifies whether to enable endpoints. | Valid values:
|
VpcInstanceId | String | No | No | The VPC ID of the instance. | Example: |
AlternativeEndpoints | String | No | No | The alternative endpoints. | AnyTunnel and SingleTunnel modes are enabled for specific existing instances. When the instances are changed from the AnyTunnel mode to the SingleTunnel mode, the endpoints of both modes are saved. You can use this property to specify the endpoints. |
Tags syntax
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
Value | String | No | No | The tag value. | None. |
Key | String | Yes | No | The tag key. | None. |
Return values
Fn::GetAtt
ColdStorageSize: the IA storage space of the instance.
ResourceGroupId: the ID of the resource group.
SuspendReason: the reason for the suspension.
ZoneId: the zone ID.
InstanceId: the instance ID.
Memory: the memory size.
InstanceOwner: the owner of the instance.
CreateTime: the time when the instance was created.
Cpu: the number of vCPUs.
StorageSize: the standard storage space of the instance.
EnableHiveAccess: indicates whether data lake acceleration is enabled.
ExpirationTime: the expiration time. This property is invalid for pay-as-you-go instances.
GatewayCpu: the CPU resources of the gateway.
Endpoints: the endpoints.
InstanceName: the instance name.
ComputeNodeCount: the number of compute nodes.
GatewayCount: the number of gateways.
AutoRenewal: indicates whether auto-renewal is enabled.
Version: the version of the instance.
CommodityCode: the commodity code.
GatewayMemory: the memory resources of the gateway.
PaymentType: the billing method of the instance.
InstanceType: the type of the instance.
Tags: the tags of the instance.