ALIYUN::REDIS::Instance類型用於建立Redis執行個體。
文法
{
"Type": "ALIYUN::REDIS::Instance",
"Properties": {
"VpcId": String,
"EvictionPolicy": String,
"BackupPolicy": Map,
"ZoneId": String,
"InstanceClass": String,
"InstanceMaintainTime": Map,
"Tags": List,
"VpcPasswordFree": Boolean,
"VSwitchId": String,
"SecurityGroupId": String,
"EngineVersion": String,
"SSLEnabled": String,
"Password": String,
"InstanceName": String,
"DeletionForce": Boolean,
"Connections": Map,
"ChargeType": String,
"Period": Integer,
"AutoRenewDuration": Integer,
"ProductType": String
"SecondaryZoneId": String,
"ResourceGroupId": String,
"PeriodUnit": String,
"TairConfig": Map,
"ShardCount": Integer,
"NodeType": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
EngineVersion | String | 否 | 否 | 資料庫版本。 | 取值:
|
InstanceClass | String | 否 | 是 | 執行個體規格。 | 更多資訊,請參見規格查詢導航。 |
InstanceMaintainTime | Map | 否 | 是 | 執行個體的可維護時間段。 | 無 |
Tags | List | 否 | 是 | 標籤。 | 每個執行個體最多可以綁定20個標籤。 更多資訊,請參見Tags屬性。 |
VpcPasswordFree | Boolean | 否 | 否 | 是否啟用免密碼訪問專用網路中的執行個體。 | 取值:
|
VpcId | String | 否 | 否 | 專用網路ID。 | 無 |
EvictionPolicy | String | 否 | 否 | 資料逐出策略。 | 取值:
|
ZoneId | String | 否 | 否 | 可用性區域ID。 | 當建立的執行個體屬於專用網路時,該參數必須指定。 建立多可用性區域執行個體時,您可以調用DescribeZones - 查詢支援的可用性區域介面查詢支援的多可用性區域ID。 |
VSwitchId | String | 否 | 否 | 專用網路下的交換器ID。 | 無 |
SecurityGroupId | String | 否 | 是 | 安全性群組ID。 | 最多支援設定10個ID,ID之間用半形逗號(,)分隔。 |
Password | String | 否 | 是 | 密碼。 | 長度為8~30個字元,必須同時包含大寫英文字母、小寫英文字母和數字。 |
SSLEnabled | String | 否 | 是 | SSL狀態。 | 取值:
|
InstanceName | String | 否 | 是 | 執行個體名稱。 | 長度為2~128個字元。必須以英文字母或漢字開頭,可包含英文字母、數字、漢字、底線(_)、短劃線(-)和半形句號(.)。 |
DeletionForce | Boolean | 否 | 是 | 是否在回收時刪除執行個體。 | 取值:
|
Connections | Map | 否 | 是 | 串連地址。 | 更多資訊,請參見Connections屬性。 |
BackupPolicy | Map | 否 | 是 | 備份策略。 | 更多資訊,請參見BackupPolicy屬性。 |
ChargeType | String | 否 | 否 | 執行個體付費類型。 | 取值:
|
Period | Integer | 否 | 否 | 付費周期。 | 取值:1~9、12、24、36、60。 單位:月。 |
AutoRenewDuration | Integer | 否 | 是 | 自動續約時間長度。 | 取值範圍:1~12。 單位:月。 當執行個體即將到期時,將根據該參數指定的時間長度自動續約。 說明 當ChargeType取值為 PrePaid時該參數有效。 |
ProductType | String | 否 | 否 | 產品類型。 | 取值:
說明 建議設定 ProductType 屬性,能加快參數查詢的速度。 |
SecondaryZoneId | String | 否 | 否 | 備可用性區域ID。 | 可調用DescribeZones - 查詢支援的可用性區域介面查詢。 說明 傳入本參數可以實現主備資料節點分布在不同的可用性區域,實現跨可用性區域容災,可承受機房層級的故障。 |
ResourceGroupId | String | 否 | 是 | 資源群組ID。 | 無 |
PeriodUnit | String | 否 | 否 | 時間長度單位。 | 取值:
|
TairConfig | Map | 否 | 否 | Tair配置。 | 更多資訊,請參見TairConfig屬性。 |
ShardCount | Integer | 否 | 否 | 分區數。 | 本參數僅適用於建立雲端硬碟版叢集架構執行個體,您可以通過該參數實現自訂分區數量。 |
NodeType | String | 否 | 否 | 節點類型。 | 取值:
說明 雲原生版執行個體請選擇MASTER_SLAVE或STAND_ALONE,經典版執行個體請選擇double或single。 |
BackupPolicy文法
"BackupPolicy": {
"PreferredBackupPeriod": "String",
"PreferredBackupTime": "String",
"EnableBackupLog": "Integer"
}
BackupPolicy屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
PreferredBackupPeriod | String | 是 | 是 | 備份周期。 | 取值:
|
PreferredBackupTime | String | 是 | 是 | 備份時間。 | 格式: |
EnableBackupLog | Integer | 否 | 是 | 開啟或關閉增量備份。 | 取值:
|
InstanceMaintainTime文法
"InstanceMaintainTime": {
"MaintainStartTime": "String",
"MaintainEndTime": "String"
}
InstanceMaintainTime屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
MaintainStartTime | String | 否 | 否 | 可維護時間段的開始時間。 | 格式: |
MaintainEndTime | String | 否 | 否 | 可維護時間段的結束時間。 | 格式: 說明 開始時間和結束時間的間隔應為1小時,例如:MaintainStartTime為 |
Tags文法
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標籤鍵。 | 同帳號同地區下標籤鍵唯一。 |
Value | String | 否 | 否 | 標籤值。 | 無 |
Connections文法
"Connections": {
"VpcPrivateConnection": "Map",
"ClassicInnerConnection": "Map",
"DirectConnection": "Map",
"PublicConnection": "Map"
}
Connections屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
VpcPrivateConnection | Map | 否 | 是 | VPC內網地址。 | 更多資訊,請參見VpcPrivateConnection屬性。 |
ClassicInnerConnection | Map | 否 | 是 | 經典內網地址。 | 更多資訊,請參見ClassicInnerConnection屬性。 |
DirectConnection | Map | 否 | 是 | 直接連接地址。該執行個體是一個叢集執行個體。您可以根據需要申請直接連接端點。 | 更多資訊,請參見DirectConnection屬性。 |
PublicConnection | Map | 否 | 是 | 公用地址。 | 更多資訊,請參見PublicConnection屬性。 |
VpcPrivateConnection文法
"VpcPrivateConnection": {
"ConnectionPort": Integer,
"ConnectionString": String
}
VpcPrivateConnection屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ConnectionPort | Integer | 是 | 是 | 執行個體的ApsaraDB服務連接埠號碼。 | 取值範圍:1024~65535。 |
ConnectionString | String | 是 | 是 | 公用端點的首碼。 | 長度為8~64個字元,必須以小寫英文字母開頭。可包含小寫英文字母和數字。 |
PublicConnection文法
"PublicConnection": {
"ConnectionPort": Integer,
"ConnectionString": String
}
PublicConnection屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ConnectionPort | Integer | 是 | 是 | 執行個體的ApsaraDB服務連接埠號碼。 | 取值範圍:1024~65535。 |
ConnectionString | String | 是 | 是 | 公用端點的首碼。 | 長度為8~64個字元,必須以小寫英文字母開頭。可包含小寫英文字母和數字。 |
DirectConnection文法
"DirectConnection": {
"ConnectionPort": Integer,
"ConnectionString": String
}
DirectConnection屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ConnectionPort | Integer | 是 | 是 | 執行個體的ApsaraDB服務連接埠號碼。 | 取值範圍:1024~65535。 |
ConnectionString | String | 是 | 是 | 公用端點的首碼。 | 長度為8~64個字元,必須以小寫英文字母開頭。可包含小寫英文字母和數字。 |
ClassicInnerConnection文法
"ClassicInnerConnection": {
"ConnectionPort": Integer,
"ConnectionString": String
}
ClassicInnerConnection屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ConnectionPort | Integer | 是 | 是 | 執行個體的ApsaraDB服務連接埠號碼。 | 取值範圍:1024~65535。 |
ConnectionString | String | 是 | 是 | 公用端點的首碼。 | 長度為8~64個字元,必須以小寫英文字母開頭。可包含小寫英文字母和數字。 |
TairConfig文法
"TairConfig": {
"Storage": "Integer",
"StorageType": "String",
"ShardCount": "Integer"
}
TairConfig屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Storage | Integer | 否 | 否 | 雲端硬碟的儲存空間。 | 不同的規格取值範圍有所區別。更多資訊,請參見磁碟型執行個體規格。 |
StorageType | String | 否 | 否 | 儲存類型。 | 取值:
|
ShardCount | Integer | 否 | 否 | 執行個體中的資料節點個數。 | 取值:
|
傳回值
Fn::GetAtt
InstanceId:執行個體ID。
OrderId:執行個體訂單ID。
ConnectionDomain:執行個體的私網串連地址。
Port:Redis服務連接埠。
InstanceName:執行個體名稱。
InstanceClass:執行個體規格。
VpcId:專用網路ID。
Capacity:執行個體的儲存容量。
InstanceType:執行個體的引擎版本。
ChargeType:執行個體的計費方式。
PackageType:計劃類型。
Connections:執行個體支援的最大串連數。
ArchitectureType:架構類型。
NodeType:節點類型。
HasRenewChangeOrder:阿里雲帳號是否有待續訂或擴容訂單。
ResourceGroupId:資源群組ID。
QPS:每秒訪問次數,取值為當前規格執行個體的理論值。
ZoneId:執行個體所屬的可用性區域ID。
Bandwidth:執行個體頻寬。單位:Mbps。
EngineVersion:版本類型。
NetworkType:網路類型。
VSwitchId:交換器ID。
PrivateIp:執行個體的私網IP地址。
PublicConnectionString:執行個體的公用連接字串。
VpcPrivateConnectionPort:VPC私人串連連接埠。
ClassicInnerConnectionString:執行個體的經典內部連接字串。
VpcPrivateConnectionString:執行個體的VPC私人連接字串。
PublicConnectionPort:執行個體的公用串連連接埠。
DirectConnectionString:執行個體的直接連接字串。
DirectConnectionPort:執行個體的直接連接連接埠。
ClassicInnerConnectionPort:執行個體的經典內串連連接埠。
樣本
更多樣本,請參見建立KVStore for Redis執行個體、設定Redis執行個體的IP白名單和建立有特定許可權的帳號的組合樣本:YAML樣本。