ALIYUN::REDIS::Instance
ALIYUN::REDIS::Instance類(lèi)型用于創(chuàng)建Redis實(shí)例。
語(yǔ)法
{
"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
}
}屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
EngineVersion | String | 否 | 否 | 數(shù)據(jù)庫(kù)版本。 | 取值：
|
InstanceClass | String | 否 | 是 | 實(shí)例規(guī)格。 | 更多信息，請(qǐng)參見(jiàn)規(guī)格查詢導(dǎo)航。 |
InstanceMaintainTime | Map | 否 | 是 | 實(shí)例的可維護(hù)時(shí)間段。 | 無(wú) |
Tags | List | 否 | 是 | 標(biāo)簽。 | 每個(gè)實(shí)例最多可以綁定20個(gè)標(biāo)簽。 更多信息，請(qǐng)參見(jiàn)Tags屬性。 |
VpcPasswordFree | Boolean | 否 | 否 | 是否啟用免密碼訪問(wèn)專有網(wǎng)絡(luò)中的實(shí)例。 | 取值：
|
VpcId | String | 否 | 否 | 專有網(wǎng)絡(luò)ID。 | 無(wú) |
EvictionPolicy | String | 否 | 否 | 數(shù)據(jù)逐出策略。 | 取值：
|
ZoneId | String | 否 | 否 | 可用區(qū)ID。 | 當(dāng)創(chuàng)建的實(shí)例屬于專有網(wǎng)絡(luò)時(shí)，該參數(shù)必須指定。 創(chuàng)建多可用區(qū)實(shí)例時(shí)，您可以調(diào)用DescribeZones - 查詢支持的可用區(qū)接口查詢支持的多可用區(qū)ID。 |
VSwitchId | String | 否 | 否 | 專有網(wǎng)絡(luò)下的交換機(jī)ID。 | 無(wú) |
SecurityGroupId | String | 否 | 是 | 安全組ID。 | 最多支持設(shè)置10個(gè)ID，ID之間用半角逗號(hào)（,）分隔。 |
Password | String | 否 | 是 | 密碼。 | 長(zhǎng)度為8～30個(gè)字符，必須同時(shí)包含大寫(xiě)英文字母、小寫(xiě)英文字母和數(shù)字。 |
SSLEnabled | String | 否 | 是 | SSL狀態(tài)。 | 取值：
|
InstanceName | String | 否 | 是 | 實(shí)例名稱。 | 長(zhǎng)度為2~128個(gè)字符。必須以英文字母或漢字開(kāi)頭，可包含英文字母、數(shù)字、漢字、下劃線（_）、短劃線（-）和半角句號(hào)（.）。 |
DeletionForce | Boolean | 否 | 是 | 是否在回收時(shí)刪除實(shí)例。 | 取值：
|
Connections | Map | 否 | 是 | 連接地址。 | 更多信息，請(qǐng)參見(jiàn)Connections屬性。 |
BackupPolicy | Map | 否 | 是 | 備份策略。 | 更多信息，請(qǐng)參見(jiàn)BackupPolicy屬性。 |
ChargeType | String | 否 | 否 | 實(shí)例付費(fèi)類(lèi)型。 | 取值：
|
Period | Integer | 否 | 否 | 付費(fèi)周期。 | 取值：1~9、12、24、36、60。 單位：月。 |
AutoRenewDuration | Integer | 否 | 是 | 自動(dòng)續(xù)費(fèi)時(shí)長(zhǎng)。 | 取值范圍：1~12。 單位：月。 當(dāng)實(shí)例即將到期時(shí)，將根據(jù)該參數(shù)指定的時(shí)長(zhǎng)自動(dòng)續(xù)費(fèi)。 說(shuō)明 當(dāng)ChargeType取值為 PrePaid時(shí)該參數(shù)有效。 |
ProductType | String | 否 | 否 | 產(chǎn)品類(lèi)型。 | 取值：
說(shuō)明 建議設(shè)置 ProductType 屬性，能加快參數(shù)查詢的速度。 |
SecondaryZoneId | String | 否 | 否 | 備可用區(qū)ID。 | 可調(diào)用DescribeZones - 查詢支持的可用區(qū)接口查詢。 說(shuō)明 傳入本參數(shù)可以實(shí)現(xiàn)主備數(shù)據(jù)節(jié)點(diǎn)分布在不同的可用區(qū)，實(shí)現(xiàn)跨可用區(qū)容災(zāi)，可承受機(jī)房級(jí)別的故障。 |
ResourceGroupId | String | 否 | 是 | 資源組ID。 | 無(wú) |
PeriodUnit | String | 否 | 否 | 時(shí)長(zhǎng)單位。 | 取值：
|
TairConfig | Map | 否 | 否 | Tair配置。 | 更多信息，請(qǐng)參見(jiàn)TairConfig屬性。 |
ShardCount | Integer | 否 | 否 | 分片數(shù)。 | 本參數(shù)僅適用于創(chuàng)建云盤(pán)版集群架構(gòu)實(shí)例，您可以通過(guò)該參數(shù)實(shí)現(xiàn)自定義分片數(shù)量。 |
NodeType | String | 否 | 否 | 節(jié)點(diǎn)類(lèi)型。 | 取值：
說(shuō)明 云原生版實(shí)例請(qǐng)選擇MASTER_SLAVE或STAND_ALONE，經(jīng)典版實(shí)例請(qǐng)選擇double或single。 |
BackupPolicy語(yǔ)法
"BackupPolicy": {
"PreferredBackupPeriod": "String",
"PreferredBackupTime": "String",
"EnableBackupLog": "Integer"
}BackupPolicy屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
PreferredBackupPeriod | String | 是 | 是 | 備份周期。 | 取值：
|
PreferredBackupTime | String | 是 | 是 | 備份時(shí)間。 | 格式： |
EnableBackupLog | Integer | 否 | 是 | 開(kāi)啟或關(guān)閉增量備份。 | 取值：
|
InstanceMaintainTime語(yǔ)法
"InstanceMaintainTime": {
"MaintainStartTime": "String",
"MaintainEndTime": "String"
}InstanceMaintainTime屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
MaintainStartTime | String | 否 | 否 | 可維護(hù)時(shí)間段的開(kāi)始時(shí)間。 | 格式： |
MaintainEndTime | String | 否 | 否 | 可維護(hù)時(shí)間段的結(jié)束時(shí)間。 | 格式： 說(shuō)明 開(kāi)始時(shí)間和結(jié)束時(shí)間的間隔應(yīng)為1小時(shí)，例如：MaintainStartTime為 |
Tags語(yǔ)法
"Tags": [
{
"Key": String,
"Value": String
}
] Tags屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標(biāo)簽鍵。 | 同賬號(hào)同地域下標(biāo)簽鍵唯一。 |
Value | String | 否 | 否 | 標(biāo)簽值。 | 無(wú) |
Connections語(yǔ)法
"Connections": {
"VpcPrivateConnection": "Map",
"ClassicInnerConnection": "Map",
"DirectConnection": "Map",
"PublicConnection": "Map"
}Connections屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
VpcPrivateConnection | Map | 否 | 是 | VPC內(nèi)網(wǎng)地址。 | 更多信息，請(qǐng)參見(jiàn)VpcPrivateConnection屬性。 |
ClassicInnerConnection | Map | 否 | 是 | 經(jīng)典內(nèi)網(wǎng)地址。 | 更多信息，請(qǐng)參見(jiàn)ClassicInnerConnection屬性。 |
DirectConnection | Map | 否 | 是 | 直接連接地址。該實(shí)例是一個(gè)集群實(shí)例。您可以根據(jù)需要申請(qǐng)直接連接端點(diǎn)。 | 更多信息，請(qǐng)參見(jiàn)DirectConnection屬性。 |
PublicConnection | Map | 否 | 是 | 公共地址。 | 更多信息，請(qǐng)參見(jiàn)PublicConnection屬性。 |
VpcPrivateConnection語(yǔ)法
"VpcPrivateConnection": {
"ConnectionPort": Integer,
"ConnectionString": String
}VpcPrivateConnection屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
ConnectionPort | Integer | 是 | 是 | 實(shí)例的ApsaraDB服務(wù)端口號(hào)。 | 取值范圍：1024~65535。 |
ConnectionString | String | 是 | 是 | 公共端點(diǎn)的前綴。 | 長(zhǎng)度為8~64個(gè)字符，必須以小寫(xiě)英文字母開(kāi)頭。可包含小寫(xiě)英文字母和數(shù)字。 |
PublicConnection語(yǔ)法
"PublicConnection": {
"ConnectionPort": Integer,
"ConnectionString": String
}PublicConnection屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
ConnectionPort | Integer | 是 | 是 | 實(shí)例的ApsaraDB服務(wù)端口號(hào)。 | 取值范圍：1024~65535。 |
ConnectionString | String | 是 | 是 | 公共端點(diǎn)的前綴。 | 長(zhǎng)度為8~64個(gè)字符，必須以小寫(xiě)英文字母開(kāi)頭。可包含小寫(xiě)英文字母和數(shù)字。 |
DirectConnection語(yǔ)法
"DirectConnection": {
"ConnectionPort": Integer,
"ConnectionString": String
}DirectConnection屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
ConnectionPort | Integer | 是 | 是 | 實(shí)例的ApsaraDB服務(wù)端口號(hào)。 | 取值范圍：1024~65535。 |
ConnectionString | String | 是 | 是 | 公共端點(diǎn)的前綴。 | 長(zhǎng)度為8~64個(gè)字符，必須以小寫(xiě)英文字母開(kāi)頭。可包含小寫(xiě)英文字母和數(shù)字。 |
ClassicInnerConnection語(yǔ)法
"ClassicInnerConnection": {
"ConnectionPort": Integer,
"ConnectionString": String
}ClassicInnerConnection屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
ConnectionPort | Integer | 是 | 是 | 實(shí)例的ApsaraDB服務(wù)端口號(hào)。 | 取值范圍：1024~65535。 |
ConnectionString | String | 是 | 是 | 公共端點(diǎn)的前綴。 | 長(zhǎng)度為8~64個(gè)字符，必須以小寫(xiě)英文字母開(kāi)頭。可包含小寫(xiě)英文字母和數(shù)字。 |
TairConfig語(yǔ)法
"TairConfig": {
"Storage": "Integer",
"StorageType": "String",
"ShardCount": "Integer"
}TairConfig屬性
屬性名稱 | 類(lèi)型 | 必須 | 允許更新 | 描述 | 約束 |
Storage | Integer | 否 | 否 | 云盤(pán)的存儲(chǔ)空間。 | 不同的規(guī)格取值范圍有所區(qū)別。更多信息，請(qǐng)參見(jiàn)磁盤(pán)型實(shí)例規(guī)格。 |
StorageType | String | 否 | 否 | 存儲(chǔ)類(lèi)型。 | 取值：
|
ShardCount | Integer | 否 | 否 | 實(shí)例中的數(shù)據(jù)節(jié)點(diǎn)個(gè)數(shù)。 | 取值：
|
返回值
Fn::GetAtt
InstanceId：實(shí)例ID。
OrderId：實(shí)例訂單ID。
ConnectionDomain：實(shí)例的私網(wǎng)連接地址。
Port：Redis服務(wù)端口。
InstanceName：實(shí)例名稱。
InstanceClass：實(shí)例規(guī)格。
VpcId：專有網(wǎng)絡(luò)ID。
Capacity：實(shí)例的存儲(chǔ)容量。
InstanceType：實(shí)例的引擎版本。
ChargeType：實(shí)例的計(jì)費(fèi)方式。
PackageType：計(jì)劃類(lèi)型。
Connections：實(shí)例支持的最大連接數(shù)。
ArchitectureType：架構(gòu)類(lèi)型。
NodeType：節(jié)點(diǎn)類(lèi)型。
HasRenewChangeOrder：阿里云賬號(hào)是否有待續(xù)訂或擴(kuò)容訂單。
ResourceGroupId：資源組ID。
QPS：每秒訪問(wèn)次數(shù)，取值為當(dāng)前規(guī)格實(shí)例的理論值。
ZoneId：實(shí)例所屬的可用區(qū)ID。
Bandwidth：實(shí)例帶寬。單位：Mbps。
EngineVersion：版本類(lèi)型。
NetworkType：網(wǎng)絡(luò)類(lèi)型。
VSwitchId：交換機(jī)ID。
PrivateIp：實(shí)例的私網(wǎng)IP地址。
PublicConnectionString：實(shí)例的公共連接字符串。
VpcPrivateConnectionPort：VPC私有連接端口。
ClassicInnerConnectionString：實(shí)例的經(jīng)典內(nèi)部連接字符串。
VpcPrivateConnectionString：實(shí)例的VPC私有連接字符串。
PublicConnectionPort：實(shí)例的公共連接端口。
DirectConnectionString：實(shí)例的直接連接字符串。
DirectConnectionPort：實(shí)例的直接連接端口。
ClassicInnerConnectionPort：實(shí)例的經(jīng)典內(nèi)連接端口。
示例
ROSTemplateFormatVersion: '2015-09-01'
Description: {}
Parameters:
VpcId:
Type: String
AssociationProperty: ALIYUN::ECS::VPC::VPCId
ZoneId:
Type: String
Description:
zh-cn: 創(chuàng)建實(shí)例前，請(qǐng)確認(rèn)可用區(qū)是否支持Redis資源的規(guī)格。
en: Before you create an instance, confirm that the Availability Zone supports the specifications of Redis resources.
AssociationProperty: ALIYUN::ECS::Instance:ZoneId
Label:
en: Zone ID
zh-cn: 可用區(qū)
VSwitchId:
Type: String
AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
AssociationPropertyMetadata:
VpcId: ${VpcId}
ZoneId: ${ZoneId}
Resources:
RedisInstance:
Type: ALIYUN::REDIS::Instance
Properties:
VpcId:
Ref: VpcId
VSwitchId:
Ref: VSwitchId
InstanceClass: redis.master.small.default
EvictionPolicy: noeviction
ZoneId:
Ref: ZoneId
InstanceName: DefaultRedis
Password: Admin@123!
Outputs:
InstanceId:
Value:
Fn::GetAtt:
- RedisInstance
- InstanceId {
"ROSTemplateFormatVersion": "2015-09-01",
"Description": {
},
"Parameters": {
"VpcId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
},
"ZoneId": {
"Type": "String",
"Description": {
"zh-cn": "創(chuàng)建實(shí)例前，請(qǐng)確認(rèn)可用區(qū)是否支持Redis資源的規(guī)格。",
"en": "Before you create an instance, confirm that the Availability Zone supports the specifications of Redis resources."
},
"AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
"Label": {
"en": "Zone ID",
"zh-cn": "可用區(qū)"
}
},
"VSwitchId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
"AssociationPropertyMetadata": {
"VpcId": "${VpcId}",
"ZoneId": "${ZoneId}"
}
}
},
"Resources": {
"RedisInstance": {
"Type": "ALIYUN::REDIS::Instance",
"Properties": {
"VpcId": {
"Ref": "VpcId"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"InstanceClass": "redis.master.small.default",
"EvictionPolicy": "noeviction",
"ZoneId": {
"Ref": "ZoneId"
},
"InstanceName": "DefaultRedis",
"Password": "Admin@123!"
}
}
},
"Outputs": {
"InstanceId": {
"Value": {
"Fn::GetAtt": [
"RedisInstance",
"InstanceId"
]
}
}
}
}更多示例，請(qǐng)參見(jiàn)創(chuàng)建云數(shù)據(jù)庫(kù)Redis實(shí)例、設(shè)置Redis實(shí)例的IP白名單和創(chuàng)建有特定權(quán)限的賬號(hào)的組合示例：YAML示例。