ALIYUN::SAG::App

更新时间:
复制 MD 格式

Creates a Smart Access Gateway (SAG) app instance.

Syntax

{
  "Type": "ALIYUN::SAG::App",
  "Properties": {
    "ChargeType": String,
    "UserCount": Integer,
    "DataPlan": Integer,
    "Period": Integer,
    "AutoPay": Boolean
  }
}

Properties

Property Type Required Editable Description Constraint
ChargeType String No No Billing method of the SAG app instance. Set the value to PREPAY.

PREPAY specifies a subscription instance.

UserCount Integer Yes No Maximum number of client accounts for the SAG app instance. Must be a positive multiple of 5, such as 5, 10, or 15.
DataPlan Integer Yes No Free monthly data transfer quota per client account. Unit: GB. Set the value to 5.
Note Each client account receives 5 GB of free data transfer per month.
Period Integer Yes No Subscription duration of the SAG app instance. Unit: months.

Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.

AutoPay Boolean Yes No Whether to automatically pay for the SAG app instance. Valid values:
  • true: automatically pays the bill.
  • false (default): does not automatically pay the bill.

If set to false, go to the Orders page in the Alibaba Cloud console to complete the payment. The instance is created after payment.

Return values

Fn::GetAtt

  • OrderId: order ID of the SAG app instance.
  • SmartAGId: ID of the SAG app instance.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "UserCount": {
      "Type": "Number",
      "Description": "The quota of client accounts for the SAG APP instance.\nNote The quota must be a positive multiple of 5, for example, 5, 10, and 15."
    },
    "DataPlan": {
      "Type": "Number",
      "Description": "The quota of the traffic plan that the system allows each client account to use for\nfree each month. Unit: GB. Set the value to 5.\nNote The system allows each client account to use 5 GB traffic plan for free."
    },
    "Period": {
      "Type": "Number",
      "Description": "The subscription period of the SAG APP instance. Unit: months.\nValid values: 1~9, 12, 24, and 36."
    },
    "AutoPay": {
      "Type": "Boolean",
      "Description": "Specifies whether to automatically pay the bills of SAG APP instances. Default value:\nfalse. Valid values:\ntrue: automatically pays the bills of SAG APP instances.\nfalse: does not automatically pay the bills of SAG APP instances.\nIf you set the parameter to false, after you call this operation, go to Billing Management\nof the SAG console to complete the payment, the instance can be created.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    }
  },
  "Resources": {
    "App": {
      "Type": "ALIYUN::SAG::App",
      "Properties": {
        "UserCount": {
          "Ref": "UserCount"
        },
        "DataPlan": {
          "Ref": "DataPlan"
        },
        "Period": {
          "Ref": "Period"
        },
        "AutoPay": {
          "Ref": "AutoPay"
        }
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Description": "The ID of the order that you placed to subscribe to the SAG APP instance.",
      "Value": {
        "Fn::GetAtt": [
          "App",
          "OrderId"
        ]
      }
    },
    "SmartAGId": {
      "Description": "The ID of the SAG APP instance.",
      "Value": {
        "Fn::GetAtt": [
          "App",
          "SmartAGId"
        ]
      }
    }
  }
}