ワークフロー図でのアプリケーション URL の表示 - Amazon CodeCatalyst

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

ワークフロー図でのアプリケーション URL の表示

ワークフローでアプリケーションをデプロイする場合は、アプリケーションの URL をクリック可能なリンクとして表示するように Amazon CodeCatalyst を設定できます。このリンクは、CodeCatalyst コンソールにデプロイしたアクション内に表示されます。次のワークフロー図は、アクションの下部に表示される [アプリを表示] URL を示しています。

アプリ URL を表示する

CodeCatalyst コンソールでこの URL をクリック可能にすることで、アプリケーションのデプロイをすばやく確認できます。

注記

アプリ URL は、[Amazon ECS にデプロイ] アクションではサポートされていません。

この機能を有効にするには、appurl、または endpointurl を含む名前で出力変数をアクションに追加します。名前は、結合ダッシュ (-)、アンダースコア (_)、またはスペース ( ) の有無にかかわらず使用できます。文字列は大文字と小文字を区別しません。変数の値をデプロイされたアプリケーションの http または https URL に設定します。

注記

既存の出力変数を更新して app url または endpoint url 文字列を含める場合は、この変数へのすべての参照を更新して新しい変数名を使用します。

詳細については、以下に記載される手順を参照してください。

URL の設定が完了したら、以下の手順に従って、URL が期待どおりに表示されることを確認します。

「AWS CDK デプロイ」アクションにアプリケーション URL を表示するには
  1. [AWS CDK デプロイ] アクションを使用している場合は、AWS CDK アプリケーションコードに CfnOutput コンストラクト (キーと値のペア) を追加します。

    • キー名には、結合ダッシュ (-)、アンダースコア (_)、またはスペース ( ) の有無にかかわらず、appurl または endpointurl を含める必要があります。文字列は大文字と小文字を区別しません。

    • 値は、デプロイされたアプリケーションの http または https URL である必要があります。

    例えば、AWS CDK コードは次のように表記されます。

    import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib'; import * as dynamodb from 'aws-cdk-lib/aws-dynamodb'; import * as s3 from 'aws-cdk-lib/aws-s3'; import { Construct } from 'constructs'; import * as cdk from 'aws-cdk-lib'; export class HelloCdkStack extends Stack { constructor(scope: Construct, id: string, props?: StackProps) { super(scope, id, props); const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', { removalPolicy: RemovalPolicy.DESTROY, }); new CfnOutput(this, 'APP-URL', { value: https://mycompany.myapp.com, description: 'The URL of the deployed application', exportName: 'myApp', }); ... } }

    CfnOutput コンストラクトの詳細については、「AWS Cloud Development Kit (AWS CDK) API リファレンス」の「インターフェイス CfnOutputProps」を参照してください。

  2. コードを保存してコミットします。

  3. アプリケーション URL が追加されたことを確認するには に進みます。

「CloudFormation スタックをデプロイ」アクションにアプリケーション URL を表示するには
  1. CloudFormation スタックをデプロイ」アクションを使用している場合は、CloudFormation テンプレートまたは AWS SAM テンプレートの Outputs セクションに、次の特徴を持つ出力を追加します。

    • キー (ロジカル ID とも呼ばれます) には、結合ダッシュ (-)、アンダースコア (_)、またはスペース ( ) の有無にかかわらず、appurl または endpointurl を含める必要があります。文字列は大文字と小文字を区別しません。

    • 値は、デプロイされたアプリケーションの http または https URL である必要があります。

    例えば、CloudFormation テンプレートは次のようになります。

    "Outputs" : { "APP-URL" : { "Description" : "The URL of the deployed app", "Value" : "https://mycompany.myapp.com", "Export" : { "Name" : "My App" } } }

    CloudFormation の詳細については、「AWS CloudFormation ユーザーガイド」の「出力」を参照してください。

  2. コードを保存してコミットします。

  3. アプリケーション URL が追加されたことを確認するには に進みます。

他のすべてのアクションでアプリ URL を表示するには

ビルドアクションや [GitHub アクション] などの別のアクションを使用してアプリケーションをデプロイする場合は、次の操作を実行してアプリケーション URL を表示します。

  1. ワークフロー定義ファイルのアクションの Inputs または Steps セクションで環境変数を定義します。変数には次の特性が必要です。

    • name には、結合ダッシュ (-)、アンダースコア (_)、またはスペース ( ) の有無にかかわらず、appurl または endpointurl を含める必要があります。文字列は大文字と小文字を区別しません。

    • 値は、デプロイされたアプリケーションの http または https URL である必要があります。

    例えば、ビルドアクションは次のようになります。

    Build-action: Identifier: aws/build@v1 Inputs: Variables: - Name: APP-URL Value: https://mycompany.myapp.com

    または、次のようになります。

    Actions: Build: Identifier: aws/build@v1 Configuration: Steps: - Run: APP-URL=https://mycompany.myapp.com

    定義環境変数の詳細については、「変数の定義」を参照してください。

  2. 変数をエクスポートします。

    例えば、ビルドアクションは次のようになります。

    Build-action: ... Outputs: Variables: - APP-URL

    エクスポート変数の詳細については、「他のアクションで使用できるように変数をエクスポートする」を参照してください。

  3. (オプション) [検証] を選択して、コミットする前にワークフローの YAML コードを検証します。

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

  5. アプリケーション URL が追加されたことを確認するには に進みます。

アプリケーション URL が追加されたことを確認するには
  • 自動的に開始していない場合は、ワークフローの実行を開始します。新しい実行では、ワークフロー図にクリック可能なリンクとしてアプリケーション URL が表示される必要があります。実行開始の詳細については、「手動でのワークフロー実行の開始」を参照してください。