DATASOURCE::EAIS::Instance - Resource Orchestration Service

DATASOURCE::EAIS::Instance is used to query the information about a created Elastic Accelerated Computing Instances (EAIS) instance.

Syntax

{
  "Type": "DATASOURCE::EAIS::Instance",
  "Properties": {
    "InstanceId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

InstanceId

String

Yes

The ID of the EAIS instance.

None.

RefreshOptions

String

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

InstanceName: the name of the EAIS instance.
ClientInstanceType: the instance type of the Elastic Compute Service (ECS) instance or elastic container instance that is associated with the EAIS instance.
ClientInstanceName: the name of the ECS instance or elastic container instance that is associated with the EAIS instance.
ZoneId: the zone of the EAIS instance.
ResourceGroupId: the ID of the resource group to which the EAIS instance belongs.
InstanceId: the ID of the EAIS instance.
SecurityGroupId: the ID of the security group to which the EAIS instance belongs.
VSwitchId: the ID of the vSwitch to which the EAIS instance is connected.
CreateTime: the time when the EAIS instance was created.
ClientInstanceId: the ID of the ECS instance or elastic container instance that is associated with the EAIS instance.
InstanceType: the instance type of the EAIS instance.
JupyterUrl: the URL that is used to access Jupyter Notebook.

Examples

`YAML` format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Description:
      en: Elastic accelerated instance ID.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      InstanceId:
        Ref: InstanceId
    Type: DATASOURCE::EAIS::Instance
Outputs:
  ClientInstanceId:
    Description: The ID of the ECS instance to be bound.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ClientInstanceId
  ClientInstanceName:
    Description: The name of the ECS instance bound to the EAIS instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ClientInstanceName
  ClientInstanceType:
    Description: The type of the ECS instance bound to the EAIS instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ClientInstanceType
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  InstanceId:
    Description: Elastic accelerated instance ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceId
  InstanceName:
    Description: Name of the instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceName
  InstanceType:
    Description: EAIS instance type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceType
  JupyterUrl:
    Description: The address of the Eais Notebook.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - JupyterUrl
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ResourceGroupId
  SecurityGroupId:
    Description: Security group ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityGroupId
  VSwitchId:
    Description: Switch ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VSwitchId
  ZoneId:
    Description: The ID of the region to which the EAIS instance belongs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ZoneId

`JSON` format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "Elastic accelerated instance ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EAIS::Instance",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "InstanceName": {
      "Description": "Name of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceName"
        ]
      }
    },
    "ClientInstanceType": {
      "Description": "The type of the ECS instance bound to the EAIS instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ClientInstanceType"
        ]
      }
    },
    "ClientInstanceName": {
      "Description": "The name of the ECS instance bound to the EAIS instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ClientInstanceName"
        ]
      }
    },
    "ZoneId": {
      "Description": "The ID of the region to which the EAIS instance belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "InstanceId": {
      "Description": "Elastic accelerated instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "Security group ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityGroupId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "Switch ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "ClientInstanceId": {
      "Description": "The ID of the ECS instance to be bound.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ClientInstanceId"
        ]
      }
    },
    "InstanceType": {
      "Description": "EAIS instance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceType"
        ]
      }
    },
    "JupyterUrl": {
      "Description": "The address of the Eais Notebook.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "JupyterUrl"
        ]
      }
    }
  }
}