ALIYUN::SAG::SmartAccessGateway - 资源编排

ALIYUN::SAG::SmartAccessGateway类型用于创建智能接入网关实例。

语法

{
  "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	是	否	智能接入网关设备的收货国家。	取值示例：中国。
Description	String	否	是	智能接入网关实例的描述信息。	长度为2~256个字符，以英文字母或汉字开头，可包含英文字母、汉字、数字、半角句号（.）、下划线（_）和短划线（-）。
ReceiverZip	String	是	否	智能接入网关设备的收货省份邮编。	无
BuyerMessage	String	是	否	买家留言信息。	无
CidrBlock	String	否	是	私网网段。	无
ReceiverTown	String	是	否	智能接入网关设备的收货乡镇。	无
HardWareSpec	String	是	否	智能接入网关实例的类型。	取值： sag-100wm：智能接入网关硬件版实例，使用SAG-100WM设备，用于将门户或小型分支机构接入阿里云。 sag-1000：智能接入网关硬件版实例，使用SAG-1000设备，支持安装到工作台和安装到机柜两种安装模式。 sag-vcpe：智能接入网关vCPE版实例，如果部署在您网络的宿主机中，可以使宿主机作为一个CPE（Customer-premises equipment）设备为您提供上云服务。
Name	String	否	是	智能接入网关实例的名称。	长度为2~128个字符，以英文字母或汉字开头，可包含英文字母、汉字、数字、半角句号（.）、下划线（_）和短划线（-）。
ReceiverPhone	String	否	否	智能接入网关设备的收货人电话。	无
ReceiverCity	String	是	否	智能接入网关设备的收货城市。	无
RoutingStrategy	String	否	是	智能接入网关设备的路由策略。	无
SecurityLockThreshold	Integer	否	是	智能接入网关设备的离线锁定的时间阈值。	单位：秒。
ReceiverAddress	String	是	否	智能接入网关设备的收货详细地址。	无
AlreadyHaveSag	Boolean	否	否	是否已拥有智能接入网关设备。	取值： true：已拥有。 false（默认值）：未拥有。
HaType	String	是	否	智能接入网关设备的部署模式。	取值： no_backup：只购买一台智能接入网关设备接入阿里云。 cold_backup：购买两台智能接入网关设备共享带宽，仅主设备在线。当主设备发生故障时，需手动切换至备设备。 warm_backup：购买两台智能接入网关设备共享带宽，两台设备同时在线。当主设备故障时自动切换到备设备。说明当HardWareSpec取值为sag-vcpe时，仅支持指定warm_backup。
Period	Integer	是	否	智能接入网关实例的购买时长。	取值：1~9、12、24、36。单位：月。
MaxBandWidth	Integer	是	否	智能接入网关实例的带宽。	取值范围：当HardWareSpec取值为sag-100wm时：2~50。当HardWareSpec取值为sag-1000时：10~500。当HardWareSpec取值为sag-vcpe时：10~1000。单位：Mbps。
AutoPay	Boolean	否	否	是否自动支付预付费实例的账单。	取值： true：自动支付。 false（默认值）：手动支付。
ReceiverMobile	String	是	否	智能接入网关设备的收货人手机号。	无
ReceiverDistrict	String	是	否	智能接入网关设备的收货街区。	无
Activate	Boolean	否	是	是否激活智能接入网关实例。	取值： true：激活。 false（默认值）：不激活。
ChargeType	String	是	否	智能接入网关实例的计费类型。	取值： PREPAY，表示预付费。
ReceiverState	String	是	否	智能接入网关设备的收货省份。	无
ReceiverName	String	是	否	智能接入网关设备的收货人姓名。	无
ReceiverEmail	String	是	否	智能接入网关设备的收货人电子邮箱。	无

返回值

Fn::GetAtt

OrderId：订单ID。
SmartAGId：智能接入网关实例ID。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ReceiverCountry": {
      "Type": "String",
      "Description": "The country of the recipient address.",
      "Default": "中国"
    },
    "ReceiverZip": {
      "Type": "String",
      "Description": "The postcode of the recipient address.",
      "Default": "310000"
    },
    "BuyerMessage": {
      "Type": "String",
      "Description": "The remarks left by the buyer.",
      "Default": "留言"
    },
    "ReceiverTown": {
      "Type": "String",
      "Description": "The town of the recipient address.",
      "Default": "转塘"
    },
    "HardWareSpec": {
      "Type": "String",
      "Description": "The type of the SAG instance. Valid values:\nsag-100wm\nsag-1000\nsag-vcpe",
      "Default": "sag-100wm"
    },
    "Name": {
      "Type": "String",
      "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": "杭州"
    },
    "ReceiverAddress": {
      "Type": "String",
      "Description": "The detailed address of the recipient.",
      "Default": "XX号"
    },
    "HaType": {
      "Type": "String",
      "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",
      "Description": "The subscription period of the SAG instance. Unit: months.\nValid values: 1 to 9, 12, 24, and 36.",
      "Default": 12
    },
    "MaxBandWidth": {
      "Type": "Number",
      "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",
      "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": "西湖"
    },
    "Activate": {
      "Type": "Boolean",
      "Description": "Activate SAG or not. Default is False",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ],
      "Default": "true"
    },
    "ChargeType": {
      "Type": "String",
      "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": "中国"
    },
    "ReceiverName": {
      "Type": "String",
      "Description": "The name of the recipient.",
      "Default": "张三"
    },
    "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": {
      "Description": "The ID of the order.",
      "Value": {
        "Fn::GetAtt": [
          "SmartAccessGateway",
          "OrderId"
        ]
      }
    },
    "SmartAGId": {
      "Description": "The ID of the SAG instance.",
      "Value": {
        "Fn::GetAtt": [
          "SmartAccessGateway",
          "SmartAGId"
        ]
      }
    }
  }
}