AWS CodeStar 範例使用 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

AWS CodeStar 範例使用 AWS CLI

下列程式碼範例說明如何使用 AWS Command Line Interface 與來執行動作及實作常見案例 AWS CodeStar。

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用associate-team-member

AWS CLI

若要將小組成員加入至專案

下列associate-team-member範例會讓使用intern者成為具有指定 ID 之專案的檢視者。

aws codestar associate-team-member \ --project-id my-project \ --user-arn arn:aws:iam::123456789012:user/intern \ --project-role Viewer

此命令不會產生輸出。

下列程式碼範例會示範如何使用create-project

AWS CLI

建立專案的步驟

下列create-project範例使用 JSON 輸入檔案來建立 CodeStar 專案。

aws codestar create-project \ --cli-input-json file://create-project.json

create-project.json 的內容:

{ "name": "Custom Project", "id": "custom-project", "sourceCode": [ { "source": { "s3": { "bucketName": "codestar-artifacts", "bucketKey": "nodejs-function.zip" } }, "destination": { "codeCommit": { "name": "codestar-custom-project" } } } ], "toolchain": { "source": { "s3": { "bucketName": "codestar-artifacts", "bucketKey": "toolchain.yml" } }, "roleArn": "arn:aws:iam::123456789012:role/service-role/aws-codestar-service-role", "stackParameters": { "ProjectId": "custom-project" } } }

輸出:

{ "id": "my-project", "arn": "arn:aws:codestar:us-east-2:123456789012:project/custom-project" }

如需包含自訂專案範例程式碼和範本的教學課程,請參閱< https://docs.aws.amazon.com/codestar/latest/userguide/cli-tutorial.html > AWS CodeStar 使用指南中 AWS CodeStar 的使用 AWS CLI 建立專案。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考CreateProject中的。

下列程式碼範例會示範如何使用create-user-profile

AWS CLI

若要建立使用者設定檔

下列create-user-profile範例會為具有指定 ARN 的 IAM 使用者建立使用者設定檔。

aws codestar create-user-profile \ --user-arn arn:aws:iam::123456789012:user/intern \ --display-name Intern \ --email-address intern@example.com

輸出:

{ "userArn": "arn:aws:iam::123456789012:user/intern", "displayName": "Intern", "emailAddress": "intern@example.com", "sshPublicKey": "", "createdTimestamp": 1572552308.607, "lastModifiedTimestamp": 1572552308.607 }

下列程式碼範例會示範如何使用delete-project

AWS CLI

若要刪除專案

下列delete-project範例會刪除指定的專案。

aws codestar delete-project \ --project-id my-project

輸出:

{ "projectArn": "arn:aws:codestar:us-east-2:123456789012:project/my-project" }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DeleteProject中的。

下列程式碼範例會示範如何使用delete-user-profile

AWS CLI

若要刪除使用者設定檔

下列delete-user-profile範例會刪除具有指定 ARN 之使用者的使用者設定檔。

aws codestar delete-user-profile \ --user-arn arn:aws:iam::123456789012:user/intern

輸出:

{ "userArn": "arn:aws:iam::123456789012:user/intern" }

下列程式碼範例會示範如何使用describe-project

AWS CLI

檢視專案的步驟

下列describe-project範例會擷取有關指定專案的詳細資訊。

aws codestar describe-project \ --id my-project

輸出:

{ "name": "my project", "id": "my-project", "arn": "arn:aws:codestar:us-west-2:123456789012:project/my-project", "description": "My first CodeStar project.", "createdTimeStamp": 1572547510.128, "status": { "state": "CreateComplete" } }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DescribeProject中的。

下列程式碼範例會示範如何使用describe-user-profile

AWS CLI

若要檢視使用者設定檔

下列describe-user-profile範例會擷取有關具有指定 ARN 之使用者之使用者設定檔的詳細資料。

aws codestar describe-user-profile \ --user-arn arn:aws:iam::123456789012:user/intern

輸出:

{ "userArn": "arn:aws:iam::123456789012:user/intern", "displayName": "Intern", "emailAddress": "intern@example.com", "sshPublicKey": "intern", "createdTimestamp": 1572552308.607, "lastModifiedTimestamp": 1572553495.47 }

下列程式碼範例會示範如何使用disassociate-team-member

AWS CLI

若要移除團隊成員

下列disassociate-team-member範例會從專my-project案中移除具有指定 ARN 的使用者。

aws codestar disassociate-team-member \ --project-id my-project \ --user-arn arn:aws:iam::123456789012:user/intern

此命令不會產生輸出。

下列程式碼範例會示範如何使用list-projects

AWS CLI

若要檢視專案

下列list-projects範例會擷取目前 Region 中的專案清單。

aws codestar list-projects

輸出:

{ "projects": [ { "projectId": "intern-projects", "projectArn": "arn:aws:codestar:us-west-2:123456789012:project/intern-projects" }, { "projectId": "my-project", "projectArn": "arn:aws:codestar:us-west-2:123456789012:project/my-project" } ] }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListProjects中的。

下列程式碼範例會示範如何使用list-resources

AWS CLI

若要檢視資源

下列list-resources範例會擷取指定專案的資源清單。

aws codestar list-resources \ --id my-project

輸出:

