Amazon S3 公開」アクション YAML - Amazon CodeCatalyst
S3PublishIdentifierDependsOnComputeTypeFleetTimeoutInputsSourcesArtifacts - inputVariables - inputEnvironmentNameConnectionsNameRoleConfigurationSourcePathDestinationBucketNameTargetPath

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

Amazon S3 公開」アクション YAML

Amazon S3 の公開アクションYAMLの定義を次に示します。このアクションの使用方法については、「」を参照してくださいワークフローを使用して Amazon S3 にファイルを発行する。

このアクション定義は、より広範なワークフロー定義ファイル内のセクションとして存在します。ファイルの詳細については、「ワークフローYAML定義」を参照してください。

注記

以下のYAMLプロパティのほとんどには、ビジュアルエディタに対応する UI 要素があります。UI 要素を検索するには、Ctrl+F を使用します。 要素は、関連付けられた YAMLプロパティとともに一覧表示されます。

# The workflow definition starts here.
# See 最上位のプロパティ for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  S3Publish_nn: 
    Identifier: aws/s3-publish@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      Sources:
        - source-name-1
      Artifacts:
        - artifact-name
      Variables:
        - Name: variable-name-1
          Value: variable-value-1
        - Name: variable-name-2
          Value: variable-value-2
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      SourcePath: my/source
      DestinationBucketName: s3-bucket-name
      TargetPath: my/target

S3Publish

(必須)

アクションの名前を指定します。すべてのアクション名は、ワークフロー内で一意である必要があります。アクション名は、英数字 (a～z、A～Z、0～9)、ハイフン (-)、アンダースコア (_) に制限されています。スペースは使用できません。引用符を使用してアクション名で特殊文字やスペースを有効にすることはできません。

デフォルト: S3Publish_nn。

対応する UI: 設定タブ/アクション名

Identifier

(S3Publish/Identifier)

(必須)

アクションを識別します。バージョンを変更しない限り、このプロパティを変更しないでください。詳細については、「使用するアクションバージョンの指定」を参照してください。

デフォルト: aws/s3-publish@v1。

対応する UI: ワークフロー図/S3Publish_nn/aws/s3-publish@v1 ラベル

DependsOn

(S3Publish/DependsOn)

(オプション)

このアクションを実行するために正常に実行する必要があるアクション、アクショングループ、またはゲートを指定します。

「依存」機能の詳細については、「」を参照してくださいシーケンスアクション。

対応する UI: の入力タブ/依存 - オプション

Compute

(S3Publish/Compute)

(オプション)

ワークフローアクションを実行するために使用されるコンピューティングエンジン。コンピューティングはワークフローレベルまたはアクションレベルで指定できますが、両方を指定することはできません。ワークフローレベルで指定すると、コンピューティング設定はワークフローで定義されたすべてのアクションに適用されます。ワークフローレベルでは、同じインスタンスで複数のアクションを実行することもできます。詳細については、「アクション間でのコンピューティングの共有」を参照してください。

対応する UI: なし

Type

(S3Publish/Compute/Type)

