ROS テンプレートによる ARMS 環境のプロビジョニング - ROS

ALIYUN::ARMS::環境は、環境を作成するために使用されます。

構文

{
  "Type": "ALIYUN::ARMS::Environment",
  "Properties": {
    "BindResourceId": String,
    "DeletePromInstance": Boolean,
    "EnvironmentSubType": String,
    "EnvironmentType": String,
    "EnvironmentName": String,
    "FeePackage": String,
    "GrafanaWorkspaceId": String,
    "ManagedType": String,
    "PrometheusInstanceId": String,
    "ResourceGroupId": String,
    "Tags": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
BindResourceId	String	はい	いいえ	環境に関連付けるリソースの ID です。	このプロパティには、コンテナーインスタンスの ID または VPC の ID を指定できます。Cloud タイプの環境の場合は、このプロパティにリージョン ID を指定する必要があります。
EnvironmentSubType	String	はい	いいえ	環境のサブタイプです。	有効な値： CS: Container Service for Kubernetes (ACK) または Distributed Cloud Container Platform for Kubernetes (ACK One) ECS: Elastic Compute Service (ECS) Cloud: クラウドサービス
EnvironmentType	String	はい	いいえ	環境のタイプです。	有効な値： CS: ACK ECS: ECS Cloud: クラウドサービス
EnvironmentName	String	はい	はい	環境名です。	なし。
DeletePromInstance	Boolean	いいえ	はい	関連する Prometheus インスタンスを削除するかどうかを指定します。	なし。
FeePackage	String	いいえ	はい	支払い可能なリソースプランです。	説明 EnvironmentType が CS に設定されている場合、FeePackage を CS_Basic または CS_Pro に設定できます。CS_Basic は FeePackage のデフォルト値です。 EnvironmentType が CS 以外の値に設定されている場合、FeePackage は空のままにする必要があります。
GrafanaWorkspaceId	String	いいえ	いいえ	環境に関連付ける Grafana ワークスペースの ID です。	このプロパティが空の場合、デフォルトの共有 Grafana ワークスペースが使用されます。
ManagedType	String	いいえ	いいえ	管理タイプです。	有効な値： none: 管理対象外。これは ACK クラスタのデフォルト値です。 agent: ksm を含むエージェントが管理されます。これは serverless Kubernetes (ASK) クラスタ、Alibaba Cloud Container Compute Service (ACS) クラスタ、および ACK One クラスタのデフォルト値です。 agent-exporter: エージェントとエクスポーターが管理されます。これはクラウドサービスのデフォルト値です。
PrometheusInstanceId	String	いいえ	いいえ	環境に関連付ける Prometheus インスタンスの ID です。	Prometheus インスタンスが提供されていない場合は、InitEnvironment 操作を呼び出してストレージインスタンスを初期化する必要があります。
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID です。	なし。
Tags	List	いいえ	はい	タグです。	最大 20 個のタグを追加できます。詳細については、このトピックの「タグのプロパティ」セクションをご参照ください。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキーです。	なし。
Value	String	いいえ	いいえ	タグ値です。	なし。

戻り値

Fn::GetAtt

ManagedType: 管理タイプ。
EnvironmentId: 環境 ID。
EnvironmentSubType: 環境のサブタイプ。
EnvironmentType: 環境のタイプ。
ResourceGroupId: リソースグループの ID。
EnvironmentName: 環境名。
GrafanaWorkspaceId: 環境に関連付けられている Grafana ワークスペースの ID。
PrometheusInstanceId: 環境に関連付けられている Prometheus インスタンスの ID。
FeePackage: 支払い可能なリソースプラン。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  EnvironmentSubType:
    Type: String
    Description:
      ja: |-
        環境のサブタイプ。有効な値：
        One：CS タイプの環境
        ACK：CS タイプの環境
        ECS：ECS タイプの環境
        Cloud：クラウドサービス
    AllowedValues:
      - ACK
      - ECS
      - One
      - Cloud
    Required: true
  EnvironmentType:
    Type: String
    Description:
      ja: |-
        環境のタイプ。有効な値：
        CS：ACK
        ECS：ECS
        Cloud：クラウドサービス
    AllowedValues:
      - CS
      - ECS
      - Cloud
    Required: true
  EnvironmentName:
    Type: String
    Description:
      ja: 環境の名前。
    Required: true
  BindResourceId:
    Type: String
    Description:
      ja: 環境にバインドされているリソースの ID（コンテナ ID、VPC ID など）。クラウド環境の場合は、リージョン ID を指定します。
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ARMS::Environment
    Properties:
      EnvironmentSubType:
        Ref: EnvironmentSubType
      EnvironmentType:
        Ref: EnvironmentType
      EnvironmentName:
        Ref: EnvironmentName
      BindResourceId:
        Ref: BindResourceId
Outputs:
  ManagedType:
    Description: エージェントまたはエクスポーターが管理されているかどうかを指定します。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ManagedType
  EnvironmentId:
    Description: 環境の ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource        - EnvironmentId
  EnvironmentSubType:
    Description: 環境のサブタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EnvironmentSubType
  EnvironmentType:
    Description: 環境のタイプ。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EnvironmentType
  ResourceGroupId:
    Description: リソースグループの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceGroupId
  EnvironmentName:
    Description: 環境の名前。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EnvironmentName
  GrafanaWorkspaceId:
    Description: 環境にバインドされている Grafana ワークスペースの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - GrafanaWorkspaceId
  PrometheusInstanceId:
    Description: Prometheus インスタンスの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - PrometheusInstanceId
  FeePackage:
    Description: 支払い可能なリソースプラン。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - FeePackage

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "EnvironmentSubType": {
      "Type": "String",
      "Description": {
        "ja": "環境のサブタイプ。有効な値：\nOne：CS タイプの環境\nACK：CS タイプの環境\nECS：ECS タイプの環境\nCloud：クラウドサービス"
      },
      "AllowedValues": [
        "ACK",
        "ECS",
        "One",
        "Cloud"
      ],
      "Required": true
    },
    "EnvironmentType": {
      "Type": "String",
      "Description": {
        "ja": "環境のタイプ。有効な値：\nCS：ACK\nECS：ECS\nCloud：クラウドサービス"
      },
      "AllowedValues": [
        "CS",
        "ECS",
        "Cloud"
      ],
      "Required": true
    },
    "EnvironmentName": {
      "Type": "String",
      "Description": {
        "ja": "環境の名前。"
      },
      "Required": true
    },
    "BindResourceId": {
      "Type": "String",
      "Description": {
        "ja": "環境にバインドされているリソースの ID（コンテナ ID、VPC ID など）。クラウド環境の場合は、リージョン ID を指定します。"
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ARMS::Environment",
      "Properties": {
        "EnvironmentSubType": {
          "Ref": "EnvironmentSubType"
        },
        "EnvironmentType": {
          "Ref": "EnvironmentType"
        },
        "EnvironmentName": {
          "Ref": "EnvironmentName"
        },
        "BindResourceId": {
          "Ref": "BindResourceId"
        }
      }
    }
  },
  "Outputs": {
    "ManagedType": {
      "Description": "エージェントまたはエクスポーターが管理されているかどうかを指定します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ManagedType"
        ]
      }
    },
    "EnvironmentId": {
      "Description": "環境の ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvironmentId"
        ]
      }
    },
    "EnvironmentSubType": {
      "Description": "環境のサブタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvironmentSubType"
        ]
      }
    },
    "EnvironmentType": {
      "Description": "環境のタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvironmentType"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "リソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "EnvironmentName": {
      "Description": "環境の名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EnvironmentName"
        ]
      }
    },
    "GrafanaWorkspaceId": {
      "Description": "環境にバインドされている Grafana ワークスペースの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "GrafanaWorkspaceId"
        ]
      }
    },
    "PrometheusInstanceId": {
      "Description": "Prometheus インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PrometheusInstanceId"
        ]
      }
    },
    "FeePackage": {
      "Description": "支払い可能なリソースプラン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "FeePackage"
        ]
      }
    }
  }
}

構文

プロパティ

タグの構文

タグのプロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式