DATASOURCE::PolarDBX::Database is used to query the information about a PolarDB for Xscale (PolarDB-X) database.
Syntax
{
"Type": "DATASOURCE::PolarDBX::Database",
"Properties": {
"DBInstanceId": String,
"PolarDBXDatabaseName": String,
"RefreshOptions": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
DBInstanceId | String | Yes | Yes | The ID of the PolarDB-X instance. | None. |
PolarDBXDatabaseName | String | Yes | Yes | The name of the PolarDB-X database. | None. |
RefreshOptions | String | No | Yes | The refresh policy for data source resources when the stack is updated. | Valid values:
|
Return values
Fn::GetAtt
CharacterSetName: the character set.
DBInstanceId: the ID of the PolarDB-X instance.
PolarDBXDatabaseName: the name of the PolarDB-X database.
DatabaseDescription: the description of the PolarDB-X database.
Accounts: the accounts.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
DBInstanceId:
Type: String
Description:
en: The ID of the PolarDB-X 2.0 instance.
Required: true
PolarDBXDatabaseName:
Type: String
Description:
en: The name of the PolarDB-X 2.0 instance.
Required: true
Resources:
ExtensionDataSource:
Type: DATASOURCE::PolarDBX::Database
Properties:
DBInstanceId:
Ref: DBInstanceId
PolarDBXDatabaseName:
Ref: PolarDBXDatabaseName
Outputs:
CharacterSetName:
Description: The character set that is supported by the database.
Value:
Fn::GetAtt:
- ExtensionDataSource
- CharacterSetName
DBInstanceId:
Description: The ID of the PolarDB-X 2.0 instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceId
PolarDBXDatabaseName:
Description: The name of the PolarDB-X instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- PolarDBXDatabaseName
DatabaseDescription:
Description: The description of the database.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DatabaseDescription
Accounts:
Description: The list of accounts that can be used to access the database.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Accounts
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"DBInstanceId": {
"Type": "String",
"Description": {
"en": "The ID of the PolarDB-X 2.0 instance."
},
"Required": true
},
"PolarDBXDatabaseName": {
"Type": "String",
"Description": {
"en": "The name of the PolarDB-X 2.0 instance."
},
"Required": true
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::PolarDBX::Database",
"Properties": {
"DBInstanceId": {
"Ref": "DBInstanceId"
},
"PolarDBXDatabaseName": {
"Ref": "PolarDBXDatabaseName"
}
}
}
},
"Outputs": {
"CharacterSetName": {
"Description": "The character set that is supported by the database.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"CharacterSetName"
]
}
},
"DBInstanceId": {
"Description": "The ID of the PolarDB-X 2.0 instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceId"
]
}
},
"PolarDBXDatabaseName": {
"Description": "The name of the PolarDB-X instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"PolarDBXDatabaseName"
]
}
},
"DatabaseDescription": {
"Description": "The description of the database.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DatabaseDescription"
]
}
},
"Accounts": {
"Description": "The list of accounts that can be used to access the database.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Accounts"
]
}
}
}
}