S3Publish Identifier DependsOn Compute Type Fleet Timeout Inputs Sources Artifacts - input Variables - input Environment Name Connections Name Role Configuration SourcePath DestinationBucketName TargetPath

「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

(S3 出版/Identifier)

(必要)

識別動作。除非您要變更版本，否則請勿變更此屬性。如需詳細資訊，請參閱指定要使用的動作版本。

預設：aws/s3-publish@v1。

對應的使用者介面：工作流程圖/S3Publish_nn/ aws/S3-發佈 @v1 標籤

DependsOn

(S3 出版/DependsOn)

(選用)

指定必須成功執行的動作、動作群組或閘道，才能執行此動作。

如需有關「依賴」功能的詳細資訊，請參閱。排序動作

對應的用戶界面：輸入選項卡/取決於- 可選

Compute

(S3 出版/Compute)

(選用)

用來執行工作流程動作的計算引擎。您可以在工作流程層級或動作層級指定計算，但不能同時指定兩者。在工作流程層級指定時，計算組態會套用至工作流程中定義的所有動作。在工作流程層級，您也可以在相同的執行個體上執行多個動作。如需詳細資訊，請參閱跨動作共用運算。

對應的用戶界面：無

Type

(S3 出版/Compute/Type)

（如果包含Compute，則為必填）

運算引擎的類型。您可以使用下列其中一個值：

EC2（可視化編輯器）或EC2（YAML編輯器）

優化了動作運行期間的靈活性。
Lambda（可視化編輯器）或Lambda（YAML編輯器）

優化動作啟動速度。

如需運算類型的更多相關資訊，請參閱運算類型。

對應的 UI：組態索引標籤/運算類型

Fleet

(S3 出版/Compute/Fleet)

(選用)

指定將執行工作流程或工作流程動作的機器或叢集。對於隨需叢集，當動作開始時，工作流程會佈建所需的資源，並在動作完成時銷毀機器。隨選艦隊的範例：Linux.x86-64.Large、Linux.x86-64.XLarge。如需隨選叢集的詳細資訊，請參閱隨選叢集屬性。

透過佈建的叢集，您可以設定一組專用機器來執行工作流程動作。這些機器保持閒置狀態，可立即處理動作。如需已佈建叢集的詳細資訊，請參閱佈建的叢集屬性。

如Fleet果省略，預設值為Linux.x86-64.Large。

對應的 UI：組態索引標籤/運算叢集

Timeout

(S3 出版/Timeout)

(必要)

指定動作在 CodeCatalyst 結束動作之前可執行的時間長度 (以分鐘為單位) 或小時和分鐘 (視覺化編輯器)。YAML最小值為 5 分鐘，最大值在中說明中工作流程的配額 CodeCatalyst。預設逾時與逾時上限相同。

對應的 UI：配置選項卡/超時- 可選

Inputs

(S3 出版/Inputs)

(選用)

本Inputs節定義了工作流程執行期間所S3Publish需的資料。

注意

每個AWS CDK 部署動作最多允許四個輸入 (一個來源和三個成品)。變數不會計入此總數。

如果您需要引用駐留在不同輸入中的文件（例如源和工件），則源輸入是主輸入，並且工件是輔助輸入。輔助輸入中的文件的引用採用特殊前綴，以將它們從主輸入中刪除。如需詳細資訊，請參閱範例：參考多個成品中的檔案。

對應的 UI：輸入索引標籤

Sources

(S3 出版/Inputs/Sources)

(如果您要發佈到 Amazon S3 的檔案存放在來源儲存庫中，則需要此選項)

如果您要發佈到 Amazon S3 的檔案存放在來源儲存庫中，請指定該來源儲存庫的標籤。目前，唯一支援的標籤是WorkflowSource。

如果您要發佈到 Amazon S3 的檔案不包含在來源儲存庫中，則它們必須位於由另一個動作產生的成品中。

如需來源的詳細資訊，請參閱將來源儲存庫連線至工作。

對應的用戶界面：輸入選項卡/源- 可選

Artifacts - input

(S3 出版/Inputs/Artifacts)

(如果您要發佈到 Amazon S3 的檔案存放在先前動作的輸出成品中，則為必要)

如果您要發佈到 Amazon S3 的檔案包含在先前動作所產生的成品中，請在此處指定該成品。如果您的檔案不包含在成品中，則它們必須位於來源儲存庫中。

如需人工因素的詳細資訊 (包括範例)，請參閱在動作之間共用成品和檔案。

對應的 UI：組態索引標籤/成品- 選用

Variables - input

(S3 出版/Inputs/Variables)

(選用)

指定一系列名稱/值配對，這些配對定義您要讓動作可用的輸入變數。變數名稱限制為英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (_)。不允許空格。您無法使用引號來啟用變數名稱中的特殊字元和空格。