{ "resources": [ { "id": "arn:aws:execute-api:us-east-2:123456789012:r3wxmplbv8" }, { "id": "arn:aws:codedeploy:us-east-2:123456789012:application:awscodestar-my-project-lambda-ServerlessDeploymentApplication-PF0LXMPL1KA0" }, { "id": "arn:aws:s3:::aws-codestar-us-east-2-123456789012-my-project-pipe" }, { "id": "arn:aws:lambda:us-east-2:123456789012:function:awscodestar-my-project-lambda-GetHelloWorld-16W3LVXMPLNNS" }, { "id": "arn:aws:cloudformation:us-east-2:123456789012:stack/awscodestar-my-project-lambda/b4904ea0-fc20-xmpl-bec6-029123b1cc42" }, { "id": "arn:aws:cloudformation:us-east-2:123456789012:stack/awscodestar-my-project/1b133f30-fc20-xmpl-a93a-0688c4290cb8" }, { "id": "arn:aws:iam::123456789012:role/CodeStarWorker-my-project-ToolChain" }, { "id": "arn:aws:iam::123456789012:policy/CodeStar_my-project_PermissionsBoundary" }, { "id": "arn:aws:s3:::aws-codestar-us-east-2-123456789012-my-project-app" }, { "id": "arn:aws:codepipeline:us-east-2:123456789012:my-project-Pipeline" }, { "id": "arn:aws:codedeploy:us-east-2:123456789012:deploymentgroup:my-project/awscodestar-my-project-lambda-GetHelloWorldDeploymentGroup-P7YWXMPLT0QB" }, { "id": "arn:aws:iam::123456789012:role/CodeStar-my-project-Execution" }, { "id": "arn:aws:iam::123456789012:role/CodeStarWorker-my-project-CodeDeploy" }, { "id": "arn:aws:codebuild:us-east-2:123456789012:project/my-project" }, { "id": "arn:aws:iam::123456789012:role/CodeStarWorker-my-project-CloudFormation" }, { "id": "arn:aws:codecommit:us-east-2:123456789012:Go-project" } ] }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListResources中的。

下列程式碼範例會示範如何使用list-tags-for-project

AWS CLI

若要檢視專案的標籤

下列list-tags-for-project範例會擷取附加至指定專案的標籤。

aws codestar list-tags-for-project \ --id my-project

輸出:

{ "tags": { "Department": "Marketing", "Team": "Website" } }

下列程式碼範例會示範如何使用list-team-members

AWS CLI

若要檢視團隊成員清單

下列list-team-members範例會擷取與指定專案相關聯的使用者清單。

aws codestar list-team-members \ --project-id my-project

輸出:

{ "teamMembers": [ { "userArn": "arn:aws:iam::123456789012:user/admin", "projectRole": "Owner", "remoteAccessAllowed": false }, { "userArn": "arn:aws:iam::123456789012:user/intern", "projectRole": "Contributor", "remoteAccessAllowed": false } ] }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListTeamMembers中的。

下列程式碼範例會示範如何使用list-user-profiles

AWS CLI

若要檢視使用者設定檔清單

下列list-user-profiles範例會擷取目前 Region 中所有使用者設定檔的清單。

aws codestar list-user-profiles

輸出:

{ "userProfiles": [ { "userArn": "arn:aws:iam::123456789012:user/admin", "displayName": "me", "emailAddress": "me@example.com", "sshPublicKey": "" }, { "userArn": "arn:aws:iam::123456789012:user/intern", "displayName": "Intern", "emailAddress": "intern@example.com", "sshPublicKey": "intern" } ] }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListUserProfiles中的。

下列程式碼範例會示範如何使用tag-project

AWS CLI

將標籤貼附至專案的步驟

下列tag-project範例會將名為的標籤Department和值新增Marketing至指定專案。

aws codestar tag-project \ --id my-project \ --tags Department=Marketing

輸出:

{ "tags": { "Department": "Marketing" } }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考TagProject中的。

下列程式碼範例會示範如何使用untag-project

AWS CLI

從專案中移除標籤的步驟

下列untag-project範例會從指定專案移除任何索引鍵名Team稱為的標籤。

aws codestar untag-project \ --id my-project \ --tags Team

此命令不會產生輸出。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考UntagProject中的。

下列程式碼範例會示範如何使用update-project

AWS CLI

更新專案的步驟

下列update-project範例會將描述加入至指定的專案。

aws codestar update-project \ --id my-project \ --description "My first CodeStar project"

此命令不會產生輸出。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考UpdateProject中的。

下列程式碼範例會示範如何使用update-team-member

AWS CLI

若要修改專案團隊成員

下列update-team-member範例會讓指定的使用者成為專案的參與者,並授予他們專案資源的遠端存取權。

aws codestar update-team-member \ --project-id my-project \ --user-arn arn:aws:iam::123456789012:user/intern \ --project-role Contributor -\ --remote-access-allowed

輸出:

{ "userArn": "arn:aws:iam::123456789012:user/intern", "projectRole": "Contributor", "remoteAccessAllowed": true }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考UpdateTeamMember中的。

下列程式碼範例會示範如何使用update-user-profile

AWS CLI

若要修改使用者設定檔

下列update-user-profile範例會將指定的 SHH 金鑰加入至指定的使用者。

aws codestar update-user-profile \ --ssh-public-key intern \ --user-arn arn:aws:iam::123456789012:user/intern

輸出:

{ "userArn": "arn:aws:iam::123456789012:user/intern", "displayName": "Intern", "emailAddress": "intern@example.com", "sshPublicKey": "intern", "createdTimestamp": 1572552308.607, "lastModifiedTimestamp": 1572553495.47 }