All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::OTS::Instances

Last Updated:Dec 02, 2024

DATASOURCE::OTS::Instances is used to query 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 status of the instance.

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:

  • Never (default): does not refresh data source resources when the stack is updated.

  • Always: refreshes data source resources when the stack is updated.

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 instance name.

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 maximum number of tables.

None.

InstanceSpecification

String

The instance type.

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.

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