すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::ROS::StackInstances

最終更新日:Jan 16, 2025

ALIYUN::ROS::StackInstances は、指定されたリージョン内の指定されたアカウントにスタックインスタンスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ROS::StackInstances",
  "Properties": {
    "OperationPreferences": Map,
    "RetainStacks": Boolean,
    "RegionIds": List,
    "AccountIds": List,
    "ParameterOverrides": Map,
    "StackGroupName": String,
    "DeploymentTargets": Map,
    "OperationDescription": String,
    "DisableRollback": Boolean,
    "TimeoutInMinutes": Integer
  }
}

プロパティ

PropertyTypeRequiredEditableDescriptionConstraint
OperationPreferencesMapNoNoスタックインスタンスを作成する操作の設定。詳細については、OperationPreferences プロパティをご参照ください。
説明
  • MaxConcurrentCount パラメーターと MaxConcurrentPercentage パラメーターのいずれか 1 つを指定できますが、両方を指定することはできません。
  • FailureToleranceCount パラメーターと FailureTolerancePercentage パラメーターのいずれか 1 つを指定できますが、両方を指定することはできません。
RetainStacksBooleanNoNoスタックインスタンスが削除されたときにスタックを保持するかどうかを指定します。スタックインスタンスが削除されたときに、スタックインスタンスに関連付けられているスタックを削除するか保持するかを指定できます。有効な値:
  • true: スタックインスタンスが削除されたときに、関連するスタックを保持します。
  • false: スタックインスタンスが削除されたときに、関連するスタックを削除します。
RegionIdsListYesNoスタックインスタンスを作成するリージョンの ID。最大 20 個のリージョン ID を指定できます。
AccountIdsListNoNoセルフマネージド権限を使用してスタックをデプロイするアカウントの ID。最大 20 個のアカウント ID を指定できます。
ParameterOverridesMapNoNoオーバーライドするパラメーター。なし
StackGroupNameStringYesNoスタックグループの名前。名前はリージョン内で一意である必要があります。

名前は最大 255 文字で、数字、文字、ハイフン(-)、アンダースコア(_)を含めることができます。名前は数字または文字で始まる必要があります。

DeploymentTargetsMapNoNoサービスマネージド権限を使用してスタックをデプロイするフォルダー。詳細については、DeploymentTargets プロパティをご参照ください。
OperationDescriptionStringNoNoスタックインスタンスを作成する操作の説明。説明は 1 ~ 256 文字である必要があります。
DisableRollbackBooleanNoNoスタックインスタンスの作成に失敗した場合にトリガーされるロールバックを有効にするかどうかを指定します。有効な値:
  • true: ロールバックを無効にします。
  • false: ロールバックを有効にします。これはデフォルト値です。
TimeoutInMinutesIntegerNoNoスタックインスタンスを作成するためのタイムアウト期間。デフォルト値:60。

単位:分。

OperationPreferences 構文

"OperationPreferences": {
  "MaxConcurrentPercentage": Integer,
  "MaxConcurrentCount": Integer,
  "FailureTolerancePercentage": Integer,
  "FailureToleranceCount": Integer
}

OperationPreferences プロパティ

PropertyTypeRequiredEditableDescriptionConstraint
MaxConcurrentPercentageIntegerNoNo各リージョンにおけるアカウントの総数に対する、スタックに対して同時に操作を実行できるアカウント数の最大割合。

パーセンテージの数値が整数でない場合、Resource Orchestration Service(ROS)は数値を最も近い整数に切り捨てます。

MaxConcurrentPercentage パラメーターを設定しない場合、デフォルト値 1 が使用されます。

有効な値:1 ~ 100。
MaxConcurrentCountIntegerNoNo各リージョンでスタックに対して同時に操作を実行できるアカウントの最大数。

MaxConcurrentCount パラメーターを設定しない場合、デフォルト値 1 が使用されます。

有効な値:1 ~ 20。
FailureTolerancePercentageIntegerNoNo各リージョンにおけるアカウントの総数に対する、スタック操作の失敗が許容されるアカウント数の割合。リージョンで値を超えた場合、ROS はリージョンでの操作を停止します。

パーセンテージの数値が整数でない場合、ROS は数値を最も近い整数に切り捨てます。

FailureTolerancePercentage パラメーターを設定しない場合、デフォルト値 0 が使用されます。

有効な値:0 ~ 100。
FailureToleranceCountIntegerNoNo各リージョンでスタック操作の失敗が許容されるアカウントの数。リージョンで値を超えた場合、ROS はリージョンでの操作を停止します。

ROS が 1 つのリージョンで操作を停止した場合、ROS は他のリージョンでも操作を停止します。

FailureToleranceCount パラメーターを設定しない場合、デフォルト値 0 が使用されます。

有効な値:0 ~ 100。

DeploymentTargets 構文

"DeploymentTargets": {
  "RdFolderIds": List
}

DeploymentTargets プロパティ

PropertyTypeRequiredEditableDescriptionConstraint
RdFolderIdsListNoNoリソースディレクトリのフォルダー ID。最大 5 つのフォルダー ID を指定できます。

指定したフォルダーに含まれるすべてのメンバーにスタックインスタンスを作成できます。

ルートフォルダーを指定すると、リソースディレクトリのすべてのメンバーにスタックインスタンスが作成されます。

説明 フォルダー ID を表示するには、リソース管理コンソールの [概要] ページに移動します。詳細については、「フォルダーの基本情報を表示する」をご参照ください。

レスポンスパラメーター

Fn::GetAtt

  • LastOperationId: 操作 ID。
  • Stacks: スタックの詳細。

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionIds": {
      "Type": "Json"
    },
    "ParameterOverrides": {
      "Type": "Json"
    },
    "StackGroupName": {
      "Type": "String"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ROS::StackInstances",
      "Properties": {
        "RegionIds": {
          "Ref": "RegionIds"
        },
        "ParameterOverrides": {
          "Ref": "ParameterOverrides"
        },
        "StackGroupName": {
          "Ref": "StackGroupName"
        }
      }
    }
  },
  "Outputs": {
    "LastOperationId": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "LastOperationId"
        ]
      }
    },
    "Stacks": {
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Stacks"
        ]
      }
    }
  }
}