All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::PAI::WorkspaceResourceFlink

Last Updated:Oct 09, 2024

DATASOURCE::PAI::WorkspaceResourceFlink is used to query the information about a Realtime Compute for Apache Flink resource that is associated with a workspace.

Syntax

{
  "Type": "DATASOURCE::PAI::WorkspaceResourceFlink",
  "Properties": {
    "GroupName": String,
    "WorkspaceId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

GroupName

String

Yes

Yes

The resource name.

None.

WorkspaceId

String

Yes

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

  • IsDefault: indicates whether the resource is the default one.

  • GroupName: the name of the resource group.

  • CreateTime: the time when the resource was created. The time follows the ISO 8601 standard. The time is displayed in UTC.

  • Resources: details of the resource.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupName:
    Type: String
    Description:
      en: Resource group name. If you want to obtain a resource group name, see [ListResources].
    Required: true
  WorkspaceId:
    Type: String
    Description:
      en: The ID of the workspace to which the workspace belongs.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PAI::WorkspaceResourceFlink
    Properties:
      GroupName:
        Ref: GroupName
      WorkspaceId:
        Ref: WorkspaceId
Outputs:
  IsDefault:
    Description: Indicates whether it is the default resource. Currently, this parameter only supports the input of true and does not support false.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IsDefault
  GroupName:
    Description: Resource group name. If you want to obtain a resource group name, see [ListResources].
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GroupName
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  Resources:
    Description: Resource List.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Resources
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupName": {
      "Type": "String",
      "Description": {
        "en": "Resource group name. If you want to obtain a resource group name, see [ListResources]."
      },
      "Required": true
    },
    "WorkspaceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the workspace to which the workspace belongs."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PAI::WorkspaceResourceFlink",
      "Properties": {
        "GroupName": {
          "Ref": "GroupName"
        },
        "WorkspaceId": {
          "Ref": "WorkspaceId"
        }
      }
    }
  },
  "Outputs": {
    "IsDefault": {
      "Description": "Indicates whether it is the default resource. Currently, this parameter only supports the input of true and does not support false.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IsDefault"
        ]
      }
    },
    "GroupName": {
      "Description": "Resource group name. If you want to obtain a resource group name, see [ListResources].",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GroupName"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Resources": {
      "Description": "Resource List.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Resources"
        ]
      }
    }
  }
}