How to use DATASOURCE::PaiDswApi::Instances to query information about DSW instances - Resource Orchestration Service

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
InstanceName	String	No	Yes	The instance name.	The name must meet the following requirements: The name 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 instance ID.	None.
WorkspaceId	String	No	Yes	The workspace ID.	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.
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.	None.
WorkspaceId	String	The workspace ID.	None.
Accessibility	String	The accessibility of the workspace.	None.
Status	String	The status of the instance.	None.
InstanceId	String	The instance ID.	None.
UserVpc	String	The virtual private cloud (VPC) configurations.	None.
ImageUrl	String	The image URL.	None.
Datasets	String	The datasets.	None.
EcsSpec	String	The Elastic Compute Service (ECS) instance type.	None.
InstanceName	String	The instance name.	None.
PaymentType	String	The payment type of the instance.	None.

Examples

YAML

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

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