DATASOURCE::PolarDBX::Account - Resource Orchestration Service

DATASOURCE::PolarDBX::Account is used to query the information about a PolarDB for Xscale (PolarDB-X) account.

Syntax

{
  "Type": "DATASOURCE::PolarDBX::Account",
  "Properties": {
    "DBInstanceId": String,
    "PolarDBXAccountName": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
DBInstanceId	String	Yes	Yes	The ID of the PolarDB-X instance.	None.
PolarDBXAccountName	String	Yes	Yes	The name of the PolarDB-X account.	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

PolarDBXAccountName: the name of the PolarDB-X account.
AccountDescription: the description of the PolarDB-X account.
DBInstanceId: the ID of the PolarDB-X instance.
CreateTime: the time when the PolarDB-X account was created.
AccountType: the type of the PolarDB-X account.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PolarDBXAccountName:
    Type: String
    Description:
      en: The username of the account that you want to query. If you want to query information about a specific account, you must specify this parameter.
    Required: true
  DBInstanceId:
    Type: String
    Description:
      en: The ID of the PolarDB-X 2.0 instance.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PolarDBX::Account
    Properties:
      PolarDBXAccountName:
        Ref: PolarDBXAccountName
      DBInstanceId:
        Ref: DBInstanceId
Outputs:
  PolarDBXAccountName:
    Description: The username of the account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PolarDBXAccountName
  AccountDescription:
    Description: The description of the account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AccountDescription
  DBInstanceId:
    Description: The ID of the PolarDB-X 2.0 instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceId
  CreateTime:
    Description: The point in time when the account was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  AccountType:
    Description: The type of the account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AccountType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PolarDBXAccountName": {
      "Type": "String",
      "Description": {
        "en": "The username of the account that you want to query. If you want to query information about a specific account, you must specify this parameter."
      },
      "Required": true
    },
    "DBInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the PolarDB-X 2.0 instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PolarDBX::Account",
      "Properties": {
        "PolarDBXAccountName": {
          "Ref": "PolarDBXAccountName"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "PolarDBXAccountName": {
      "Description": "The username of the account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PolarDBXAccountName"
        ]
      }
    },
    "AccountDescription": {
      "Description": "The description of the account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccountDescription"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "The ID of the PolarDB-X 2.0 instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The point in time when the account was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "AccountType": {
      "Description": "The type of the account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccountType"
        ]
      }
    }
  }
}