メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::CloudFormation::Stack

AWS::CloudFormation::Stack タイプは、最上位のテンプレート内でスタックをリソースとしてネストさせます。

上位のテンプレートにネストされたスタックからの出力値を追加することができます。GetAtt 関数に、ネストされたスタックの論理名と、ネストされたスタック内の出力値の名前を Outputs.NestedStackOutputName.

重要

ネストされたスタックの更新は、親スタックから実行することを強くお勧めします。

テンプレートの変更を適用して最上位のスタックを更新すると、AWS CloudFormation によってその最上位のスタックが更新され、そこにネストされたスタックに対する更新が開始されます。ネストされたスタックのうち、AWS CloudFormation によって更新されるのは、変更されたスタックのリソースだけです。変更されていないスタックのリソースは更新されません。詳細については、「AWS CloudFormation スタックの更新」を参照してください。

注記

IAM のリソースが含まれるネストされたスタックについては、IAM の機能に同意する必要があります。また、スタックの更新をキャンセルする権限があることを確認します。これは、更新がロールバックする場合に必要です。IAM と AWS CloudFormation の詳細については、「AWS Identity and Access Management によるアクセスの制御」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::CloudFormation::Stack", "Properties" : { "NotificationARNs" : [ String, ... ], "Parameters" : { AWS CloudFormation スタックパラメータ }, "Tags" : [ Resource Tag, ... ], "TemplateURL" : String, "TimeoutInMinutes" : Integer } }

YAML

Copy
Type: "AWS::CloudFormation::Stack" Properties: NotificationARNs: - 文字列 Parameters: AWS CloudFormation スタックパラメータ Tags: - Resource Tag TemplateURL: String TimeoutInMinutes: Integer

プロパティ

NotificationARNs

スタックイベントに関する通知が送信される既存の Amazon SNS トピックのリスト。

Required: No

Type: List of String values

更新に伴う要件: 中断はありません。

Parameters

このネストされたスタックが作成されたときに AWS CloudFormation に渡される一連のパラメーター。

注記

ネストされたスタックに対し、Ref 関数を使用してパラメーター値を渡す場合、カンマで区切られた一連のパラメーターは String 型である必要があります。つまり、ネストされたスタックに CommaDelimitedList 型の値を渡すことはできません。

必須: 条件による (ネストされたスタックで入力パラメーターが要求される場合は必須)。

Type: AWS CloudFormation スタックパラメータ

更新に伴う要件: 更新に中断が伴うかどうかは、更新対象のリソースによって異なります。更新が原因で、ネストされたスタックが置き換えられることはありません。

Tags

このスタックを説明するための任意のタグのセット (キーと値のペア)。

Required: No

Type: AWS CloudFormation Resource Tags

更新に伴う要件: 中断はありません。

TemplateURL

リソースとして作成するスタックを指定するテンプレートの URL。テンプレートは、Amazon S3 バケットに保存されている必要があります。つまり、URL は、https://s3.amazonaws.com/.../TemplateName.template の形式になっている必要があります。

Required: Yes

Type: String

更新に伴う要件: 更新に中断が伴うかどうかは、更新対象のリソースによって異なります。更新が原因で、ネストされたスタックが置き換えられることはありません。

TimeoutInMinutes

ネストされたスタックが CREATE_COMPLETE の状態になるのを AWS CloudFormation が待機する時間 (分)。デフォルトではタイムアウトが設定されていません。AWS CloudFormation は、ネストされたスタックが CREATE_COMPLETE 状態になったことを検出すると、そのリソースを親スタック内で CREATE_COMPLETE としてマークし、親スタックの作成を再開します。ネストされたスタックが CREATE_COMPLETE の状態に至る前にタイムアウト期間が経過すると、AWS CloudFormation は、ネストされたスタックは失敗としてマークし、ネストされたスタックと親スタックの両方がロールバックされます。

Required: No

Type: Integer

[Update requires]: アップデートはサポートされていません。

戻り値

参照番号

AWS::CloudFormation::Stack の場合、Ref はスタック ID を返します。(例:

arn:aws:cloudformation:us-east-2:123456789012:stack/mystack-mynestedstack-sggfrhxhum7w/f449b250-b969-11e0-a185-5081d0136786

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

Outputs.NestedStackOutputName

戻り値: ネストされた指定のスタックからの出力値。NestedStackOutputName は、出力値の名前です。

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

関連情報

このページの内容: