DATASOURCE::OTS::Instances is used to query Tablestore instances.

Syntax

{
  "Type": "DATASOURCE::OTS::Instances",
  "Properties": {
    "Status": String,
    "InstanceName": String
  }
}

Properties

Property Type Required Editable Description Constraint
Status String No Yes The status of the instance. None.
InstanceName String No Yes The name of the instance. None.

Return values (Fn::GetAtt)

  • Instances: details of the instances.
  • InstanceNames: the names of the instances.
Property Type Description Constraint
InstanceNames List The names of the instances. None.
Instances List Details of the instances. None.
InstanceName String The name of the instance. None.
StorageType String The storage type. None.
ResourceGroupId String The ID of the resource group. None.
CreateTime String The time when the instance was created. None.
TableQuota Number The total number of tables. None.
VCUQuota Number The VCU quota of the instance. None.
InstanceSpecification String The specification of the instance. None.
UserId String The ID of the user that owns the instance. None.
InstanceStatus String The status of the instance. None.
AliasName String The alias of the instance. None.
Network String The network type of the instance. None.
PaymentType String The payment method. None.
InstanceDescription String The description of the instance. None.
RegionId String The region ID of the instance. None.

Examples

  • JSON format 

    {
  "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"
        ]
      }
    }
  }
}

  • YAML format 

    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