ALIYUN::ROS::StackGroup - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

ALIYUN::ROS::StackGroup は、スタックグループを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ROS::StackGroup",
  "Properties": {
    "Description": String,
    "Parameters": Map,
    "ResourceGroupId": String,
    "DynamicTemplateBody": Map,
    "StackGroupName": String,
    "TemplateVersion": String,
    "AdministrationRoleName": String,
    "TemplateBody": Map,
    "TemplateURL": String,
    "AutoDeployment": Map,
    "PermissionModel": String,
    "ExecutionRoleName": String,
    "TemplateId": String
  }
}

パラメーター

パラメーター	タイプ	必須	編集可能	説明	制約
Description	String	いいえ	いいえ	スタックグループの説明。	説明は 1 ～ 256 文字でなければなりません。
Parameters	Map	いいえ	いいえ	パラメーターの詳細。	なし
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	このパラメーターを指定しない場合、スタックグループはデフォルトのリソースグループに追加されます。
DynamicTemplateBody	Map	いいえ	いいえ	テンプレート本文を含む構造体。	Resource Orchestration Service (ROS) が提供する関数式を使用して、テンプレートコンテンツを取得できます。
StackGroupName	String	はい	いいえ	スタックグループの名前。	名前はリージョン内で一意である必要があります。名前は最大 255 文字で、数字、文字、ハイフン (-)、アンダースコア (_) を使用できます。名前は数字または文字で始める必要があります。
TemplateVersion	String	いいえ	いいえ	テンプレートのバージョン。	デフォルトでは、このパラメーターを指定しない場合、最新バージョンが使用されます。
AdministrationRoleName	String	いいえ	いいえ	セルフマネージドスタックグループを作成するときに、ROS の管理者アカウントに指定する RAM ロールの名前。	セルフマネージドスタックグループを作成するときは、ROS の管理者アカウントの RAM ロールの名前を指定する必要があります。このパラメーターを指定しない場合、デフォルト値の AliyunROSStackGroupAdministrationRole が使用されます。ROS の管理者ロールを使用して AliyunROSStackGroupExecutionRole 実行ロールを引き受け、スタックグループ内のスタックインスタンスに対応するスタックに対する操作を実行できます。名前は 1 ～ 64 文字で、文字、数字、ハイフン (-) を使用できます。
TemplateBody	Map	いいえ	いいえ	テンプレート本文を含む構造体。	テンプレート本文は 1 ～ 524,288 バイトの長さでなければなりません。テンプレート本文の長さが上限を超える場合は、HTTP POST リクエスト本文にパラメーターを追加して、URL が長すぎることによるリクエストの失敗を防ぐことをお勧めします。説明 TemplateBody、TemplateURL、TemplateId パラメーターのいずれか 1 つだけを指定する必要があります。
TemplateURL	String	いいえ	いいえ	テンプレート本文を含むファイルの URL。	URL は、Web サーバーまたは Object Storage Service (OSS) バケット上のテンプレートを指している必要があります。テンプレート本文は 1 ～ 524,288 バイトの長さでなければなりません。 OSS URL の例: `oss://ros/template/demo` および `oss://ros/template/demo?RegionId=cn-hangzhou`。デフォルトでは、OSS バケットのリージョンを指定しない場合、RegionId パラメーターの値がリージョンとして使用されます。説明 TemplateBody、TemplateURL、TemplateId パラメーターのいずれか 1 つだけを指定する必要があります。
AutoDeployment	Map	いいえ	いいえ	自動デプロイ設定に関する情報。	詳細については、「AutoDeployment のパラメーター」をご参照ください。
PermissionModel	String	いいえ	いいえ	権限モデル。	有効な値: SELF_MANAGED: セルフマネージド権限モデル。セルフマネージドスタックグループを作成する場合は、管理者アカウントと実行アカウントの RAM ロールを作成し、アカウント間に信頼関係を確立して、実行アカウント内にスタックをデプロイする必要があります。 SERVICE_MANAGED: サービスマネージド権限モデル。サービスマネージドスタックグループを作成すると、ROS は管理者アカウントと実行アカウントのサービスリンクロールを作成し、管理者アカウントはそのロールを使用して実行アカウント内にスタックをデプロイします。説明サービスマネージド権限モデルを使用してスタックをデプロイする場合は、アカウントがリソースディレクトリの管理アカウントまたは委任管理者アカウントであり、アカウントに対して信頼アクセス機能が有効になっていることを確認してください。詳細については、「ステップ 1: (オプション) 委任管理者アカウントを作成する」および「ステップ 2: 信頼アクセスを有効にする」をご参照ください。
ExecutionRoleName	String	いいえ	いいえ	セルフマネージドスタックグループを作成するときに、実行アカウントに指定する RAM ロールの名前。	セルフマネージドスタックグループを作成するときは、実行アカウントの RAM ロールの名前を指定する必要があります。このパラメーターを指定しない場合、デフォルト値の AliyunROSStackGroupExecutionRole が使用されます。ROS のこのロールを使用して、スタックグループ内のスタックインスタンスに対応するスタックに対する操作を実行できます。名前は 1 ～ 64 文字で、文字、数字、ハイフン (-) を使用できます。
TemplateId	String	いいえ	いいえ	テンプレートの ID。	このパラメーターは、共有テンプレートとプライベートテンプレートに適用されます。説明 TemplateBody、TemplateURL、TemplateId パラメーターのいずれか 1 つだけを指定する必要があります。

AutoDeployment の構文

"AutoDeployment": {
  "Enabled": Boolean,
  "RetainStacksOnAccountRemoval": Boolean
}

AutoDeployment のパラメーター

パラメーター	タイプ	必須	編集可能	説明	制約
Enabled	Boolean	はい	いいえ	自動デプロイを有効にするかどうかを指定します。	有効な値: true: 自動デプロイを有効にします。自動デプロイを有効にした後に、スタックグループが属するフォルダーにメンバーを追加すると、ROS はこのメンバー内にスタックグループのスタックインスタンスをデプロイします。フォルダーからメンバーを削除すると、スタックグループはこのメンバー内のスタックインスタンスを削除します。 false: 自動デプロイを無効にします。自動デプロイを無効にした後、フォルダー内のメンバーを変更しても、スタックインスタンスは変更されません。
RetainStacksOnAccountRemoval	Boolean	いいえ	いいえ	フォルダーからメンバーを削除する場合に、メンバー内のスタックを保持するかどうかを指定します。	有効な値: true: スタックを保持します。 false: スタックを削除します。説明 Enabled パラメーターを true に設定する場合は、このパラメーターを指定する必要があります。

レスポンスパラメーター

Fn::GetAtt

StackGroupId: スタックグループの ID。

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "StackGroupName": {
      "Type": "String"
    },
    "TemplateId": {
      "Type": "String"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ROS::StackGroup",
      "Properties": {
        "StackGroupName": {
          "Ref": "StackGroupName"
        },
        "TemplateId": {
          "Ref": "TemplateId"
        }
      }
    }
  },
  "Outputs": {
    "StackGroupId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "StackGroupId"
        ]
      }
    }
  }
}