Amazon CodeCatalyst は新規のお客様には提供されなくなりました。既存のお客様は、通常どおりサービスを引き続き使用できます。詳細については、「[CodeCatalyst から移行する方法](migration.md)」を参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 事前定義済み変数の使用
<a name="workflows-using-predefined-variables"></a>

*事前定義済み変数*は、ワークフローによって自動的に出力され、ワークフローアクションで使用できるキーと値のペアです。

変数の詳細については、「[ワークフローでの変数の使用](workflows-working-with-variables.md)」を参照してください。

**Topics**
+ [事前定義済み変数の参照の例](workflows-predefined-examples.md)
+ [事前定義済み変数の参照](workflows-working-with-variables-reference-output-vars.md)
+ [ワークフローが出力する事前定義済み変数の確認](workflows-working-with-variables-determine-output-vars.md)
+ [定義済み変数のリスト](workflow-ref-action-variables.md)

# 事前定義済み変数の参照の例
<a name="workflows-predefined-examples"></a>

次の例は、ワークフロー定義ファイルで事前定義済み変数を参照する方法を示しています。

事前定義済み変数の詳細については、「[事前定義済み変数の使用](workflows-using-predefined-variables.md)」を参照してください。

**Topics**
+ [例: 「CommitId」事前定義済み変数の参照](#workflows-working-with-variables-ex-refer-action)
+ [例: 「BranchName」事前定義済み変数の参照](#workflows-working-with-variables-ex-branch)

## 例: 「CommitId」事前定義済み変数の参照
<a name="workflows-working-with-variables-ex-refer-action"></a>

次の例は、`MyBuildAction` アクションで `CommitId` 事前定義済み変数を参照する方法を示しています。`CommitId` 変数は CodeCatalyst によって自動的に出力されます。詳細については、「[定義済み変数のリスト](workflow-ref-action-variables.md)」を参照してください。

この例では、ビルドアクションで使用されている変数を示していますが、どのアクションでも `CommitId` を使用できます。

```
MyBuildAction:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
      #Build Docker image and tag it with a commit ID
        - Run: docker build -t image-repo/my-docker-image:latest .
        - Run: docker tag image-repo/my-docker-image:${WorkflowSource.CommitId}
```

## 例: 「BranchName」事前定義済み変数の参照
<a name="workflows-working-with-variables-ex-branch"></a>

次の例は、`CDKDeploy` アクションで `BranchName` 事前定義済み変数を参照する方法を示しています。`BranchName` 変数は CodeCatalyst によって自動的に出力されます。詳細については、「[定義済み変数のリスト](workflow-ref-action-variables.md)」を参照してください。

この例では、**AWS CDK デプロイ**アクションで使用されている変数を示していますが、どのアクションでも `BranchName` を使用できます。

```
CDKDeploy:
    Identifier: aws/cdk-deploy@v2
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      StackName: app-stack-${WorkflowSource.BranchName}
```

# 事前定義済み変数の参照
<a name="workflows-working-with-variables-reference-output-vars"></a>

Amazon CodeCatalyst ワークフロー内のどのアクションでも事前定義済み変数を参照できます。

ワークフローで事前定義済み変数を参照するには、次の手順に従います。

事前定義済み変数の詳細については、「[事前定義済み変数の使用](workflows-using-predefined-variables.md)」を参照してください。

**前提条件**  
`CommitId` など、参照する事前定義済み変数の名前を指定します。詳細については、「[ワークフローが出力する事前定義済み変数の確認](workflows-working-with-variables-determine-output-vars.md)」を参照してください。

------
#### [ Visual ]

*利用できません。YAML を選択して YAML の手順を表示してください。*

------
#### [ YAML ]

**事前定義済み変数を参照するには (YAML エディタ)**

1. [https://codecatalyst.aws/](https://codecatalyst.aws/) で CodeCatalyst コンソールを開きます。

1. プロジェクトを選択します。

1. ナビゲーションペインで **[CI/CD]**、**[ワークフロー]** の順に選択します。

1. ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。

1. **[編集]** を選択します。

1. **[YAML]** を選択します。

1. CodeCatalyst アクションで、次の構文を使用して事前定義済み変数参照を追加します。

   ```
   ${action-group-name.action-name-or-WorkflowSource.variable-name}
   ```

   置き換え前:
   + *action-group-name* はアクショングループの名前に置き換えます。
**注記**  
アクショングループがない場合、または変数が同じアクショングループ内のアクションによって生成される場合は、*action-group-name* を省略しても構いません。
   + *action-name-or-WorkflowSource* は以下に置き換えます。

     変数を出力するアクションの名前。

     または

     `WorkflowSource` (変数が `BranchName` または `CommitId` 変数の場合)。
   + *variable-name* は変数の名前に置き換えます。

   例えば、次のようになります。

   ```
   MySecondAction:
       Configuration:
         Steps:
           - Run: echo ${MyFirstECSAction.cluster}
   ```

   別の例を紹介します。

   ```
   MySecondAction:
       Configuration:
         Steps:
           - Run: echo ${WorkflowSource.CommitId}
   ```

   その他の例については、「[事前定義済み変数の参照の例](workflows-predefined-examples.md)」を参照してください。詳細については、アクションの「[ワークフロー YAML 定義](workflow-reference.md)」を参照してください。

1. (省略可) **[検証]** を選択して、ワークフローの YAML コードをコミットする前に検証します。

1. **[コミット]** を選択し、コミットメッセージを入力し、再度 **[コミット]** を選択します。

------

# ワークフローが出力する事前定義済み変数の確認
<a name="workflows-working-with-variables-determine-output-vars"></a>

次の手順に従って、ワークフローの実行時に出力される事前定義済み変数を確認します。その後、同じワークフロー内でこれらの変数を参照できます。

事前定義済み変数の詳細については、「[事前定義済み変数の使用](workflows-using-predefined-variables.md)」を参照してください。

**ワークフローが出力する事前定義済み変数を確認するには**
+ 次のいずれかを行います。
  + **ワークフローを 1 回実行**します。実行が完了すると、ワークフローによって出力された変数が、実行の詳細ページの **[変数]** タブに表示されます。詳細については、「[ワークフロー実行のステータスと詳細の表示](workflows-view-run.md)」を参照してください。
  + **「[定義済み変数のリスト](workflow-ref-action-variables.md)」を参照してください**。このリファレンスには、各事前定義済み変数の変数名 (キー) と値がまとめられています。

**注記**  
ワークフローの変数の最大合計サイズは「[CodeCatalyst のワークフローのクォータ](workflows-quotas.md)」に記載されています。合計サイズが最大サイズを超えると、最大サイズに達した後に発生するアクションが失敗する可能性があります。

# 定義済み変数のリスト
<a name="workflow-ref-action-variables"></a>

ワークフロー実行の一部として CodeCatalyst アクションによって自動的に生成される定義済み変数を確認するには、次のセクションを参照してください。

事前定義済み変数の詳細については、「[事前定義済み変数の使用](workflows-using-predefined-variables.md)」を参照してください。

**注記**  
このリストには、CodeCatalyst ソースおよび [CodeCatalyst アクション](workflows-actions.md#workflows-actions-types)によって生成された定義済み変数のみが含まれます。GitHub アクションや CodeCatalyst Labs アクションなど、他のタイプのアクションを使用している場合は、代わりに「[ワークフローが出力する事前定義済み変数の確認](workflows-working-with-variables-determine-output-vars.md)」を参照してください。

**リスト**

**注記**  
すべての CodeCatalyst アクションが定義済み変数を生成するわけではありません。アクションがリストにない場合、変数は生成されません。
+ [「BranchName」変数と「CommitId」変数](workflows-sources-variables.md)
+ [CloudFormation 「スタックをデプロイ」変数](deploy-action-cfn-variables.md)
+ [「Amazon ECS にデプロイ」する変数](deploy-action-ecs-variables.md)
+ [「Kubernetes クラスターにデプロイ」変数](deploy-action-eks-variables.md)
+ [「AWS CDK デプロイ」変数](cdk-dep-action-variables.md)
+ [「AWS CDK ブートストラップ」変数](cdk-boot-action-variables.md)
+ [「AWS Lambda 呼び出し」変数](lam-invoke-action-variables.md)
+ [「Amazon ECS タスク定義のレンダリング」の変数](render-ecs-action-variables.md)