Queries Tablestore instances.
Syntax
{
"Type": "DATASOURCE::OTS::Instances",
"Properties": {
"Status": String,
"InstanceName": String,
"RefreshOptions": String
}
}
Properties
|
Property |
Type |
Required |
Editable |
Description |
Constraint |
|
Status |
String |
No |
Yes |
The instance status. |
None. |
|
InstanceName |
String |
No |
Yes |
The instance name. |
None. |
|
RefreshOptions |
String |
No |
Yes |
The refresh policy for data source resources when the stack is updated. |
Valid values:
|
Return values (Fn::GetAtt)
-
Instances: the details of the instances.
-
InstanceNames: the names of the instances.
|
Property |
Type |
Description |
Constraint |
|
InstanceNames |
List |
The names of the instances. |
None. |
|
Instances |
List |
The details of the instances. |
None. |
|
InstanceName |
String |
The instance name. |
None. |
|
StorageType |
String |
The storage type. |
None. |
|
ResourceGroupId |
String |
The resource group ID. |
None. |
|
CreateTime |
String |
The time when the instance was created. |
None. |
|
TableQuota |
Number |
The total number of tables. |
None. |
|
VCUQuota |
Number |
The maximum number of tables. |
None. |
|
InstanceSpecification |
String |
The instance type. |
None. |
|
UserId |
String |
The ID of the instance owner. |
None. |
|
InstanceStatus |
String |
The instance status. |
None. |
|
AliasName |
String |
The instance alias. |
None. |
|
Network |
String |
The network type of the instance. |
None. |
|
PaymentType |
String |
The billing method. |
None. |
|
InstanceDescription |
String |
The instance description. |
None. |
|
RegionId |
String |
The region ID. |
None. |
Examples
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"InstanceName": {
"Type": "String",
"Description": "The name of instance."
}
},
"Resources": {
"Instances": {
"Type": "DATASOURCE::OTS::Instances",
"Properties": {
"InstanceName": {
"Ref": "InstanceName"
}
}
}
},
"Outputs": {
"Instances": {
"Description": "The list of instances.",
"Value": {
"Fn::GetAtt": [
"Instances",
"Instances"
]
}
},
"InstanceNames": {
"Description": "The list of instance names.",
"Value": {
"Fn::GetAtt": [
"Instances",
"InstanceNames"
]
}
}
}
}ROSTemplateFormatVersion: '2015-09-01'
Parameters:
InstanceName:
Type: String
Description: The name of instance.
Resources:
Instances:
Type: DATASOURCE::OTS::Instances
Properties:
InstanceName:
Ref: InstanceName
Outputs:
Instances:
Description: The list of instances.
Value:
Fn::GetAtt:
- Instances
- Instances
InstanceNames:
Description: The list of instance names.
Value:
Fn::GetAtt:
- Instances
- InstanceNames