如需有關變數的更多資訊 (包括範例)，請參閱在工作流中使用變數。

對應的用戶界面：輸入選項卡/變量- 可選

Environment

(S3 出版/Environment)

(必要)

指定要與動作搭配使用的 CodeCatalyst 環境。該動作連接到所選環境中VPC指定的 AWS 帳戶和可選的 Amazon。該動作使用環境中指定的預設IAM角色連接到 AWS 帳戶，並使用 Amazon VPC 連接中指定的IAM角色連接到 Amazon VPC。

注意

如果預設IAM角色沒有動作所需的權限，您可以將動作配置為使用其他角色。如需詳細資訊，請參閱變更動IAM作的角色。

若要取得有關環境的更多資訊，請參閱部署到 AWS 帳戶和 VPCs和建立環境。

對應的 UI：配置選項卡/環境

Name

(S3 出版/Environment/Name)

（如果包含Environment，則為必填）

指定您要與動作相關聯的現有環境名稱。

對應的 UI：配置選項卡/環境

Connections

(S3 出版/Environment/Connections)

(在較新版本的動作中為選用項目；舊版本為必要)

指定要與動作相關聯的帳號連線。您最多可以在下指定一個帳戶連線Environment。

如果您未指定帳戶連線：

此動作會使用在 CodeCatalyst 主控台環境中指定的 AWS 帳戶連線和預設IAM角色。如需將帳戶連線和預設IAM角色新增至環境的資訊，請參閱建立環境。
預設IAM角色必須包含動作所需的原則和權限。若要判斷這些原則和權限是什麼，請參閱動作的YAML定義文件中角色屬性的說明。

如需有關帳戶連線的詳細資訊，請參閱允許存取已連線的 AWS 資源 AWS 帳戶。如需將帳戶連線新增至環境的資訊，請參閱建立環境。

對應的使用者介面：下列其中一項視動作版本而定：

（較新版本）配置選項卡/環境/中有什麼 my-environment? /三點菜單/切換角色
（舊版本）配置選項卡/「環境/帳戶/角色」/帳AWS 戶連接

Name

(S3 出版/Environment/Connections/Name)

（如果包含Connections，則為必填）

指定帳戶連線的名稱。

對應的使用者介面：下列其中一項視動作版本而定：

（較新版本）配置選項卡/環境/中有什麼 my-environment? /三點菜單/切換角色
（舊版本）配置選項卡/「環境/帳戶/角色」/帳AWS 戶連接

Role

(S3 出版/Environment/Connections/Role)

（如果包含Connections，則為必填）

指定 Amazon S3 發佈動作用來存取檔案 AWS 並將檔案複製到 Amazon S3 的IAM角色名稱。請確定您已將角色新增至您的 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角色具有可能造成安全風險的完整存取權限。我們建議您只在不太擔心安全性的教學課程和案例中使用此角色。

對應的使用者介面：下列其中一項視動作版本而定：

（較新版本）配置選項卡/環境/中有什麼 my-environment? /三點菜單/切換角色
(舊版) 組態索引標籤/「環境/帳戶/角色」/「角色」

Configuration

(S3 出版/Configuration)

(必要)

您可以在其中定義動作的組態屬性的區段。

對應的 UI：組態索引標籤

SourcePath

(S3 出版/Configuration/SourcePath)

(必要)

指定您要發佈到 Amazon S3 之目錄或檔案的名稱和路徑。目錄或檔案可以位於來源儲存庫或上一個動作的人工因素中，且相對於來源儲存庫或人工因素根目錄。

範例：

指定會./myFolder/將的內容複製/myFolder到 Amazon S3，並保留基礎目錄結構。

只指定 Amazon S3 myfile.txt 的./myFolder/myfile.txt副本。（目錄結構被刪除。）

您不能使用萬用字元。

注意

您可能需要在目錄或檔案路徑中新增前置詞，以指出要在其中尋找的成品或來源。如需詳細資訊，請參閱參考來源儲存庫檔案及參考人工因素中的檔案。

對應的 UI：配置選項卡/源路徑

DestinationBucketName

(S3 出版/Configuration/DestinationBucketName)

(必要)

指定您要在其中發佈檔案的 Amazon S3 儲存貯體的名稱。

對應的 UI：配置選項卡/目標存儲桶- 可選

TargetPath

(S3 出版/Configuration/TargetPath)

(選用)

在 Amazon S3 中指定您要發佈檔案的目錄名稱和路徑。如果目錄不存在，它將被創建。目錄路徑不得包含值區名稱。

範例：

myS3Folder

./myS3Folder/myS3Subfolder

對應的 UI：配置選項卡/目標目錄- 可選

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

添加「Amazon S3 發布」操作

部署到 AWS 帳戶和 VPCs