Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples) 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # CloudFormation Tools for PowerShell V5 を使用した の例 次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています CloudFormation。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `Get-CFNStack` 次のコード例は、`Get-CFNStack` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: ユーザーのスタックのすべてを記述するスタックインスタンスのコレクションを返します。** ``` Get-CFNStack ``` **例 2: 指定されたスタックを記述するスタックインスタンスを返します。** ``` Get-CFNStack -StackName "myStack" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeStacks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Get-CFNStackEvent` 次のコード例は、`Get-CFNStackEvent` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたスタックに関するすべてのスタック関連イベントを返します。** ``` Get-CFNStackEvent -StackName "myStack" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeStackEvents](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Get-CFNStackResource` 次のコード例は、`Get-CFNStackResource` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 論理 ID「MyDBInstance」を使用して、指定されたスタックに関連付けられているテンプレートで識別されたリソースの説明を返します。** ``` Get-CFNStackResource -StackName "myStack" -LogicalResourceId "MyDBInstance" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeStackResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Get-CFNStackResourceList` 次のコード例は、`Get-CFNStackResourceList` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたスタックに関連付けられた最大 100 個の AWS リソースのリソースの説明を返します。スタックに関連付けられているすべてのリソースの詳細情報を取得するには、Get-CFNStackResourceSummary を使用します。これは、結果の手動ページングもサポートしています。** ``` Get-CFNStackResourceList -StackName "myStack" ``` **例 2: 論理 ID「Ec2Instance」を使用して、指定されたスタックに関連付けられているテンプレートで識別された Amazon EC2 インスタンスの説明を返します。** ``` Get-CFNStackResourceList -StackName "myStack" -LogicalResourceId "Ec2Instance" ``` **例 3: インスタンス ID「i-123456」で識別される Amazon EC2 インスタンスが含まれるスタックに関連付けられた、最大 100 個のリソースの説明を返します。スタックに関連付けられているすべてのリソースの詳細情報を取得するには、Get-CFNStackResourceSummary を使用します。これは、結果の手動ページングもサポートしています。** ``` Get-CFNStackResourceList -PhysicalResourceId "i-123456" ``` **例 4: スタックのテンプレートで論理 ID「Ec2Instance」によって識別される Amazon EC2 インスタンスの説明を返します。スタックは、スタックに含まれるリソースの物理リソース ID を使用して識別され、この場合はインスタンス ID が「i-123456」の Amazon EC2 インスタンスも含まれます。テンプレートのコンテンツによっては、スタックの識別に異なる物理リソース (Amazon S3 バケットなど) を使用することもできます。** ``` Get-CFNStackResourceList -PhysicalResourceId "i-123456" -LogicalResourceId "Ec2Instance" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeStackResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Get-CFNStackResourceSummary` 次のコード例は、`Get-CFNStackResourceSummary` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたスタックに関連付けられているすべてのリソースの説明を返します。** ``` Get-CFNStackResourceSummary -StackName "myStack" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[ListStackResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Get-CFNStackSummary` 次のコード例は、`Get-CFNStackSummary` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: すべてのスタックの概要情報を返します。** ``` Get-CFNStackSummary ``` **例 2: 現在作成中のすべてのスタックの概要情報を返します。** ``` Get-CFNStackSummary -StackStatusFilter "CREATE_IN_PROGRESS" ``` **例 3: 現在作成中または更新中のすべてのスタックの概要情報を返します。** ``` Get-CFNStackSummary -StackStatusFilter @("CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS") ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[ListStacks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Get-CFNTemplate` 次のコード例は、`Get-CFNTemplate` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたスタックに関連付けられているテンプレートを返します。** ``` Get-CFNTemplate -StackName "myStack" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[GetTemplate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Measure-CFNTemplateCost` 次のコード例は、`Measure-CFNTemplateCost` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: テンプレートの実行に必要なリソースを記述するクエリ文字列を含む AWS Simple Monthly Calculator URL を返します。テンプレートは指定された Amazon S3 URL から取得され、単一のカスタマイゼーションパラメータが適用されます。パラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。** ``` Measure-CFNTemplateCost -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template ` -Region us-west-1 ` -Parameter @{ ParameterKey="KeyName"; ParameterValue="myKeyPairName" } ``` **例 2: テンプレートの実行に必要なリソースを記述するクエリ文字列を含む AWS Simple Monthly Calculator URL を返します。テンプレートは提供されたコンテンツから解析され、カスタマイゼーションパラメータが適用されます (この例は、テンプレートコンテンツが「KeyName」と「InstanceType」の 2 つのパラメータを宣言していることを前提としています)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。** ``` Measure-CFNTemplateCost -TemplateBody "{TEMPLATE CONTENT HERE}" ` -Parameter @( @{ ParameterKey="KeyName"; ParameterValue="myKeyPairName" },` @{ ParameterKey="InstanceType"; ParameterValue="m1.large" }) ``` **例 3: New-Object を使用してテンプレートパラメータのセットを構築し、テンプレートの実行に必要なリソースを記述するクエリ文字列を含む AWS Simple Monthly Calculator URL を返します。テンプレートは、カスタマイゼーションパラメータを使用して、提供されたコンテンツから解析されます (この例は、テンプレートコンテンツが「KeyName」と「InstanceType」の 2 つのパラメータを宣言していることを前提としています)。** ``` $p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter $p1.ParameterKey = "KeyName" $p1.ParameterValue = "myKeyPairName" $p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter $p2.ParameterKey = "InstanceType" $p2.ParameterValue = "m1.large" Measure-CFNTemplateCost -TemplateBody "{TEMPLATE CONTENT HERE}" -Parameter @( $p1, $p2 ) ``` + API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EstimateTemplateCost](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `New-CFNStack` 次のコード例は、`New-CFNStack` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定された名前を使用して新しいスタックを作成します。テンプレートは、カスタマイゼーションパラメータを使用して、提供されたコンテンツから解析されます (「PK1」と「PK2」はテンプレートコンテンツで宣言されたパラメータの名前を表し、「PV1」と「PV2」はこれらのパラメータの値を表します)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。スタックの作成に失敗しても、スタックはロールバックされません。** ``` New-CFNStack -StackName "myStack" ` -TemplateBody "{TEMPLATE CONTENT HERE}" ` -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" }) ` -DisableRollback $true ``` **例 2: 指定された名前を使用して新しいスタックを作成します。テンプレートは、カスタマイゼーションパラメータを使用して、提供されたコンテンツから解析されます (「PK1」と「PK2」はテンプレートコンテンツで宣言されたパラメータの名前を表し、「PV1」と「PV2」はこれらのパラメータの値を表します)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。スタックの作成に失敗すると、スタックがロールバックされます。** ``` $p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter $p1.ParameterKey = "PK1" $p1.ParameterValue = "PV1" $p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter $p2.ParameterKey = "PK2" $p2.ParameterValue = "PV2" New-CFNStack -StackName "myStack" ` -TemplateBody "{TEMPLATE CONTENT HERE}" ` -Parameter @( $p1, $p2 ) ` -OnFailure "ROLLBACK" ``` **例 3: 指定された名前を使用して新しいスタックを作成します。テンプレートは、カスタマイゼーションパラメータを使用して、Amazon S3 URL から取得されます (「PK1」はテンプレートコンテンツで宣言されたパラメータの名前を表し、「PV1」はパラメータの値を表します)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。スタックの作成に失敗すると、スタックがロールバックされます (-DisableRollback \$1false を指定する場合と同じです)**。 ``` New-CFNStack -StackName "myStack" ` -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template ` -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } ``` **例 4: 指定された名前を使用して新しいスタックを作成します。テンプレートは、カスタマイゼーションパラメータを使用して、Amazon S3 URL から取得されます (「PK1」はテンプレートコンテンツで宣言されたパラメータの名前を表し、「PV1」はパラメータの値を表します)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。スタックの作成に失敗すると、スタックがロールバックされます (-DisableRollback \$1false を指定する場合と同じです)。指定された通知 AEN は、公開されたスタック関連のイベントを受け取ります。** ``` New-CFNStack -StackName "myStack" ` -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template ` -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } ` -NotificationARN @( "arn1", "arn2" ) ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[CreateStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Remove-CFNStack` 次のコード例は、`Remove-CFNStack` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたスタックを削除します。** ``` Remove-CFNStack -StackName "myStack" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Resume-CFNUpdateRollback` 次のコード例は、`Resume-CFNUpdateRollback` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたスタックのロールバックを続行します。このスタックの状態は「UPDATE\$1ROLLBACK\$1FAILED」になっている必要があります。続行されたロールバックが成功すると、スタックの状態が「UPDATE\$1ROLLBACK\$1COMPLETE」になります。** ``` Resume-CFNUpdateRollback -StackName "myStack" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[ContinueUpdateRollback](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Stop-CFNUpdateStack` 次のコード例は、`Stop-CFNUpdateStack` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたスタックで行われている更新をキャンセルします。** ``` Stop-CFNUpdateStack -StackName "myStack" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[CancelUpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Test-CFNStack` 次のコード例は、`Test-CFNStack` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: スタックが UPDATE\$1ROLLBACK\$1COMPLETE、CREATE\$1COMPLETE、ROLLBACK\$1COMPLETE、または UPDATE\$1COMPLETE のいずれかの状態に達したかどうかをテストします。** ``` Test-CFNStack -StackName MyStack ``` **出力:** ``` False ``` **例 2: スタックが UPDATE\$1COMPLETE または UPDATE\$1ROLLBACK\$1COMPLETE のいずれかの状態に達したかどうかをテストします。** ``` Test-CFNStack -StackName MyStack -Status UPDATE_COMPLETE,UPDATE_ROLLBACK_COMPLETE ``` **出力:** ``` True ``` + API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Test-CFNStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Test-CFNTemplate` 次のコード例は、`Test-CFNTemplate` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたテンプレートコンテンツを検証します。出力は、テンプレートの機能、説明、パラメータを詳しく説明します。** ``` Test-CFNTemplate -TemplateBody "{TEMPLATE CONTENT HERE}" ``` **例 2: Amazon S3 URL 経由でアクセスされる、指定されたテンプレートを検証します。出力は、テンプレートの機能、説明、パラメータを詳しく説明します。** ``` Test-CFNTemplate -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[ValidateTemplate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Update-CFNStack` 次のコード例は、`Update-CFNStack` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: 指定されたテンプレートとカスタマイゼーションパラメータでスタック「MyStack」を更新します。「PK1」はテンプレートで宣言されているパラメータの名前を表し、「PV1」はその値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。** ``` Update-CFNStack -StackName "myStack" ` -TemplateBody "{Template Content Here}" ` -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } ``` **例 2: 指定されたテンプレートとカスタマイゼーションパラメータでスタック「MyStack」を更新します。「PK1」と「PK2」はテンプレートで宣言されているパラメータの名前を表し、「PV1」と「PV2」はそれらの要求された値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。** ``` Update-CFNStack -StackName "myStack" ` -TemplateBody "{Template Content Here}" ` -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } ) ``` **例 3: 指定されたテンプレートとカスタマイゼーションパラメータでスタック「MyStack」を更新します。「PK1」はテンプレートで宣言されているパラメータの名前を表し、「PV2」はその値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。** ``` Update-CFNStack -StackName "myStack" -TemplateBody "{Template Content Here}" -Parameters @{ ParameterKey="PK1"; ParameterValue="PV1" } ``` **例 4: 指定されたテンプレート (Amazon S3 から取得されたもの) とカスタマイゼーションパラメータでスタック「MyStack」を更新します。「PK1」と「PK2」はテンプレートで宣言されているパラメータの名前を表し、「PV1」と「PV2」はそれらの要求された値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。** ``` Update-CFNStack -StackName "myStack" ` -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template ` -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } ) ``` **例 5: 指定されたテンプレート (Amazon S3 から取得されたもの) とカスタマイゼーションパラメータでスタック「MyStack」(この例では IAM リソースが含まれていることを想定) を更新します。「PK1」と「PK2」はテンプレートで宣言されているパラメータの名前を表し、「PV1」と「PV2」はそれらの要求された値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。IAM リソースが含まれるスタックでは、-Capabilities「CAPABILITY\$1IAM」パラメータを指定する必要があります。指定されていない場合は、更新が「InsufficientCapabilities」エラーで失敗します。** ``` Update-CFNStack -StackName "myStack" ` -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template ` -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } ) ` -Capabilities "CAPABILITY_IAM" ``` + API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ### `Wait-CFNStack` 次のコード例は、`Wait-CFNStack` を使用する方法を示しています。 **Tools for PowerShell V5** **例 1: スタックが UPDATE\$1ROLLBACK\$1COMPLETE、CREATE\$1COMPLETE、ROLLBACK\$1COMPLETE、または UPDATE\$1COMPLETE のいずれかの状態に達したかどうかをテストします。スタックがいずれかの状態にも達していない場合、コマンドは 2 秒間スリープしてから再度ステータスをテストします。これは、スタックがリクエストされた状態のいずれかに達するか、デフォルトのタイムアウト期間である 60 秒を経過するまで繰り返されます。タイムアウト期間を超えると、例外がスローされます。スタックがタイムアウト期間内にリクエストされた状態のいずれかに達すると、パイプラインに返されます。** ``` $stack = Wait-CFNStack -StackName MyStack ``` **例 2: この例では、スタックが指定の状態のいずれかに達するまで合計 5 分 (300 秒) 待機します。この例では、タイムアウトの前にいずれかの状態に達しているため、スタックオブジェクトはパイプラインに返されます。** ``` Wait-CFNStack -StackName MyStack -Timeout 300 -Status CREATE_COMPLETE,ROLLBACK_COMPLETE ``` **出力:** ``` Capabilities : {CAPABILITY_IAM} ChangeSetId : CreationTime : 6/1/2017 9:29:33 AM Description : AWS CloudFormation Sample Template ec2_instance_with_instance_profile: Create an EC2 instance with an associated instance profile. **WARNING** This template creates one or more Amazon EC2 instances and an Amazon SQS queue. You will be billed for the AWS resources used if you create a stack from this template. DisableRollback : False LastUpdatedTime : 1/1/0001 12:00:00 AM NotificationARNs : {} Outputs : {} Parameters : {} RoleARN : StackId : arn:aws:cloudformation:us-west-2:123456789012:stack/MyStack/7ea87b50-46e7-11e7-9c9b-503a90a9c4d1 StackName : MyStack StackStatus : CREATE_COMPLETE StackStatusReason : Tags : {} TimeoutInMinutes : 0 ``` **例 3: この例では、スタックがタイムアウト期間 (この場合はデフォルト期間 60 秒) 内にリクエストされた状態のいずれかに達しなかった場合のエラー出力を示します。** ``` Wait-CFNStack -StackName MyStack -Status CREATE_COMPLETE,ROLLBACK_COMPLETE ``` **出力:** ``` Wait-CFNStack : Timed out after 60 seconds waiting for CloudFormation stack MyStack in region us-west-2 to reach one of state(s): UPDATE_ROLLBACK_COMPLETE,CREATE_COMPLETE,ROLLBACK_COMPLETE,UPDATE_COMPLETE At line:1 char:1 + Wait-CFNStack -StackName MyStack -State CREATE_COMPLETE,ROLLBACK_COMPLETE + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (Amazon.PowerShe...tCFNStackCmdlet:WaitCFNStackCmdlet) [Wait-CFNStack], InvalidOperationException + FullyQualifiedErrorId : InvalidOperationException,Amazon.PowerShell.Cmdlets.CFN.WaitCFNStackCmdlet ``` + API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Wait-CFNStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。