AWS CloudFormation 構成プロパティのリファレンス

CodePipeline が関連ステージを処理する際に呼び出す AWS CloudFormation アクション。以下のいずれかのアクションモードを選択します。

既存のスタックまたは作成するスタックに関連付けられている名前のことを指します。この名前は、作成しているスタックの AWS リージョン内で一意であることが必要です。

既存の変更セットの名前、または指定されたスタック用に作成する新しい変更セットの名前です。

AWS CloudFormation テンプレートファイルの場所です。形式は ArtifactName::TemplateFileName です。

テンプレート構成ファイルの場所です。形式は ArtifactName::TemplateConfigurationFileName です。テンプレート構成ファイルには、テンプレートのパラメータ値、スタックポリシー、およびタグを含めることができます。機密情報 (パスワードなど) を含める場合は、このファイルへのアクセスを制限します。詳細については、「AWS CloudFormation アーティファクト」を参照してください。

特定のリソースを含むスタックの場合、AWS CloudFormation がそれらのリソースを作成または更新する場合があることの明示的に承認。例えば、スタックテンプレートに AWS Identity and Access Management (IAM) リソースが含まれている場合、CAPABILITY_IAM を指定する必要があります。詳しくは、「CreateStack API 操作リクエストパラメータ」を参照してください。

スタックテンプレートに IAM リソースがある場合は、このプロパティを指定する必要があります。

複数のキャパシティーを指定できます。

AWS CloudFormation が指定されたスタックのリソースで操作する際に引き受ける IAM サービスロールの名前。

[Advanced] セクションで、CodePipeline が指定されたアクションを実行した後に出力アーティファクトに追加する出力ファイル名 (CreateStackOutput.json など) を指定できます。出力アーティファクトには、AWS CloudFormation テンプレートの Outputs セクションの内容を含む JSON ファイルが含まれています。

名前を指定しない場合、CodePipeline は出力アーティファクトを生成しません。

パラメータはテンプレートで定義されます。パラメータを使用すると、スタックの作成時または更新時にカスタム値を入力できます。テンプレート構成ファイルのテンプレートパラメータ値を上書きする JSON オブジェクトを指定できます。すべてのパラメータ名がスタックテンプレートに存在する必要があります。詳細については、「CloudFormation テンプレートの Parameters 構文」を参照してください。

パラメータ値のほとんどは、テンプレート構成ファイルを使用して指定することをお勧めします。パラメータの上書き機能を使用して、動的パラメータ値のみを指定します。動的パラメータは、パイプラインを実行するまでは不明です。

次の例では、パラメータオーバーライド関数を使用して ParameterName パラメータの値を定義します。この関数は、CodePipeline 入力アーティファクトから値を取得します。パラメータオーバーライド関数の詳細については、「CodePipeline パイプラインでのパラメーターオーバーライド関数の使用」を参照してください。

{
  "ParameterName" : { "Fn::GetParam" : ["ArtifactName", "config-file-name.json", "ParamName"]}
}

CodePipeline が関連ステージを処理する際に呼び出す AWS CloudFormation アクション。次のアクションモードのいずれか 1 つのみを指定します。

このプロパティは必須です。

特定のリソースを含むスタックの場合、AWS CloudFormation がそれらのリソースを作成または更新する場合があることの明示的に承認。例えば、スタックテンプレートに AWS Identity and Access Management (IAM) リソースが含まれている場合、CAPABILITY_IAM を指定する必要があります。詳しくは、「CreateStack API 操作リクエストパラメータ」を参照してください。

このプロパティは条件付きです。スタックテンプレートに IAM リソースがある場合は、このプロパティを指定する必要があります。

複数の機能を指定できます。次の例では、CAPABILITY_IAM および CAPABILITY_AUTO_EXPAND プロパティをテンプレートに追加します。

configuration:
  ActionMode: CHANGE_SET_REPLACE
  Capabilities: CAPABILITY_IAM,CAPABILITY_AUTO_EXPAND
  ChangeSetName: pipeline-changeset
  RoleArn: CloudFormation_Role_ARN
  StackName: my-pipeline-stack
  TemplateConfiguration: 'my-pipeline-stack::template-configuration.json'
  TemplatePath: 'my-pipeline-stack::template-export.yml'

既存の変更セットの名前、または指定されたスタック用に作成する新しい変更セットの名前です。

