DATASOURCE::PaiDswApi::Instances - Resource Orchestration Service

DATASOURCE::PaiDswApi::Instances is used to query the basic information about Data Science Workshop (DSW) instances.

Syntax

{
  "Type": "DATASOURCE::PaiDswApi::Instances",
  "Properties": {
    "InstanceName": String,
    "Accessibility": String,
    "InstanceId": String,
    "WorkspaceId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
InstanceName	String	No	Yes	The name of the instance.	The name must meet the following format requirements: It can contain only letters, digits, and underscores (_). It can be up to 27 characters in length.
Accessibility	String	No	Yes	The accessibility of the workspace.	Valid values: PRIVATE: The workspace can be accessed only by the administrator and you. PUBLIC: The workspace can be accessed by all users.
InstanceId	String	No	Yes	The ID of the instance.	None.
WorkspaceId	String	No	Yes	The ID of the workspace.	None.

Return values

Fn::GetAtt

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

Property	Type	Description	Constraint
InstanceIds	List	The IDs of the instances.	None.
Instances	List	Details of the instances.	None.
Labels	List	The custom tags of the instance.	None.
WorkspaceId	String	The ID of the workspace.	None.
Accessibility	String	The accessibility of the workspace.	None.
Status	String	The state of the instance.	None.
InstanceId	String	The ID of the instance.	None.
UserVpc	String	The virtual private cloud (VPC) configurations of the user.	None.
ImageUrl	String	The URL of the image.	None.
Datasets	String	The collection of datasets.	None.
EcsSpec	String	The Elastic Compute Service (ECS) instance specifications.	None.
InstanceName	String	The name of the instance.	None.
PaymentType	String	The payment type of the instance.	None.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PaiDswApi::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",
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PaiDswApi::Instances"
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "The list of instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "The list of instance IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}