DATASOURCE::EAIS::Instances - Resource Orchestration Service

DATASOURCE::EAIS::Instances is used to query the basic information about created Elastic Accelerated Computing Instances (EAIS) instances.

Syntax

{
  "Type": "DATASOURCE::EAIS::Instances",
  "Properties": {
    "InstanceName": String,
    "ResourceGroupId": String,
    "InstanceId": String,
    "InstanceType": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
InstanceName	String	No	Yes	The name of the EAIS instance.	The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
ResourceGroupId	String	No	Yes	The ID of the resource group to which the EAIS instance belongs.	None.
InstanceId	String	No	Yes	The ID of the EAIS instance.	None.
InstanceType	String	No	Yes	The EAIS instance type.	None.

Return values

Fn::GetAtt

Instances: details of the EAIS instances.
InstanceIds: the IDs of the EAIS instances.

Property	Type	Description	Constraint
InstanceIds	List	The IDs of the EAIS instances.	None.
Instances	List	Details of the EAIS instances.	None.
Status	String	The state of the EAIS instance.	None.
SecurityGroupId	String	The ID of the security group to which the EAIS instance belongs.	None.
InstanceId	String	The ID of the EAIS instance.	None.
RegionId	String	The ID of the region in which the EAIS instance resides.	None.
ZoneId	String	The ID of the zone in which the EAIS instance resides.	None.
ResourceGroupId	String	The ID of the resource group to which the EAIS instance belongs.	None.
`VSwitchId`	String	The ID of the vSwitch to which the EAIS instance is connected.	None.
JupyterUrl	String	The URL that is used to access Jupyter Notebook.	None.
ClientInstanceId	String	The ID of the Elastic Compute Service (ECS) instance or elastic container instance that is associated with the EAIS instance.	None.
InstanceName	String	The name of the EAIS instance.	None.
InstanceType	String	The EAIS instance type.	None.
ClientInstanceType	String	The instance type of the ECS instance or elastic container instance.	None.
ClientInstanceName	String	The name of the ECS instance or elastic container instance.	None.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ResourceGroupId:
    Description: The ID of the resource group.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      ResourceGroupId:
        Ref: ResourceGroupId
    Type: DATASOURCE::EAIS::Instances
Outputs:
  InstanceIds:
    Description: The list of instance IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceIds
  Instances:
    Description: The list of instances.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Instances

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ResourceGroupId": {
      "Type": "String",
      "Description": "The ID of the resource group."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EAIS::Instances",
      "Properties": {
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        }
      }
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "The list of instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "The list of instance IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}