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

AWS::CodePipeline::CustomActionType

AWS::CodePipeline::CustomActionType リソースは、AWS CodePipeline デフォルトアクションに含まれないアクティビティのカスタムアクションを作成します (社内で開発されたビルドプロセスやテストスイートの実行など)。これらのカスタムアクションは、パイプラインの段階で使用できます。詳細については、AWS CodePipeline ユーザーガイドの「AWS CodePipeline でのカスタムアクションの作成と追加」を参照してください。

構文

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

JSON

Copy
{ "Type" : "AWS::CodePipeline::CustomActionType", "Properties" : { "Category" : String, "ConfigurationProperties" : [ ConfigurationProperties, ... ], "InputArtifactDetails" : ArtifactDetails, "OutputArtifactDetails" : ArtifactDetails, "Provider" : String, "Settings" : Settings, "Version" : String } }

YAML

Copy
Type: "AWS::CodePipeline::CustomActionType" Properties: Category: String, ConfigurationProperties: - ConfigurationProperties InputArtifactDetails: ArtifactDetails OutputArtifactDetails: ArtifactDetails Provider: String Settings: Settings Version: String

プロパティ

Category

カスタムアクションのカテゴリ (ソースアクションやビルドアクションなど)。有効な値については、AWS CodePipeline API リファレンスの「CreateCustomActionType」を参照してください。

Required: Yes

Type: String

更新に伴う要件: 置換

ConfigurationProperties

カスタムアクションの設定プロパティ。

Required: No

AWS CodePipeline CustomActionType ConfigurationPropertiesType: リスト

更新に伴う要件: 置換

InputArtifactDetails

このカスタムアクションの入力アーティファクトの詳細。

Required: Yes

Type: AWS CodePipeline CustomActionType ArtifactDetails

更新に伴う要件: 置換

OutputArtifactDetails

このカスタムアクションの出力アーティファクトの詳細。

Required: Yes

Type: AWS CodePipeline CustomActionType ArtifactDetails

更新に伴う要件: 置換

Provider

AWS CodePipeline がこのカスタムアクションに使用するサービスプロバイダーの名前。

Required: Yes

Type: String

更新に伴う要件: 置換

Settings

このカスタムアクションに関する情報をユーザーに提供する URL。

Required: No

Type: AWS CodePipeline CustomActionType 設定

更新に伴う要件: 置換

Version

このカスタムアクションのバージョン番号。

Required: No

Type: String

更新に伴う要件: 置換

戻り値

参照番号

AWS::CodePipeline::CustomActionType リソースの論理 ID を組み込み Ref 関数に渡すと、関数はカスタムアクション名 (custo-MyCus-A1BCDEFGHIJ2 など) を返します。

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

以下の例は、ユーザーが 1 つのプロパティ (プロジェクト名) を指定する必要があるカスタムビルドアクションです。

JSON

Copy
"MyCustomActionType": { "Type": "AWS::CodePipeline::CustomActionType", "Properties": { "Category": "Build", "Provider": "My-Build-Provider-Name", "Version": { "Ref" : "Version" }, "ConfigurationProperties": [ { "Description": "The name of the build project must be provided when this action is added to the pipeline.", "Key": "true", "Name": "MyProjectName", "Queryable": "false", "Required": "true", "Secret": "false", "Type": "String" } ], "InputArtifactDetails": { "MaximumCount": "1", "MinimumCount": "1" }, "OutputArtifactDetails": { "MaximumCount": { "Ref" : "MaximumCountForOutputArtifactDetails" }, "MinimumCount": "0" }, "Settings": { "EntityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/", "ExecutionUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/" } } }

YAML

Copy
MyCustomActionType: Type: "AWS::CodePipeline::CustomActionType" Properties: Category: Build Provider: "My-Build-Provider-Name" Version: Ref: Version ConfigurationProperties: - Description: "The name of the build project must be provided when this action is added to the pipeline." Key: true Name: MyProjectName Queryable: false Required: true Secret: false Type: String InputArtifactDetails: MaximumCount: 1 MinimumCount: 1 OutputArtifactDetails: MaximumCount: Ref: MaximumCountForOutputArtifactDetails MinimumCount: 0 Settings: EntityUrlTemplate: "https://my-build-instance/job/{Config:ProjectName}/" ExecutionUrlTemplate: "https://my-build-instance/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"

このページの内容: