DATASOURCE::RDS::DBInstance
DATASOURCE::RDS::DBInstance類型用于查詢RDS實(shí)例。
語法
{
"Type": "DATASOURCE::RDS::DBInstance",
"Properties": {
"DBInstanceId": String,
"RefreshOptions": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
DBInstanceId | String | 否 | 是 | 實(shí)例ID。 | 無 |
RefreshOptions | String | 否 | 是 | 當(dāng)資源棧更新時(shí),數(shù)據(jù)源資源的刷新策略。 | 有效值:
|
返回值
Fn::GetAtt
DBInstanceMemory:實(shí)例內(nèi)存,單位:MB。
ResourceGroupId:資源組ID。
IncrementSourceDBInstanceId:增量數(shù)據(jù)來源的實(shí)例ID。例如災(zāi)備實(shí)例的增量數(shù)據(jù)來源是主實(shí)例,只讀實(shí)例的增量數(shù)據(jù)來源是主實(shí)例,如果沒有返回此參數(shù)則表示該實(shí)例是主實(shí)例。
MasterZone:主可用區(qū)ID。
Port:內(nèi)網(wǎng)連接端口。
LatestKernelVersion:當(dāng)前實(shí)例支持的最新內(nèi)核版本。
ConsoleVersion:實(shí)例的代理類型。
DBInstanceType:實(shí)例類型。
GeneralGroupName:專屬集群MySQL通用版實(shí)例所屬的組名。
InstanceNetworkType:實(shí)例的網(wǎng)絡(luò)類型。
DBInstanceClassType:實(shí)例規(guī)格族。
AutoUpgradeMinorVersion:實(shí)例升級(jí)小版本的方式。
DBInstanceId:實(shí)例ID。
DBInstanceStorage:實(shí)例存儲(chǔ)空間,單位:GB。
PGBouncerEnabled:PgBouncer開關(guān)。
InstructionSetArch:實(shí)例的架構(gòu)類型。
LockReason:鎖定原因。
AvailabilityValue:實(shí)例可用性狀態(tài),單位:百分比(%)。
Engine:數(shù)據(jù)庫類型。
DBInstanceDescription:實(shí)例備注。
IPType:IP地址類型。當(dāng)前僅支持IPv4。
MaxIOMBPS:最大IO吞吐。單位:MB/s。
DBInstanceDiskUsed:實(shí)例的磁盤使用量,單位:MB。
EngineVersion:數(shù)據(jù)庫版本。
MaxConnections:最大并發(fā)連接數(shù)。
DBInstanceStatus:實(shí)例狀態(tài)。
DBInstanceClass:實(shí)例規(guī)格。
AccountMaxQuantity:可創(chuàng)建賬號(hào)的最大數(shù)量。
VSwitchId:交換機(jī)ID。
TipsLevel:專屬集群MySQL通用版實(shí)例的異常提示等級(jí)。
LockMode:實(shí)例鎖定模式。
DeletionProtection:是否已開啟釋放保護(hù)功能。
PayType:實(shí)例付費(fèi)方式。
GuardDBInstanceId:該實(shí)例如果掛載著災(zāi)備實(shí)例,即為災(zāi)備實(shí)例的ID。
DBClusterNodes:集群節(jié)點(diǎn)相關(guān)信息。
TimeZone:時(shí)區(qū)。
VpcId:VPC ID。
MasterInstanceId:主實(shí)例的ID。
CurrentKernelVersion:當(dāng)前內(nèi)核版本。
CreationTime:創(chuàng)建時(shí)間。格式為yyyy-MM-ddTHH:mm:ssZ(UTC時(shí)間)。
ConnectionMode:實(shí)例的訪問模式。
VpcCloudInstanceId:專有網(wǎng)絡(luò)實(shí)例ID。
ReadonlyInstanceSQLDelayedTime:只讀實(shí)例延遲復(fù)制時(shí)間,只讀實(shí)例延遲ReadonlyInstanceSQLDelayedTime的時(shí)間后再同步主實(shí)例數(shù)據(jù),單位:秒(s)。
ProxyType:實(shí)例支持的代理類型。
ConnectionString:內(nèi)網(wǎng)連接地址。
ExpireTime:到期時(shí)間。格式為yyyy-MM-ddTHH:mm:ssZ(UTC時(shí)間)。
AdvancedFeatures:目前只針對(duì)SQL Server,獲取高級(jí)特性值。
DBMaxQuantity:一個(gè)實(shí)例下可創(chuàng)建最大數(shù)據(jù)庫數(shù)量。
Category:實(shí)例系列。
SuperPermissionMode:當(dāng)前實(shí)例是否可以開放SA賬號(hào)、AD域、主機(jī)賬號(hào)等高權(quán)限功能。
DBInstanceNetType:實(shí)例是內(nèi)網(wǎng)或外網(wǎng)。
DedicatedHostGroupId:專屬集群ID。
TempDBInstanceId:該實(shí)例如果掛載著臨時(shí)實(shí)例,即為臨時(shí)實(shí)例ID。
DBInstanceCPU:實(shí)例CPU數(shù)量。
SecurityIPList:IP白名單分組下的IP列表。
ReadOnlyDBInstanceIds:主實(shí)例下掛載的只讀實(shí)例ID列表。
SecurityIPMode:白名單模式。
MaintainTime:實(shí)例可維護(hù)時(shí)間段,表示為UTC時(shí)間,+8小時(shí)后是控制臺(tái)上顯示到的可維護(hù)時(shí)間段。
ZoneId:可用區(qū)ID。
Collation:系統(tǒng)字符集排序規(guī)則。
DBInstanceStorageType:實(shí)例存儲(chǔ)類型。
MaxIOPS:最大每秒IO請(qǐng)求次數(shù)。
SlaveZones:組成SlaveZones的參數(shù)列表。
Extra:擴(kuò)展信息。
ServerlessConfig:RDS Serverless實(shí)例的相關(guān)設(shè)置。
BabelfishConfig:Babelfish for RDS PostgreSQL配置信息。
Tips:專屬集群MySQL通用版實(shí)例的異常提示信息。
示例
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
DBInstanceId:
Description:
en: The ID of the instance.
Required: false
Type: String
Resources:
ExtensionDataSource:
Properties:
DBInstanceId:
Ref: DBInstanceId
Type: DATASOURCE::RDS::DBInstance
Outputs:
AccountMaxQuantity:
Description: The maximum number of accounts that can be created on the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- AccountMaxQuantity
AdvancedFeatures:
Description: 'The advanced features that are enabled for the instance. If multiple
advanced features are enabled, the advanced features are separated by commas
(,). This parameter is available only to instances that run SQL Server. Valid
values:
LinkedServer
DistributeTransaction'
Value:
Fn::GetAtt:
- ExtensionDataSource
- AdvancedFeatures
AutoUpgradeMinorVersion:
Description: 'The method that is used to update the minor engine version of the
instance. Valid values:
Auto: automatic update.
Manual: manual update. The minor engine version of the instance is forcefully
updated only when the in-use minor engine version is phased out.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- AutoUpgradeMinorVersion
AvailabilityValue:
Description: The availability status of the instance in percentage.
Value:
Fn::GetAtt:
- ExtensionDataSource
- AvailabilityValue
BabelfishConfig:
Description: The configuration of the Babelfish feature for the ApsaraDB RDS for
PostgreSQL instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- BabelfishConfig
Category:
Description: 'The RDS edition of the instance. Valid values:
Basic: RDS Basic Edition
HighAvailability: RDS High-availability Edition
cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL
AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server
Finance: RDS Enterprise Edition
Serverless_basic: RDS Basic Edition for serverless instances'
Value:
Fn::GetAtt:
- ExtensionDataSource
- Category
Collation:
Description: The character set collation of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Collation
ConnectionMode:
Description: 'The connection mode of the instance. Valid values:
Standard: standard mode
Safe: database proxy mode'
Value:
Fn::GetAtt:
- ExtensionDataSource
- ConnectionMode
ConnectionString:
Description: The internal endpoint of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ConnectionString
ConsoleVersion:
Description: 'The type of the proxy that is used by the instance. Valid values:
1: shared proxy
2: dedicated proxy'
Value:
Fn::GetAtt:
- ExtensionDataSource
- ConsoleVersion
CreationTime:
Description: The creation time. The time follows the ISO 8601 standard in the
yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
Value:
Fn::GetAtt:
- ExtensionDataSource
- CreationTime
CurrentKernelVersion:
Description: The minor engine version of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- CurrentKernelVersion
DBClusterNodes:
Description: The information about the node in the cluster.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBClusterNodes
DBInstanceCPU:
Description: The number of CPU cores.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceCPU
DBInstanceClass:
Description: The instance type of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceClass
DBInstanceClassType:
Description: 'The instance family to which the instance belongs. Valid values:
s: shared instance family
x: general-purpose instance family
d: dedicated instance family
h: dedicated host instance family'
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceClassType
DBInstanceDescription:
Description: The description of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceDescription
DBInstanceDiskUsed:
Description: The disk usage of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceDiskUsed
DBInstanceId:
Description: The instance ID.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceId
DBInstanceMemory:
Description: 'The memory capacity of the instance. Unit: MB.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceMemory
DBInstanceNetType:
Description: 'The type of the network over which the instance is connected. Valid
values:
Internet: Internet
Intranet: internal network'
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceNetType
DBInstanceStatus:
Description: The status of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceStatus
DBInstanceStorage:
Description: 'The storage capacity of the instance. Unit: GB.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceStorage
DBInstanceStorageType:
Description: 'The storage type of the instance. Valid values:
local_ssd and ephemeral_ssd: local SSD
cloud_ssd: standard SSD
cloud_essd: enhanced SSD (ESSD)'
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceStorageType
DBInstanceType:
Description: 'The type of the instance. Valid values:
Primary: primary instance
Readonly: read-only instance
Guard: disaster recovery instance
Temp: temporary instance'
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBInstanceType
DBMaxQuantity:
Description: The maximum number of databases that can be created on the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBMaxQuantity
DedicatedHostGroupId:
Description: The ID of the dedicated cluster.
Value:
Fn::GetAtt:
- ExtensionDataSource
- DedicatedHostGroupId
DeletionProtection:
Description: 'Indicates whether the release protection feature is enabled. Valid
values:
true
false'
Value:
Fn::GetAtt:
- ExtensionDataSource
- DeletionProtection
Engine:
Description: 'The database engine of the instance. Valid values:
MySQL
PostgreSQL
SQLServer
MariaDB'
Value:
Fn::GetAtt:
- ExtensionDataSource
- Engine
EngineVersion:
Description: The database engine version.
Value:
Fn::GetAtt:
- ExtensionDataSource
- EngineVersion
ExpireTime:
Description: 'The expiration time. The time follows the ISO 8601 standard in the
yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
Note: Pay-as-you-go instances never expire.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- ExpireTime
Extra:
Description: The extended information of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Extra
GeneralGroupName:
Description: The name of the dedicated cluster to which the instance belongs.
This parameter is returned only when the instance is created in an ApsaraDB
MyBase cluster that runs MySQL on Standard Edition.
Value:
Fn::GetAtt:
- ExtensionDataSource
- GeneralGroupName
GuardDBInstanceId:
Description: The ID of the disaster recovery instance that is attached to the
instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- GuardDBInstanceId
IPType:
Description: The type of the IP address. Only IPv4 addresses are supported.
Value:
Fn::GetAtt:
- ExtensionDataSource
- IPType
IncrementSourceDBInstanceId:
Description: The ID of the instance from which incremental data comes. The incremental
data of a disaster recovery instance or read-only instance comes from its primary
instance. If this parameter is not returned, the instance is a primary instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- IncrementSourceDBInstanceId
InstanceNetworkType:
Description: 'The network type of the instance. Valid values:
Classic
VPC'
Value:
Fn::GetAtt:
- ExtensionDataSource
- InstanceNetworkType
InstructionSetArch:
Description: 'The architecture type of the instance. Valid values:
x86
arm'
Value:
Fn::GetAtt:
- ExtensionDataSource
- InstructionSetArch
LatestKernelVersion:
Description: The latest minor engine version that is supported by the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- LatestKernelVersion
LockMode:
Description: 'The lock mode of the instance. Valid values:
Unlock: The instance is not locked.
ManualLock: The instance is manually locked.
LockByExpiration: The instance is automatically locked due to instance expiration.
LockByRestoration: The instance is automatically locked due to instance restoration.
LockByDiskQuota: The instance is automatically locked due to exhausted storage
space.
LockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically
locked due to exhausted storage.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- LockMode
LockReason:
Description: The reason why the instance was locked.
Value:
Fn::GetAtt:
- ExtensionDataSource
- LockReason
MaintainTime:
Description: The maintenance window of the instance. The time is displayed in
UTC. Take note that the maintenance window displayed in the ApsaraDB RDS console
is equal to the value of this parameter plus 8 hours.
Value:
Fn::GetAtt:
- ExtensionDataSource
- MaintainTime
MasterInstanceId:
Description: 'The ID of the primary instance.
Note: If this parameter is not returned, the instance is the primary instance.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- MasterInstanceId
MasterZone:
Description: The zone ID of the primary instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- MasterZone
MaxConnections:
Description: The maximum number of concurrent connections.
Value:
Fn::GetAtt:
- ExtensionDataSource
- MaxConnections
MaxIOMBPS:
Description: 'The maximum I/O throughput. Unit: MB/s.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- MaxIOMBPS
MaxIOPS:
Description: The maximum number of I/O requests per second.
Value:
Fn::GetAtt:
- ExtensionDataSource
- MaxIOPS
PGBouncerEnabled:
Description: Indicates whether PgBouncer is enabled.
Value:
Fn::GetAtt:
- ExtensionDataSource
- PGBouncerEnabled
PayType:
Description: 'The billing method of the instance. Valid values:
Postpaid: pay-as-you-go
Prepaid: subscription'
Value:
Fn::GetAtt:
- ExtensionDataSource
- PayType
Port:
Description: The port that is used to connect to the instance over an internal
network.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Port
ProxyType:
Description: 'The type of the proxy that is supported by the instance. Valid values:
0: The instance does not support database proxies.
1: The instance supports shared proxies, with which the instance runs in multi-tenant
mode.
2: The instance supports dedicated proxies, with which the instance runs in
single-tenant mode.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- ProxyType
ReadOnlyDBInstanceIds:
Description: The IDs of the read-only instances that are attached to the primary
instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ReadOnlyDBInstanceIds
ReadonlyInstanceSQLDelayedTime:
Description: 'The latency at which the system replicates data to read-only instances.
The system replicates data from the primary instance to the read-only instances
at the latency that is specified by the ReadonlyInstanceSQLDelayedTime parameter.
Unit: seconds.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- ReadonlyInstanceSQLDelayedTime
ResourceGroupId:
Description: The resource group ID.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ResourceGroupId
SecurityIPList:
Description: The IP addresses in the IP address whitelist.
Value:
Fn::GetAtt:
- ExtensionDataSource
- SecurityIPList
SecurityIPMode:
Description: 'The whitelist mode of the instance. Valid values:
normal: standard whitelist mode
safety: enhanced whitelist mode'
Value:
Fn::GetAtt:
- ExtensionDataSource
- SecurityIPMode
ServerlessConfig:
Description: The settings of the serverless instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ServerlessConfig
SlaveZones:
Description: The information about the zone of the secondary instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- SlaveZones
SuperPermissionMode:
Description: 'Indicates whether the instance supports superuser accounts, such
as the system administrator (SA) account, the Active Directory (AD) account,
and the host account.
Enable
Disabled'
Value:
Fn::GetAtt:
- ExtensionDataSource
- SuperPermissionMode
TempDBInstanceId:
Description: The ID of the temporary instance that is attached to the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- TempDBInstanceId
TimeZone:
Description: The time zone of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- TimeZone
Tips:
Description: The information about the exception that is detected on the instance.
This parameter is returned only when the instance is created in an ApsaraDB
MyBase cluster that runs MySQL on Standard Edition.
Value:
Fn::GetAtt:
- ExtensionDataSource
- Tips
TipsLevel:
Description: 'The severity level of the exception that is detected on the instance.
This parameter is returned only when the instance is created in an ApsaraDB
MyBase cluster that runs MySQL on Standard Edition. Valid values:
1: The instance is normal.
2: The specifications of the read-only instances do not match the specifications
of the primary instance. You must adjust the specifications of these instances
based on your business requirements.'
Value:
Fn::GetAtt:
- ExtensionDataSource
- TipsLevel
VSwitchId:
Description: The vSwitch ID.
Value:
Fn::GetAtt:
- ExtensionDataSource
- VSwitchId
VpcCloudInstanceId:
Description: The VPC ID.
Value:
Fn::GetAtt:
- ExtensionDataSource
- VpcCloudInstanceId
VpcId:
Description: The virtual private cloud (VPC) ID of the instance.
Value:
Fn::GetAtt:
- ExtensionDataSource
- VpcId
ZoneId:
Description: The zone ID.
Value:
Fn::GetAtt:
- ExtensionDataSource
- ZoneId
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"DBInstanceId": {
"Type": "String",
"Description": {
"en": "The ID of the instance."
},
"Required": false
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::RDS::DBInstance",
"Properties": {
"DBInstanceId": {
"Ref": "DBInstanceId"
}
}
}
},
"Outputs": {
"DBInstanceMemory": {
"Description": "The memory capacity of the instance. Unit: MB.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceMemory"
]
}
},
"ResourceGroupId": {
"Description": "The resource group ID.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ResourceGroupId"
]
}
},
"IncrementSourceDBInstanceId": {
"Description": "The ID of the instance from which incremental data comes. The incremental data of a disaster recovery instance or read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"IncrementSourceDBInstanceId"
]
}
},
"MasterZone": {
"Description": "The zone ID of the primary instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"MasterZone"
]
}
},
"Port": {
"Description": "The port that is used to connect to the instance over an internal network.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Port"
]
}
},
"LatestKernelVersion": {
"Description": "The latest minor engine version that is supported by the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"LatestKernelVersion"
]
}
},
"ConsoleVersion": {
"Description": "The type of the proxy that is used by the instance. Valid values:\n1: shared proxy\n2: dedicated proxy",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ConsoleVersion"
]
}
},
"DBInstanceType": {
"Description": "The type of the instance. Valid values:\nPrimary: primary instance\nReadonly: read-only instance\nGuard: disaster recovery instance\nTemp: temporary instance",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceType"
]
}
},
"GeneralGroupName": {
"Description": "The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"GeneralGroupName"
]
}
},
"InstanceNetworkType": {
"Description": "The network type of the instance. Valid values:\nClassic\nVPC",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"InstanceNetworkType"
]
}
},
"DBInstanceClassType": {
"Description": "The instance family to which the instance belongs. Valid values:\ns: shared instance family\nx: general-purpose instance family\nd: dedicated instance family\nh: dedicated host instance family",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceClassType"
]
}
},
"AutoUpgradeMinorVersion": {
"Description": "The method that is used to update the minor engine version of the instance. Valid values:\nAuto: automatic update.\nManual: manual update. The minor engine version of the instance is forcefully updated only when the in-use minor engine version is phased out.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"AutoUpgradeMinorVersion"
]
}
},
"DBInstanceId": {
"Description": "The instance ID.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceId"
]
}
},
"DBInstanceStorage": {
"Description": "The storage capacity of the instance. Unit: GB.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceStorage"
]
}
},
"PGBouncerEnabled": {
"Description": "Indicates whether PgBouncer is enabled.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"PGBouncerEnabled"
]
}
},
"InstructionSetArch": {
"Description": "The architecture type of the instance. Valid values:\nx86\narm",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"InstructionSetArch"
]
}
},
"LockReason": {
"Description": "The reason why the instance was locked.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"LockReason"
]
}
},
"AvailabilityValue": {
"Description": "The availability status of the instance in percentage.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"AvailabilityValue"
]
}
},
"Engine": {
"Description": "The database engine of the instance. Valid values:\nMySQL\nPostgreSQL\nSQLServer\nMariaDB",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Engine"
]
}
},
"DBInstanceDescription": {
"Description": "The description of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceDescription"
]
}
},
"IPType": {
"Description": "The type of the IP address. Only IPv4 addresses are supported.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"IPType"
]
}
},
"MaxIOMBPS": {
"Description": "The maximum I/O throughput. Unit: MB/s.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"MaxIOMBPS"
]
}
},
"DBInstanceDiskUsed": {
"Description": "The disk usage of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceDiskUsed"
]
}
},
"EngineVersion": {
"Description": "The database engine version.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"EngineVersion"
]
}
},
"MaxConnections": {
"Description": "The maximum number of concurrent connections.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"MaxConnections"
]
}
},
"DBInstanceStatus": {
"Description": "The status of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceStatus"
]
}
},
"DBInstanceClass": {
"Description": "The instance type of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceClass"
]
}
},
"AccountMaxQuantity": {
"Description": "The maximum number of accounts that can be created on the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"AccountMaxQuantity"
]
}
},
"VSwitchId": {
"Description": "The vSwitch ID.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"VSwitchId"
]
}
},
"TipsLevel": {
"Description": "The severity level of the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values:\n1: The instance is normal.\n2: The specifications of the read-only instances do not match the specifications of the primary instance. You must adjust the specifications of these instances based on your business requirements.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"TipsLevel"
]
}
},
"LockMode": {
"Description": "The lock mode of the instance. Valid values:\nUnlock: The instance is not locked.\nManualLock: The instance is manually locked.\nLockByExpiration: The instance is automatically locked due to instance expiration.\nLockByRestoration: The instance is automatically locked due to instance restoration.\nLockByDiskQuota: The instance is automatically locked due to exhausted storage space.\nLockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically locked due to exhausted storage.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"LockMode"
]
}
},
"DeletionProtection": {
"Description": "Indicates whether the release protection feature is enabled. Valid values:\ntrue\nfalse",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DeletionProtection"
]
}
},
"PayType": {
"Description": "The billing method of the instance. Valid values:\nPostpaid: pay-as-you-go\nPrepaid: subscription",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"PayType"
]
}
},
"GuardDBInstanceId": {
"Description": "The ID of the disaster recovery instance that is attached to the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"GuardDBInstanceId"
]
}
},
"DBClusterNodes": {
"Description": "The information about the node in the cluster.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBClusterNodes"
]
}
},
"TimeZone": {
"Description": "The time zone of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"TimeZone"
]
}
},
"VpcId": {
"Description": "The virtual private cloud (VPC) ID of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"VpcId"
]
}
},
"MasterInstanceId": {
"Description": "The ID of the primary instance.\nNote: If this parameter is not returned, the instance is the primary instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"MasterInstanceId"
]
}
},
"CurrentKernelVersion": {
"Description": "The minor engine version of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"CurrentKernelVersion"
]
}
},
"CreationTime": {
"Description": "The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"CreationTime"
]
}
},
"ConnectionMode": {
"Description": "The connection mode of the instance. Valid values:\nStandard: standard mode\nSafe: database proxy mode",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ConnectionMode"
]
}
},
"VpcCloudInstanceId": {
"Description": "The VPC ID.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"VpcCloudInstanceId"
]
}
},
"ReadonlyInstanceSQLDelayedTime": {
"Description": "The latency at which the system replicates data to read-only instances. The system replicates data from the primary instance to the read-only instances at the latency that is specified by the ReadonlyInstanceSQLDelayedTime parameter. Unit: seconds.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ReadonlyInstanceSQLDelayedTime"
]
}
},
"ProxyType": {
"Description": "The type of the proxy that is supported by the instance. Valid values:\n0: The instance does not support database proxies.\n1: The instance supports shared proxies, with which the instance runs in multi-tenant mode.\n2: The instance supports dedicated proxies, with which the instance runs in single-tenant mode.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ProxyType"
]
}
},
"ConnectionString": {
"Description": "The internal endpoint of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ConnectionString"
]
}
},
"ExpireTime": {
"Description": "The expiration time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.\nNote: Pay-as-you-go instances never expire.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ExpireTime"
]
}
},
"AdvancedFeatures": {
"Description": "The advanced features that are enabled for the instance. If multiple advanced features are enabled, the advanced features are separated by commas (,). This parameter is available only to instances that run SQL Server. Valid values:\nLinkedServer\nDistributeTransaction",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"AdvancedFeatures"
]
}
},
"DBMaxQuantity": {
"Description": "The maximum number of databases that can be created on the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBMaxQuantity"
]
}
},
"Category": {
"Description": "The RDS edition of the instance. Valid values:\nBasic: RDS Basic Edition\nHighAvailability: RDS High-availability Edition\ncluster: RDS Cluster Edition for ApsaraDB RDS for MySQL\nAlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server\nFinance: RDS Enterprise Edition\nServerless_basic: RDS Basic Edition for serverless instances",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Category"
]
}
},
"SuperPermissionMode": {
"Description": "Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, the Active Directory (AD) account, and the host account.\nEnable\nDisabled",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SuperPermissionMode"
]
}
},
"DBInstanceNetType": {
"Description": "The type of the network over which the instance is connected. Valid values:\nInternet: Internet\nIntranet: internal network",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceNetType"
]
}
},
"DedicatedHostGroupId": {
"Description": "The ID of the dedicated cluster.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DedicatedHostGroupId"
]
}
},
"TempDBInstanceId": {
"Description": "The ID of the temporary instance that is attached to the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"TempDBInstanceId"
]
}
},
"DBInstanceCPU": {
"Description": "The number of CPU cores.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceCPU"
]
}
},
"SecurityIPList": {
"Description": "The IP addresses in the IP address whitelist.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SecurityIPList"
]
}
},
"ReadOnlyDBInstanceIds": {
"Description": "The IDs of the read-only instances that are attached to the primary instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ReadOnlyDBInstanceIds"
]
}
},
"SecurityIPMode": {
"Description": "The whitelist mode of the instance. Valid values:\nnormal: standard whitelist mode\nsafety: enhanced whitelist mode",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SecurityIPMode"
]
}
},
"MaintainTime": {
"Description": "The maintenance window of the instance. The time is displayed in UTC. Take note that the maintenance window displayed in the ApsaraDB RDS console is equal to the value of this parameter plus 8 hours.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"MaintainTime"
]
}
},
"ZoneId": {
"Description": "The zone ID.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ZoneId"
]
}
},
"Collation": {
"Description": "The character set collation of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Collation"
]
}
},
"DBInstanceStorageType": {
"Description": "The storage type of the instance. Valid values:\nlocal_ssd and ephemeral_ssd: local SSD\ncloud_ssd: standard SSD\ncloud_essd: enhanced SSD (ESSD)",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBInstanceStorageType"
]
}
},
"MaxIOPS": {
"Description": "The maximum number of I/O requests per second.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"MaxIOPS"
]
}
},
"SlaveZones": {
"Description": "The information about the zone of the secondary instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"SlaveZones"
]
}
},
"Extra": {
"Description": "The extended information of the instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Extra"
]
}
},
"ServerlessConfig": {
"Description": "The settings of the serverless instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"ServerlessConfig"
]
}
},
"BabelfishConfig": {
"Description": "The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"BabelfishConfig"
]
}
},
"Tips": {
"Description": "The information about the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"Tips"
]
}
}
}
}