専用インスタンスを作成するための ALIYUN::ApiGateway::Instance の使用方法 - Resource Orchestration Service

ALIYUN::ApiGateway::Instance は、専用インスタンスを作成するために使用されます。

構文

{
  "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
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
HttpsPolicy	String	はい	いいえ	HTTPS セキュリティポリシー。	有効な値: HTTPS1_1_TLS1_0 HTTPS2_TLS1_0 HTTPS2_TLS1_2 詳細については、「HTTPS セキュリティポリシーを設定する」をご参照ください。
InstanceName	String	はい	いいえ	インスタンスの名前。	名前は 1 ～ 50 文字で、文字、数字、および特殊文字を含めることができます。特殊文字には、`- / . _` が含まれます。
InstanceSpec	String	はい	いいえ	インスタンスタイプ。	なし。
ZoneId	String	はい	いいえ	ゾーンの ID。	なし。
AutoPay	Boolean	いいえ	いいえ	インスタンスの有効期限が切れたときに自動的に更新するかどうかを指定します。	有効な値: true (デフォルト) false
ChargeType	String	いいえ	いいえ	課金方法。	有効な値: PrePaid: サブスクリプション。 PostPaid (デフォルト): 従量課金。
DeletionForce	Boolean	いいえ	いいえ	インスタンスを強制的に削除するかどうかを指定します。	有効な値: true false (デフォルト)
Duration	Number	いいえ	いいえ	課金サイクル。	有効な値: PricingCycle が Month に設定されている場合の有効な値: 1 ～ 9。 PricingCycle が Year に設定されている場合の有効な値: 1 ～ 3。
PricingCycle	String	いいえ	いいえ	インスタンスのサブスクリプション期間の単位。	有効な値: Month (デフォルト) Year
Tags	List	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「タグのプロパティ」をご参照ください。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグのキー。	キーは 1 ～ 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。
Value	String	いいえ	いいえ	タグの値。	値は最大 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

戻り値

Fn::GetAtt

InstanceType: インスタンスタイプ。
InstanceId: インスタンスの ID。
VpcEgressAddress: 仮想プライベートクラウド (VPC) のアウトバウンド IP アドレス。
InternetEgressAddress: インターネットのアウトバウンド IP アドレス。
EgressIpv6Enable: アウトバウンド IPv6 トラフィックがサポートされているかどうかを示します。
VpcIntranetEnable: VPC がサポートされているかどうかを示します。
SupportIpv6: IPv6 がサポートされているかどうかを示します。
VpcSlbIntranetEnable: VPC タイプの内部向け Server Load Balancer (SLB) インスタンスがサポートされているかどうかを示します。
Arn: Alibaba Cloud リソースネーム (ARN)。

例

`YAML` 形式

Parameters:
  InstanceName:
    Type: String
    Description: インスタンス名
  ZoneId:
    Type: String
    AssociationProperty: ZoneId
ROSTemplateFormatVersion: '2015-09-01'
Outputs:
  EgressIpv6Enable:
    Description: IPv6 送信を有効にするかどうか。
    Value:
      Fn::GetAtt:
        - Instance
        - EgressIpv6Enable
  VpcEgressAddress:
    Description: VPC ネットワーク送信アドレス。
    Value:
      Fn::GetAtt:
        - Instance
        - VpcEgressAddress
  InternetEgressAddress:
    Description: インターネット送信アドレス。
    Value:
      Fn::GetAtt:
        - Instance
        - InternetEgressAddress
  InstanceId:
    Description: インスタンス ID。
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceId
  VpcIntranetEnable:
    Description: VPCイントラネットを有効にするかどうか。
    Value:
      Fn::GetAtt:
        - Instance
        - VpcIntranetEnable
  SupportIpv6:
    Description: IPv6 をサポートするかどうか。
    Value:
      Fn::GetAtt:
        - Instance
        - SupportIpv6
  InstanceType:
    Description: インスタンスタイプ。
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceType
  VpcSlbIntranetEnable:
    Description: VPC SLB イントラネットを有効にするかどうか。
    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

`JSON` 形式

{
  "Parameters": {
    "InstanceName": {
      "Type": "String",
      "Description": "インスタンス名"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ZoneId"
    }
  },
  "ROSTemplateFormatVersion": "2015-09-01",
  "Outputs": {
    "EgressIpv6Enable": {
      "Description": "IPv6 送信を有効にするかどうか。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "EgressIpv6Enable"
        ]
      }
    },
    "VpcEgressAddress": {
      "Description": "VPC ネットワーク送信アドレス。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcEgressAddress"
        ]
      }
    },
    "InternetEgressAddress": {
      "Description": "インターネット送信アドレス。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InternetEgressAddress"
        ]
      }
    },
    "InstanceId": {
      "Description": "インスタンス ID。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "VpcIntranetEnable": {
      "Description": "VPCイントラネットを有効にするかどうか。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcIntranetEnable"
        ]
      }
    },
    "SupportIpv6": {
      "Description": "IPv6 をサポートするかどうか。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "SupportIpv6"
        ]
      }
    },
    "InstanceType": {
      "Description": "インスタンスタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceType"
        ]
      }
    },
    "VpcSlbIntranetEnable": {
      "Description": "VPC SLB イントラネットを有効にするかどうか。",
      "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"
        }
      }
    }
  }
}

構文

プロパティ

タグの構文

タグのプロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式