ALIYUN::SAG::SmartAccessGateway は、スマートアクセスゲートウェイ (SAG) インスタンスを作成するために使用されます。
構文
{
"Type": "ALIYUN::SAG::SmartAccessGateway",
"Properties": {
"ReceiverCountry": String,
"Description": String,
"ReceiverZip": String,
"BuyerMessage": String,
"CidrBlock": String,
"ReceiverTown": String,
"HardWareSpec": String,
"Name": String,
"ReceiverPhone": String,
"ReceiverCity": String,
"RoutingStrategy": String,
"SecurityLockThreshold": Integer,
"ReceiverAddress": String,
"AlreadyHaveSag": Boolean,
"HaType": String,
"Period": Integer,
"MaxBandWidth": Integer,
"AutoPay": Boolean,
"ReceiverMobile": String,
"ReceiverDistrict": String,
"Activate": Boolean,
"ChargeType": String,
"ReceiverState": String,
"ReceiverName": String,
"ReceiverEmail": String
}
}プロパティ
| プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
| ReceiverCountry | String | はい | いいえ | SAG デバイスを受け取る国。 | 例: China。 |
| Description | String | いいえ | はい | SAG インスタンスの説明。 | 説明は 2 ～ 256 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。文字で始める必要があります。 |
| ReceiverZip | String | はい | いいえ | SAG デバイスを受け取る住所の郵便番号。 | なし。 |
| BuyerMessage | String | はい | いいえ | 購入者からの備考。 | なし。 |
| CidrBlock | String | いいえ | はい | プライベート CIDR ブロック。 | なし。 |
| ReceiverTown | String | はい | いいえ | SAG デバイスを受け取る町。 | なし。 |
| HardWareSpec | String | はい | いいえ | SAG インスタンスのタイプ。 | 有効な値:
|
| Name | String | いいえ | はい | SAG インスタンスの名前。 | 名前は 2 ～ 128 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。文字で始める必要があります。 |
| ReceiverPhone | String | いいえ | いいえ | 受信者の固定電話番号。 | なし。 |
| ReceiverCity | String | はい | いいえ | SAG デバイスを受け取る市。 | なし。 |
| RoutingStrategy | String | いいえ | はい | SAG デバイスのルーティングポリシー。 | なし。 |
| SecurityLockThreshold | Integer | いいえ | はい | 時間しきい値。SAG デバイスが指定された時間オフラインのままである場合、SAG デバイスはロックされます。 | 単位: 秒。 |
| ReceiverAddress | String | はい | いいえ | 受信者の詳細な住所。 | なし。 |
| AlreadyHaveSag | Boolean | いいえ | いいえ | SAG デバイスが既に存在するかどうかを指定します。 | デフォルト値: false。有効な値:
|
| HaType | String | はい | いいえ | SAG デバイスのデプロイモード。 | 有効な値:
|
| Period | Integer | はい | いいえ | SAG インスタンスのサブスクリプション期間。 | 有効な値: 1、2、3、4、5、6、7、8、9、12、24、36。 単位: 月。 |
| MaxBandWidth | Integer | はい | いいえ | SAG インスタンスの帯域幅。 | 有効な値:
単位: Mbit/s。 |
| AutoPay | Boolean | いいえ | いいえ | サブスクリプション SAG インスタンスの自動支払いを有効にするかどうかを指定します。 | デフォルト値: false。有効な値:
|
| ReceiverMobile | String | はい | いいえ | 受信者の携帯電話番号。 | なし。 |
| ReceiverDistrict | String | はい | いいえ | SAG デバイスを受け取る地区。 | なし。 |
| Activate | Boolean | いいえ | はい | SAG インスタンスをアクティブにするかどうかを指定します。 | デフォルト値: false。有効な値:
|
| ChargeType | String | はい | いいえ | SAG インスタンスの課金方法。 | 値を PREPAY に設定します。これは、サブスクリプション課金方法を示します。 |
| ReceiverState | String | はい | いいえ | SAG デバイスを受け取る省。 | なし。 |
| ReceiverName | String | はい | いいえ | 受信者の名前。 | なし。 |
| ReceiverEmail | String | はい | いいえ | 受信者のメールアドレス。 | なし。 |
戻り値
Fn::GetAtt
- OrderId: 注文の ID。
- SmartAGId: SAG インスタンスの ID。
例
JSON 形式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"ReceiverCountry": {
"Type": "String",
// 受信者住所の国。
"Description": "The country of the recipient address.",
"Default": "China"
},
"ReceiverZip": {
"Type": "String",
// 受信者住所の郵便番号。
"Description": "The postcode of the recipient address.",
"Default": "310000"
},
"BuyerMessage": {
"Type": "String",
// 購入者からの備考。
"Description": "The remarks left by the buyer.",
"Default": "Message"
},
"ReceiverTown": {
"Type": "String",
// 受信者住所の町。
"Description": "The town of the recipient address.",
"Default": "Zhuantang"
},
"HardWareSpec": {
"Type": "String",
// SAG インスタンスのタイプ。有効な値:
// sag-100wm
// sag-1000
// sag-vcpe
"Description": "The type of the SAG instance. Valid values:\nsag-100wm\nsag-1000\nsag-vcpe",
"Default": "sag-100wm"
},
"Name": {
"Type": "String",
// SAG インスタンスの名前。
// 名前は2～128文字で、数字、ピリオド(.)、
// アンダースコア(_)、ハイフン(-)を含めることができます。文字で始める必要があります。
"Description": "The name of the SAG instance.\nThe name must be 2 to 128 characters in length and can contain digits, periods (.),\nunderscores (_), and hyphens (-). It must start with a letter.",
"Default": "test"
},
"ReceiverCity": {
"Type": "String",
// 受信者住所の市。
"Description": "The city of the recipient address.",
"Default": "Hangzhou"
},
"ReceiverAddress": {
"Type": "String",
// 受信者の詳細な住所。
"Description": "The detailed address of the recipient.",
"Default": "No. XX"
},
"HaType": {
"Type": "String",
// デプロイモード。有効な値:
// no_backup: プライベートネットワークをAlibaba Cloudに接続するために、SAGデバイスを1つだけ購入します。
// cold_backup: アクティブスタンバイモードでSAGデバイスを2つ購入します。1つのSAGデバイスはアクティブ
// デバイスとして機能し、もう1つはスタンバイデバイスとして機能します。アクティブデバイスのみが接続
// Alibaba Cloudに接続されます。アクティブデバイスが期待どおりに動作しない場合は、手動で
// スイッチオーバーを実行する必要があります。
// warm_backup: アクティブアクティブモードでSAGデバイスを2つ購入します。両方のSAGデバイスが接続されます
// Alibaba Cloudに接続されます。アクティブデバイスが期待どおりに動作しない場合は、フェイルオーバーが自動的に
// 実行されます。
// 注記 SAG vCPEインスタンスを作成する場合は、値をwarm_backupに設定します。
"Description": "The deployment mode. Valid values:\nno_backup: You buy only one SAG device to connect private networks to Alibaba Cloud.\ncold_backup: You buy two SAG devices in active-standby mode. One SAG device serves as an active\ndevice and the other serves as a standby device. Only the active device is connected\nto Alibaba Cloud. If the active device is not working as expected, you must manually\nperform a switchover.\nwarm_backup: You buy two SAG devices in active-active mode. Both SAG devices are connected to\nAlibaba Cloud. If an active device is not working as expected, a failover is automatically\nperformed.\nNote If you want to create an SAG vCPE instance, set the value to warm_backup.",
"AllowedValues": [
"cold_backup",
"no_backup",
"warm_backup"
],
"Default": "cold_backup"
},
"Period": {
"Type": "Number",
// SAG インスタンスのサブスクリプション期間。単位: 月。
// 有効な値: 1～9、12、24、36。
"Description": "The subscription period of the SAG instance. Unit: months.\nValid values: 1 to 9, 12, 24, and 36.",
"Default": 12
},
"MaxBandWidth": {
"Type": "Number",
// SAG インスタンスの帯域幅。
// SAG CPEインスタンスを作成し、モデルがsag-100wmの場合、このパラメータの有効な値は2～50です。単位: Mbit/s。
// SAG CPEインスタンスを作成し、モデルがsag-1000の場合、このパラメータの有効な値は10～500です。単位: Mbit/s。
// SAG vCPEインスタンスを作成する場合、このパラメータの有効な値は10～1000です。単位: Mbit/s。
"Description": "The bandwidth of the SAG instance.\nIf you want to create an SAG CPE instance and the model is sag-100wm, valid values of this parameter are 2 to 50. Unit: Mbit/s.\nIf you want to create an SAG CPE instance and the model is sag-1000, valid values of this parameter are 10 to 500. Unit: Mbit/s.\nIf you want to create an SAG vCPE instance, valid values of this parameter are 10 to 1000. Unit: Mbit/s.",
"Default": 12
},
"AutoPay": {
"Type": "Boolean",
// インスタンスの自動支払いを有効にするかどうかを指定します。有効な値:
// true: はい
// false: いいえ
// パラメータをfalseに設定した場合は、この操作を呼び出した後に課金管理に移動して支払いを完了
// してください。支払いが完了すると、インスタンスが作成されます。
"Description": "Specifies whether to enable auto-payment for the instance. Valid values:\ntrue: yes\nfalse: no\nIf you set the parameter to false, go to Billing Management to complete the payment\nafter you call this operation. After you complete the payment, the instance can be\ncreated.",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": "false"
},
"ReceiverMobile": {
"Type": "String",
// 受信者の携帯電話番号。
"Description": "The mobile phone number of the recipient.",
"Default": "1884085****"
},
"ReceiverDistrict": {
"Type": "String",
// 受信者住所の地区。
"Description": "The district of the recipient address.",
"Default": "Xihu"
},
"Activate": {
"Type": "Boolean",
// SAG をアクティブにするかどうか。デフォルトは False です。
"Description": "Activate SAG or not. Default is False",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": "true"
},
"ChargeType": {
"Type": "String",
// SAG インスタンスの課金方法。
// サブスクリプション課金方法を指定する PREPAY に値を設定します。
"Description": "The billing method of the SAG instance. \nSet the value to PREPAY, which specifies the subscription billing method.",
"Default": "PREPAY"
},
"ReceiverState": {
"Type": "String",
// 受信者住所の省。
"Description": "The province of the recipient address.",
"Default": "China"
},
"ReceiverName": {
"Type": "String",
// 受信者の名前。
"Description": "The name of the recipient.",
"Default": "Zhang San"
},
"ReceiverEmail": {
"Type": "String",
// 受信者のメールアドレス。
"Description": "The email address of the recipient.",
"Default": "xx@example.com"
}
},
"Resources": {
"SmartAccessGateway": {
"Type": "ALIYUN::SAG::SmartAccessGateway",
"Properties": {
"ReceiverCountry": {
"Ref": "ReceiverCountry"
},
"ReceiverZip": {
"Ref": "ReceiverZip"
},
"BuyerMessage": {
"Ref": "BuyerMessage"
},
"ReceiverTown": {
"Ref": "ReceiverTown"
},
"HardWareSpec": {
"Ref": "HardWareSpec"
},
"Name": {
"Ref": "Name"
},
"ReceiverCity": {
"Ref": "ReceiverCity"
},
"ReceiverAddress": {
"Ref": "ReceiverAddress"
},
"HaType": {
"Ref": "HaType"
},
"Period": {
"Ref": "Period"
},
"MaxBandWidth": {
"Ref": "MaxBandWidth"
},
"AutoPay": {
"Ref": "AutoPay"
},
"ReceiverMobile": {
"Ref": "ReceiverMobile"
},
"ReceiverDistrict": {
"Ref": "ReceiverDistrict"
},
"Activate": {
"Ref": "Activate"
},
"ChargeType": {
"Ref": "ChargeType"
},
"ReceiverState": {
"Ref": "ReceiverState"
},
"ReceiverName": {
"Ref": "ReceiverName"
},
"ReceiverEmail": {
"Ref": "ReceiverEmail"
}
}
}
},
"Outputs": {
"OrderId": {
// 注文のID。
"Description": "The ID of the order.",
"Value": {
"Fn::GetAtt": [
"SmartAccessGateway",
"OrderId"
]
}
},
"SmartAGId": {
// SAG インスタンスのID。
"Description": "The ID of the SAG instance.",
"Value": {
"Fn::GetAtt": [
"SmartAccessGateway",
"SmartAGId"
]
}
}
}
}