このプロパティは CHANGE_SET_REPLACE および CHANGE_SET_EXECUTE アクションモードでは必須です。他のすべてのアクションモードでは、このプロパティは無視されます。

CreateStackOutput.json など、出力ファイルの名前。CodePipeline は指定されたアクションを実行した後、出力アーティファクトにファイルを追加します。出力アーティファクトには、AWS CloudFormation テンプレートの Outputs セクションの内容を含む JSON ファイルが含まれています。

このプロパティはオプションです。名前を指定しない場合、CodePipeline は出力アーティファクトを生成しません。

パラメータはテンプレートで定義されます。パラメータを使用すると、スタックの作成時または更新時にカスタム値を入力できます。テンプレート構成ファイルのテンプレートパラメータ値を上書きする JSON オブジェクトを指定できます。すべてのパラメータ名がスタックテンプレートに存在する必要があります。詳細については、「CloudFormation テンプレートの Parameters 構文」を参照してください。

次の例では、 InstanceType および KeyName パラメータの上書きをテンプレートに追加します。

configuration:
  ActionMode: CHANGE_SET_REPLACE
  Capabilities: CAPABILITY_NAMED_IAM
  ChangeSetName: pipeline-changeset
  ParameterOverrides: '{"InstanceType": "t2.small","KeyName": "my-keypair"}'
  RoleArn: CloudFormation_Role_ARN
  StackName: my-pipeline-stack
  TemplateConfiguration: 'my-pipeline-stack::template-configuration.json'
  TemplatePath: 'my-pipeline-stack::template-export.yml'

パラメータ値のほとんどは、テンプレート構成ファイルを使用して指定することをお勧めします。パラメータの上書き機能を使用して、動的パラメータ値のみを指定します。動的パラメータ値は、パイプラインを実行するまでは不明です。

次の例では、パラメータオーバーライド関数を使用して ParameterName パラメータの値を定義します。この関数は、CodePipeline 入力アーティファクトから値を取得します。パラメータオーバーライド関数の詳細については、「CodePipeline パイプラインでのパラメーターオーバーライド関数の使用」を参照してください。

{
  "ParameterName" : { "Fn::GetParam" : ["ArtifactName", "config-file-name.json", "ParamName"]}
}

このプロパティはオプションです。

AWS CloudFormation がスタックのリソースを操作する際に引き受ける IAM サービスロールの Amazon リソースネーム (ARN) です。

このプロパティは、CREATE_UPDATE、REPLACE_ON_FAILURE、DELETE_ONLY、および CHANGE_SET_REPLACE アクションモードに必要です。RoleArn は、変更セットを実行するときには適用されません。変更セットの作成に CodePipeline を使用しない場合は、変更セットまたはスタックにロールが関連付けられていることを確認します。

既存のスタックの名前、または作成するスタックの名前です。

このプロパティはすべてのアクションモードで必須です。

TemplateConfiguration はテンプレート構成ファイルです。このアクションの入力アーティファクトにファイルを含めます。テンプレート構成ファイル名は以下の形式に従います。

Artifactname::TemplateConfigurationFileName

Artifactname は、CodePipeline に表示される入力アーティファクト名です。たとえば、アーティファクト名 SourceArtifact と test-configuration.json ファイル名を持つソースステージでは、次の例に示すような TemplateConfiguration の名前が作成されます。

"TemplateConfiguration": "SourceArtifact::test-configuration.json"

テンプレート構成ファイルには、テンプレートのパラメーター値およびスタックポリシーを含めることができます。機密情報 (パスワードなど) を含める場合は、このファイルへのアクセスを制限します。設定ファイルのテンプレートの例については、「AWS CloudFormation アーティファクト」を参照してください。

このプロパティはオプションです。

TemplatePath は AWS CloudFormation テンプレートファイルを表します。このアクションの入力アーティファクトにファイルを含めます。ファイル名の形式は次のとおりです:

Artifactname::TemplateFileName

Artifactname は、CodePipeline に表示される入力アーティファクト名です。たとえば、アーティファクト名 SourceArtifact と template.yaml ファイル名を持つソースステージでは、次の例に示すような TemplatePath の名前が作成されます。

"TemplatePath": "SourceArtifact::template.yaml"

このプロパティは CREATE_UPDATE、REPLACE_ON_FAILURE および CHANGE_SET_REPLACE アクションモードでは必須です。他のすべてのアクションモードでは、このプロパティは無視されます。