( Computeが含まれている場合は必須）

コンピューティングエンジンのタイプ。次のいずれかの値を使用できます。

  • EC2 (ビジュアルエディタ) または EC2 (YAML エディタ）

    アクション実行中の柔軟性のために最適化されました。

  • Lambda (ビジュアルエディタ) または Lambda (YAML エディタ）

    アクションの起動速度を最適化しました。

コンピューティングタイプの詳細については、「コンピューティングタイプ」を参照してください。

対応する UI: 設定タブ/コンピューティングタイプ

Fleet

(S3Publish/Compute/Fleet)

(オプション)

ワークフローまたはワークフローアクションを実行するマシンまたはフリートを指定します。オンデマンドフリートでは、アクションが開始されると、ワークフローは必要なリソースをプロビジョニングし、アクションが終了するとマシンは破棄されます。オンデマンドフリートの例: Linux.x86-64.Large、Linux.x86-64.XLarge。オンデマンドフリートの詳細については、「」を参照してくださいオンデマンドフリートのプロパティ。

プロビジョニングされたフリートでは、ワークフローアクションを実行するように一連の専用マシンを設定します。これらのマシンはアイドル状態のままで、すぐにアクションを処理できます。プロビジョニングされたフリートの詳細については、「」を参照してくださいプロビジョニングされたフリートのプロパティ。

Fleet を省略した場合、デフォルトは ですLinux.x86-64.Large。

対応する UI: 設定タブ/コンピューティングフリート

Timeout

(S3Publish/Timeout)

(必須)

がアクション CodeCatalyst を終了するまでにアクションを実行できる時間を分単位で指定します (YAML エディタ）、または時間と分単位で指定します (ビジュアルエディタ）。最小値は 5 分で、最大値は「」で説明されていますのワークフローのクォータ CodeCatalyst。デフォルトのタイムアウトは、最大タイムアウトと同じです。

対応する UI: 設定タブ/タイムアウト - オプション

Inputs

(S3Publish/Inputs)

(オプション)

Inputs セクションでは、ワークフローの実行中に がS3Publish必要とするデータを定義します。

注記

AWS CDK デプロイアクションごとに最大 4 つの入力 (1 つのソースと 3 つのアーティファクト) が許可されます。変数はこの合計にはカウントされません。

異なる入力 (ソースとアーティファクトなど) にあるファイルを参照する必要がある場合、ソース入力はプライマリ入力、アーティファクトはセカンダリ入力です。セカンダリ入力内のファイルへの参照には、プライマリからファイルを分割するための特別なプレフィックスが付けられます。詳細については、「例: 複数のアーティファクト内のファイルを参照する」を参照してください。

対応する UI: Inputs タブ

Sources

(S3Publish/Inputs/Sources)

(Amazon S3 に発行するファイルがソースリポジトリに保存されている場合に必要です）

Amazon S3 に発行するファイルがソースリポジトリに保存されている場合は、そのソースリポジトリのラベルを指定します。現在、サポートされているラベルは のみですWorkflowSource。

Amazon S3 に公開するファイルがソースリポジトリに含まれていない場合は、別のアクションによって生成されたアーティファクトに存在する必要があります。

sources の詳細については、「ソースリポジトリをワークフローに接続する」を参照してください。

対応する UI: 入力タブ/ソース - オプション

Artifacts - input

(S3Publish/Inputs/Artifacts)

(Amazon S3 に発行するファイルが、前のアクションの出力アーティファクトに保存されている場合に必要です）

Amazon S3 に公開するファイルが、前のアクションによって生成されたアーティファクトに含まれている場合は、ここでそのアーティファクトを指定します。ファイルがアーティファクトに含まれていない場合は、ソースリポジトリに存在する必要があります。

アーティファクトの詳細については、「」を参照してくださいアクション間でのアーティファクトとファイルの共有。

対応する UI: 設定タブ/アーティファクト - オプション

Variables - input

(S3Publish/Inputs/Variables)

(オプション)

アクションで使用できるようにしたい入力変数を定義する名前と値のペアのシーケンスを指定します。変数名は、英数字 (a～z、A～Z、0～9)、ハイフン (-)、アンダースコア (_) に制限されています。スペースは使用できません。変数名で特殊文字やスペースを有効にするために引用符を使用することはできません。

例を含む変数の詳細については、「」を参照してくださいワークフローでの変数の使用。

対応する UI: 入力タブ/変数 - オプション

Environment

(S3Publish/Environment)

(必須)

アクションで使用する CodeCatalyst 環境を指定します。アクションは、選択した環境でVPC指定された AWS アカウント およびオプションの Amazon に接続します。アクションは、環境で指定されたデフォルトのIAMロールを使用して に接続し AWS アカウント、Amazon VPC接続で指定されたIAMロールを使用して Amazon に接続しますVPC。

注記

デフォルトのIAMロールに アクションに必要なアクセス許可がない場合は、別のロールを使用するようにアクションを設定できます。詳細については、「アクションのIAMロールの変更」を参照してください。

環境の詳細については、AWS アカウント と へのデプロイ VPCs「」および「」を参照してください環境を作成する。

対応する UI: 設定タブ/環境

Name

(S3Publish/Environment/Name)

( Environmentが含まれている場合は必須）

アクションに関連付ける既存の環境の名前を指定します。

対応する UI: 設定タブ/環境

Connections

(S3Publish/Environment/Connections)

（新しいバージョンの アクションではオプション。古いバージョンでは必須）

アクションに関連付けるアカウント接続を指定します。で最大 1 つのアカウント接続を指定できますEnvironment。

アカウント接続を指定しない場合：

  • アクションは、 CodeCatalyst コンソールの環境で指定された AWS アカウント 接続とデフォルトのIAMロールを使用します。アカウント接続とデフォルトIAMロールを環境に追加する方法については、「」を参照してください環境を作成する。

  • デフォルトのIAMロールには、 アクションに必要なポリシーとアクセス許可が含まれている必要があります。これらのポリシーとアクセス許可を確認するには、アクションYAMLの定義ドキュメントの「ロール」プロパティの説明を参照してください。

アカウント接続の詳細については、「」を参照してください接続された AWS リソースへのアクセスを許可する AWS アカウント。環境へのアカウント接続の追加については、「」を参照してください環境を作成する。

対応する UI: アクションのバージョンに応じて、次のいずれかになります。

  • （新しいバージョン) 設定タブ/環境/ の内容 my-environment?/3 つのドットメニュー/スイッチロール

  • （旧バージョン) 設定タブ/'環境/アカウント/ロール'/ AWS アカウント接続

Name

(S3Publish/Environment/Connections/Name)

( Connectionsが含まれている場合は必須）

アカウント接続の名前を指定します。

対応する UI: アクションのバージョンに応じて、次のいずれかになります。

  • （新しいバージョン) 設定タブ/環境/ の内容 my-environment?/3 つのドットメニュー/スイッチロール

  • （旧バージョン) 設定タブ/'環境/アカウント/ロール'/ AWS アカウント接続

Role

(S3Publish/Environment/Connections/Role)

( Connectionsが含まれている場合は必須）

Amazon S3 公開アクションが Amazon S3 へのアクセス AWS とファイルのコピーに使用するIAMロールの名前を指定しますAmazon S3。スペース にロールを追加し CodeCatalyst 、ロールに次のポリシーが含まれていることを確認してください。

IAM ロールを指定しない場合、アクションは CodeCatalyst コンソールの 環境にリストされているデフォルトのIAMロールを使用します。環境でデフォルトのロールを使用する場合は、次のポリシーがあることを確認してください。

  • 次のアクセス許可ポリシー：

    警告

    アクセス許可を次のポリシーに示すものに制限します。より広範なアクセス許可を持つロールを使用すると、セキュリティ上のリスクが生じる可能性があります。

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:ListBucket",
                "s3:DeleteObject"
            ],
            "Resource": [
                "arn:aws:s3:::bucket-name",
                "arn:aws:s3:::bucket-name/*"
            ]
        }
    ]
}

  • 次のカスタム信頼ポリシー：

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}
注記

必要に応じて、このアクションでCodeCatalystWorkflowDevelopmentRole-spaceNameロールを使用できます。このロールの詳細については、「アカウントとスペースのCodeCatalystWorkflowDevelopmentRole-spaceNameロールの作成」を参照してください。CodeCatalystWorkflowDevelopmentRole-spaceName ロールには、セキュリティリスクをもたらす可能性のあるフルアクセス許可があることを理解します。このロールは、セキュリティが懸念されないチュートリアルとシナリオでのみ使用することをお勧めします。

対応する UI: アクションのバージョンに応じて、次のいずれかになります。

  • （新しいバージョン) 設定タブ/環境/ の内容 my-environment?/3 つのドットメニュー/切り替えロール

  • （旧バージョン) 設定タブ/'環境/アカウント/ロール'/ロール

