ALIYUN::ElasticSearchServerless::App リソースタイプリファレンス - ROS

ALIYUN::ElasticSearchServerless::App は、Elasticsearch サーバーレスアプリケーションを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ElasticSearchServerless::App",
  "Properties": {
    "Authentication": Map,
    "AppName": String,
    "QuotaInfo": Map,
    "AppVersion": String,
    "Description": String,
    "Network": List,
    "PrivateNetwork": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Authentication	Map	はい	はい	認証情報。	詳細については、「Authentication プロパティ」をご参照ください。
AppName	String	はい	いいえ	アプリケーションの名前。	なし
QuotaInfo	Map	はい	いいえ	アプリケーションのクォータ情報。	詳細については、「QuotaInfo プロパティ」をご参照ください。
AppVersion	String	いいえ	いいえ	アプリケーションのバージョン。	値を 7.10 に設定します。
Description	String	いいえ	はい	アプリケーションに関する注釈。	なし
Network	List	いいえ	はい	パブリックネットワークに関する情報。	詳細については、「Network プロパティ」をご参照ください。
PrivateNetwork	List	いいえ	はい	プライベートネットワークに関する情報。	詳細については、「PrivateNetwork プロパティ」をご参照ください。

Authentication 構文

"Authentication": {
  "BasicAuth": List
}

Authentication プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
BasicAuth	List	はい	はい	基本認証情報。	詳細については、「BasicAuth プロパティ」をご参照ください。

BasicAuth 構文

"BasicAuth": [
  {
    "Password": String
  }
]

BasicAuth プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Password	String	はい	いいえ	ユーザーのパスワード。	なし

QuotaInfo 構文

"QuotaInfo": {
  "Cu": Integer,
  "Storage": Integer,
  "AppType": String
}

QuotaInfo プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AppType	String	はい	いいえ	アプリケーションのタイプ。	有効な値: TRIAL STANDARD
Cu	Integer	はい	いいえ	アプリケーションの計算ユニット。	なし
Storage	Integer	はい	いいえ	アプリケーションのストレージ容量。	なし

Network 構文

"Network": [
  {
    "Type": String,
    "Enabled": Boolean,
    "WhiteIpGroup": List
  }
]

Network プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Enabled	Boolean	はい	いいえ	アプリケーションのインターネットアクセスを有効にするかどうかを指定します。	有効な値: true: アプリケーションのインターネットアクセスを有効にします。 false: アプリケーションのインターネットアクセスを無効にします。
Type	String	はい	いいえ	IP アドレスホワイトリストのタイプ。	有効な値: PUBLIC_ES: Elasticsearch のパブリック IP アドレスホワイトリスト PUBLIC_KIBANA: Kibana のパブリック IP アドレスホワイトリスト
WhiteIpGroup	List	いいえ	はい	IP アドレスホワイトリスト。	詳細については、「WhiteIpGroup プロパティ」をご参照ください。

WhiteIpGroup 構文

"WhiteIpGroup": [
  {
    "GroupName": String,
    "Ips": List
  }
]

WhiteIpGroup プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
GroupName	String	はい	いいえ	ホワイトリストグループの名前。	なし
Ips	List	いいえ	いいえ	ホワイトリストグループ内の IP アドレス。	なし

PrivateNetwork 構文

"PrivateNetwork": [
  {
    "PvlEndpointId": String,
    "Type": String,
    "VpcId": String,
    "Enabled": Boolean,
    "WhiteIpGroup": List
  }
]

PrivateNetwork プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Enabled	Boolean	はい	いいえ	アプリケーションのプライベートネットワークアクセスを有効にするかどうかを指定します。	有効な値: true: アプリケーションのプライベートネットワークアクセスを有効にします。 false: アプリケーションのプライベートネットワークアクセスを無効にします。
PvlEndpointId	String	はい	いいえ	プライベートエンドポイントの ID。	なし
Type	String	はい	いいえ	IP アドレスホワイトリストのタイプ。	有効な値: PRIVATE_KIBANA: Kibana のプライベート IP アドレスホワイトリスト PRIVATE_ES: Elasticsearch のプライベート IP アドレスホワイトリスト
VpcId	String	はい	いいえ	仮想プライベートクラウド (VPC) の ID。	なし
WhiteIpGroup	List	いいえ	はい	IP アドレスホワイトリスト。	詳細については、「WhiteIpGroup プロパティ」をご参照ください。

戻り値

Fn::GetAtt

PublicKibanaDomain: アプリケーションの Kibana パブリックドメイン。
InstanceId: インスタンスの ID。
PrivateESDomain: アプリケーションの Elasticsearch プライベートドメイン。
PublicESDdomain: アプリケーションの Elasticsearch パブリックドメイン。
PrivateKibanaDomain: アプリケーションの Kibana プライベートドメイン。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Authentication:
    AssociationPropertyMetadata:
      Parameters:
        BasicAuth:
          AssociationPropertyMetadata:
            Parameters:
              Password:
                Type: String
                Description:
                  en: The password of the user.
                Required: true
          AssociationProperty: List[Parameters]
          Type: Json
          Description:
            en: The basic authentication of the app.
          Required: true
    Type: Json
    Description:
      en: The authentication of the app. Currently only supports specifying passwords for initial users
    Required: true
  QuotaInfo:
    AssociationPropertyMetadata:
      Parameters:
        Cu:
          Type: Number
          Description:
            en: The cu of the app.
          Required: true
        Storage:
          Type: Number
          Description:
            en: The storage of the app.
          Required: true
        AppType:
          Type: String
          Description:
            en: The type of the app.
          AllowedValues:
            - TRIAL
            - STANDARD
          Required: true
    Type: Json
    Description:
      en: The quota info of the app.
    Required: true
  AppName:
    Type: String
    Description:
      en: The name of the elastic search serverless version app.
    Required: true
Resources:
  App:
    Type: ALIYUN::ElasticSearchServerless::App
    Properties:
      Authentication:
        Ref: Authentication
      QuotaInfo:
        Ref: QuotaInfo
      AppName:
        Ref: AppName
Outputs:
  PublicKibanaDomain:
    Description: The public network kibana domain of the app.
    Value:
      Fn::GetAtt:
        - App
        - PublicKibanaDomain
  InstanceId:
    Description: The Id of the ElasticSearch serverless instance.
    Value:
      Fn::GetAtt:
        - App
        - InstanceId
  PrivateESDomain:
    Description: The private network domain of the app.
    Value:
      Fn::GetAtt:
        - App
        - PrivateESDomain
  PublicESDomain:
    Description: The public network domain of the app.
    Value:
      Fn::GetAtt:
        - App
        - PublicESDomain
  PrivateKibanaDomain:
    Description: The private network kibana domain of the app.
    Value:
      Fn::GetAtt:
        - App
        - PrivateKibanaDomain

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Authentication": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "BasicAuth": {
            "AssociationPropertyMetadata": {
              "Parameters": {
                "Password": {
                  "Type": "String",
                  "Description": {
                    "en": "The password of the user."
                  },
                  "Required": true
                }
              }
            },
            "AssociationProperty": "List[Parameters]",
            "Type": "Json",
            "Description": {
              "en": "The basic authentication of the app."
            },
            "Required": true
          }
        }
      },
      "Type": "Json",
      "Description": {
        "en": "The authentication of the app. Currently only supports specifying passwords for initial users"
      },
      "Required": true
    },
    "QuotaInfo": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "Cu": {
            "Type": "Number",
            "Description": {
              "en": "The cu of the app."
            },
            "Required": true
          },
          "Storage": {
            "Type": "Number",
            "Description": {
              "en": "The storage of the app."
            },
            "Required": true
          },
          "AppType": {
            "Type": "String",
            "Description": {
              "en": "The type of the app."
            },
            "AllowedValues": [
              "TRIAL",
              "STANDARD"
            ],
            "Required": true
          }
        }
      },
      "Type": "Json",
      "Description": {
        "en": "The quota info of the app."
      },
      "Required": true
    },
    "AppName": {
      "Type": "String",
      "Description": {
        "en": "The name of the elastic search serverless version app."
      },
      "Required": true
    }
  },
  "Resources": {
    "App": {
      "Type": "ALIYUN::ElasticSearchServerless::App",
      "Properties": {
        "Authentication": {
          "Ref": "Authentication"
        },
        "QuotaInfo": {
          "Ref": "QuotaInfo"
        },
        "AppName": {
          "Ref": "AppName"
        }
      }
    }
  },
  "Outputs": {
    "PublicKibanaDomain": {
      "Description": "アプリケーションの パブリックネットワーク kibana ドメイン。",
      "Value": {
        "Fn::GetAtt": [
          "App",
          "PublicKibanaDomain"
        ]
      }
    },
    "InstanceId": {
      "Description": "ElasticSearch サーバーレス インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "App",
          "InstanceId"
        ]
      }
    },
    "PrivateESDomain": {
      "Description": "アプリケーションの プライベートネットワーク ドメイン。",
      "Value": {
        "Fn::GetAtt": [
          "App",
          "PrivateESDomain"
        ]
      }
    },
    "PublicESDomain": {
      "Description": "アプリケーションの パブリックネットワーク ドメイン。",
      "Value": {
        "Fn::GetAtt": [
          "App",
          "PublicESDomain"
        ]
      }
    },
    "PrivateKibanaDomain": {
      "Description": "アプリケーションの プライベートネットワーク kibana ドメイン。",
      "Value": {
        "Fn::GetAtt": [
          "App",
          "PrivateKibanaDomain"
        ]
      }
    }
  }
}

構文

プロパティ

Authentication 構文

Authentication プロパティ

BasicAuth 構文

BasicAuth プロパティ

QuotaInfo 構文

QuotaInfo プロパティ

Network 構文

Network プロパティ

WhiteIpGroup 構文

WhiteIpGroup プロパティ

PrivateNetwork 構文

PrivateNetwork プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式