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,
"RefreshOptions": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
InstanceName | String | No | Yes | The instance name. | The format of the name must meet the following requirements:
|
Accessibility | String | No | Yes | The accessibility of the workspace. | Valid values:
|
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:
|
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 address of the image. | None. |
Datasets | String | The collection of 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
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
{
"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"
]
}
}
}
}