ALIYUN::ApiGateway::Instance - Resource Orchestration Service

ALIYUN::ApiGateway::Instance is used to create a dedicated instance.

Syntax

{
  "Type": "ALIYUN::ApiGateway::Instance",
  "Properties": {
    "InstanceName": String,
    "DeletionForce": Boolean,
    "InstanceSpec": String,
    "HttpsPolicy": String,
    "ZoneId": String,
    "PricingCycle": String,
    "ChargeType": String,
    "Duration": Number,
    "AutoPay": Boolean, 
    "Tags": List
  }
}

Properties


Property	Type	Required	Editable	Description	Constraint
InstanceName	String	Yes	No	The name of the instance.	The name must be 1 to 50 characters in length, and can contain letters, digits, and special characters. Special characters include `- / . _`
DeletionForce	Boolean	No	No	Specifies whether to forcibly delete the instance.	Valid values: true. false. This is the default value.
InstanceSpec	String	Yes	No	The type of the instance.	None
HttpsPolicy	String	Yes	No	The HTTPS security policy.	Valid values: HTTPS1_1_TLS1_0 HTTPS2_TLS1_0 HTTPS2_TLS1_2 For more information, see Configure an HTTPS security policy.
ZoneId	String	Yes	No	The zone ID of the instance.	None
PricingCycle	String	No	No	The unit of the subscription duration for the instance.	Valid values: Month. This is the default value. Year.
ChargeType	String	No	No	The billing method of the instance.	Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. This is the default value.
Duration	Number	No	No	The billing cycle of the instance.	Valid values: If the PricingCycle property is set to Month: 1 to 9 If the PricingCycle property is set to Year: 1 to 3
AutoPay	Boolean	No	No	Specifies whether to enable auto-renewal when the instance expires.	Valid values: true. This is the default value. false.
Tags	List	No	Yes	The tags of the instance.	You can add up to 20 tags at a time. For more information, see Tags properties.

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]


Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The key of the tag.	The tag key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.
Value	String	No	No	The value of the tag.	The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.

Response parameters

Fn::GetAtt

InstanceType: the type of the instance.
InstanceId: the ID of the instance.
VpcEgressAddress: the outbound IP address in virtual private clouds (VPCs).
InternetEgressAddress: the outbound public IP address.
EgressIpv6Enable: indicates whether outbound IPv6 traffic is supported.
VpcIntranetEnable: indicates whether VPCs are supported.
SupportIpv6: indicates whether IPv6 traffic is supported.
VpcSlbIntranetEnable: indicates whether internal-facing Server Load Balancer (SLB) instances are supported.

Examples

YAMLformat

Parameters:
  InstanceName:
    Type: String
    Description: Instance name
  ZoneId:
    Type: String
    AssociationProperty: ZoneId
ROSTemplateFormatVersion: '2015-09-01'
Outputs:
  EgressIpv6Enable:
    Description: Whether enable egress IPv6.
    Value:
      Fn::GetAtt:
        - Instance
        - EgressIpv6Enable
  VpcEgressAddress:
    Description: VPC network egress address.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcEgressAddress
  InternetEgressAddress:
    Description: Internet egress dddress.
    Value:
      Fn::GetAtt:
        - Instance
        - InternetEgressAddress
  InstanceId:
    Description: Instance ID.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceId
  VpcIntranetEnable:
    Description: Whether enable VPC intranet.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcIntranetEnable
  SupportIpv6:
    Description: Whether support IPv6.
    Value:
      Fn::GetAtt:
        - Instance
        - SupportIpv6
  InstanceType:
    Description: Instance type.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceType
  VpcSlbIntranetEnable:
    Description: Whether enable VPC SLB intranet.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcSlbIntranetEnable
Resources:
  Instance:
    Type: ALIYUN::ApiGateway::Instance
    Properties:
      InstanceName: TestInstance
      InstanceSpec: api.s1.small
      HttpsPolicy: HTTPS2_TLS1_0
      ZoneId:
        Ref: ZoneId

JSONformat

{
  "Parameters": {
    "InstanceName": {
      "Type": "String",
      "Description": "Instance name"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ZoneId"
    }
  },
  "ROSTemplateFormatVersion": "2015-09-01",
  "Outputs": {
    "EgressIpv6Enable": {
      "Description": "Whether enable egress IPv6.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "EgressIpv6Enable"
        ]
      }
    },
    "VpcEgressAddress": {
      "Description": "VPC network egress address.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcEgressAddress"
        ]
      }
    },
    "InternetEgressAddress": {
      "Description": "Internet egress dddress.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InternetEgressAddress"
        ]
      }
    },
    "InstanceId": {
      "Description": "Instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "VpcIntranetEnable": {
      "Description": "Whether enable VPC intranet.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcIntranetEnable"
        ]
      }
    },
    "SupportIpv6": {
      "Description": "Whether support IPv6.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "SupportIpv6"
        ]
      }
    },
    "InstanceType": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceType"
        ]
      }
    },
    "VpcSlbIntranetEnable": {
      "Description": "Whether enable VPC SLB intranet.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcSlbIntranetEnable"
        ]
      }
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::ApiGateway::Instance",
      "Properties": {
        "InstanceName": "TestInstance",
        "InstanceSpec": "api.s1.small",
        "HttpsPolicy": "HTTPS2_TLS1_0",
        "ZoneId": {
          "Ref": "ZoneId"
        }
      }
    }
  }
}

For more information, see Instance.json.