Configuration

(S3Publish/Configuration)

(必須)

アクションの設定プロパティを定義できるセクション。

対応する UI: 設定タブ

SourcePath

(S3Publish/Configuration/SourcePath)

(必須)

Amazon S3 に発行するディレクトリまたはファイルの名前とパスを指定します。ディレクトリまたはファイルは、ソースリポジトリまたは前のアクションのアーティファクトに存在し、ソースリポジトリまたはアーティファクトルートを基準にしています。

例:

を指定すると、 の内容/myFolderが Amazon S3 ./myFolder/にコピーされ、基になるディレクトリ構造が保持されます。

Amazon S3 へのmyfile.txt./myFolder/myfile.txtコピーのみを指定します。（ディレクトリ構造は削除されます）。

ワイルドカードは使用できません。

注記

ディレクトリまたはファイルパスにプレフィックスを追加して、検索するアーティファクトまたはソースを示す必要がある場合があります。詳細については、「ソースリポジトリファイルを参照する」および「アーティファクト内のファイルを参照する」を参照してください。

対応する UI: 設定タブ/ソースパス

DestinationBucketName

(S3Publish/Configuration/DestinationBucketName)

(必須)

ファイルを発行する Amazon S3 バケットの名前を指定します。

対応する UI: 設定タブ/送信先バケット - オプション

TargetPath

(S3Publish/Configuration/TargetPath)

(オプション)

ファイルを発行する Amazon S3 のディレクトリの名前とパスを指定します。ディレクトリが存在しない場合は、作成されます。ディレクトリパスにバケット名を含めることはできません。

例:

myS3Folder

./myS3Folder/myS3Subfolder

対応する UI: 設定タブ/送信先ディレクトリ - オプション