ROS ALIYUN::APIG::Domain による API Gateway ドメインのプロビジョニング - ROS

ALIYUN::APIG::Domain は、ドメイン名を作成するために使用されます。

構文

{
  "Type": "ALIYUN::APIG::Domain",
  "Properties": {
    "DomainName": String,
    "Protocol": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

DomainName

String

はい

いいえ

ドメイン名。

なし。

Protocol

String

はい

ドメイン名でサポートされているプロトコルタイプ。

有効な値:

HTTP: ドメイン名は HTTP のみサポートします。
HTTPS: ドメイン名は HTTPS のみサポートします。

戻り値

Fn::GetAtt

DomainId: ドメイン名の ID。
DomainName: ドメイン名。
Protocol: ドメイン名でサポートされているプロトコルタイプ。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DomainName:
    Description:
      ja: ドメインの名前。
    MaxLength: 128
    MinLength: 1
    Required: true
    Type: String
  Protocol:
    AllowedValues:
      - HTTP
      - HTTPS
    Description:
      ja: 'ドメインでサポートされているプロトコルのタイプは次のとおりです。

        * HTTP: HTTP プロトコルのみをサポートします。

        * HTTPS: HTTPS プロトコルのみをサポートします。'
    Required: true
    Type: String
Resources:
  ExtensionResource:
    Properties:
      DomainName:
        Ref: DomainName
      Protocol:
        Ref: Protocol
    Type: ALIYUN::APIG::Domain
Outputs:
  DomainId:
    Description: ドメインの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DomainId
  DomainName:
    Description: ドメインの名前。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DomainName
  Protocol:
    Description: プロトコルのタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Protocol

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DomainName": {
      "Type": "String",
      "Description": {
        "ja": "ドメインの名前。"
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 128
    },
    "Protocol": {
      "Type": "String",
      "Description": {
        "ja": "ドメインでサポートされているプロトコルのタイプは次のとおりです。\n* HTTP: HTTP プロトコルのみをサポートします。\n* HTTPS: HTTPS プロトコルのみをサポートします。"
      },
      "AllowedValues": [
        "HTTP",
        "HTTPS"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::APIG::Domain",
      "Properties": {
        "DomainName": {
          "Ref": "DomainName"
        },
        "Protocol": {
          "Ref": "Protocol"
        }
      }
    }
  },
  "Outputs": {
    "DomainId": {
      "Description": "ドメインの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DomainId"
        ]
      }
    },
    "DomainName": {
      "Description": "ドメインの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DomainName"
        ]
      }
    },
    "Protocol": {
      "Description": "プロトコルのタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Protocol"
        ]
      }
    }
  }
}