Doc AWS SDK ExamplesWord リポジトリには、さらに多くの GitHub の例があります。 AWS SDK
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
を使用したCodeDeploy の例 AWS CLI
次のコード例は、 CodeDeploy AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。
トピック
アクション
次のコード例は、add-tags-to-on-premises-instances
を使用する方法を示しています。
- AWS CLI
-
オンプレミスインスタンスにタグを追加するには
次の
add-tags-to-on-premises-instances
例では、同じオンプレミスインスタンスタグを 2 つのオンプレミスインスタンスに in AWS CodeDeploy を関連付けます。オンプレミスインスタンスを AWS CodeDeploy に登録しません。aws deploy add-tags-to-on-premises-instances \ --instance-names
AssetTag12010298EX
AssetTag23121309EX
\ --tagsKey=Name,Value=CodeDeployDemo-OnPrem
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のAddTagsToOnPremisesInstances
」を参照してください。
-
次の例は、batch-get-application-revisions
を使用する方法を説明しています。
- AWS CLI
-
アプリケーションリビジョンに関する情報を取得するには
次の
batch-get-application-revisions
例では、a GitHub リポジトリに保存されている指定されたリビジョンに関する情報を取得します。aws deploy batch-get-application-revisions \ --application-name
my-codedeploy-application
\ --revisions "[{\"gitHubLocation\": {\"commitId\": \"fa85936EXAMPLEa31736c051f10d77297EXAMPLE\",\"repository\": \"my-github-token/my-repository\"},\"revisionType\": \"GitHub\"}]"出力:
{ "revisions": [ { "genericRevisionInfo": { "description": "Application revision registered by Deployment ID: d-A1B2C3111", "lastUsedTime": 1556912355.884, "registerTime": 1556912355.884, "firstUsedTime": 1556912355.884, "deploymentGroups": [] }, "revisionLocation": { "revisionType": "GitHub", "gitHubLocation": { "commitId": "fa85936EXAMPLEa31736c051f10d77297EXAMPLE", "repository": "my-github-token/my-repository" } } } ], "applicationName": "my-codedeploy-application", "errorMessage": "" }
詳細については、BatchGetApplicationRevisions AWS リファレンスの APICodeDeploy を参照してください。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のBatchGetApplicationRevisions
」を参照してください。
-
次の例は、batch-get-applications
を使用する方法を説明しています。
- AWS CLI
-
複数のアプリケーションに関する情報を取得するには
次の
batch-get-applications
例は、ユーザーの AWS アカウントに関連付けられている複数のアプリケーションに関する情報を示しています。aws deploy batch-get-applications --application-names
WordPress_App
MyOther_App
出力:
{ "applicationsInfo": [ { "applicationName": "WordPress_App", "applicationId": "d9dd6993-f171-44fa-a811-211e4EXAMPLE", "createTime": 1407878168.078, "linkedToGitHub": false }, { "applicationName": "MyOther_App", "applicationId": "8ca57519-31da-42b2-9194-8bb16EXAMPLE", "createTime": 1407453571.63, "linkedToGitHub": false } ] }
-
API の詳細については、 AWS CLI コマンドリファレンスのBatchGetApplications
」を参照してください。
-
次の例は、batch-get-deployment-groups
を使用する方法を説明しています。
- AWS CLI
-
1 つ以上のデプロイグループに関する情報を取得するには
次の
batch-get-deployment-groups
例では、指定された CodeDeploy アプリケーションに関連付けられている 2 つのデプロイグループに関する情報を取得します。aws deploy batch-get-deployment-groups \ --application-name
my-codedeploy-application
\ --deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]"出力:
{ "deploymentGroupsInfo": [ { "deploymentStyle": { "deploymentOption": "WITHOUT_TRAFFIC_CONTROL", "deploymentType": "IN_PLACE" }, "autoRollbackConfiguration": { "enabled": false }, "onPremisesTagSet": { "onPremisesTagSetList": [] }, "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole", "lastAttemptedDeployment": { "endTime": 1556912366.415, "status": "Failed", "createTime": 1556912355.884, "deploymentId": "d-A1B2C3111" }, "autoScalingGroups": [], "deploymentGroupName": "my-deployment-group-1", "ec2TagSet": { "ec2TagSetList": [ [ { "Type": "KEY_AND_VALUE", "Value": "my-EC2-instance", "Key": "Name" } ] ] }, "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111example", "triggerConfigurations": [], "applicationName": "my-codedeploy-application", "computePlatform": "Server", "deploymentConfigName": "CodeDeployDefault.AllAtOnce" }, { "deploymentStyle": { "deploymentOption": "WITHOUT_TRAFFIC_CONTROL", "deploymentType": "IN_PLACE" }, "autoRollbackConfiguration": { "enabled": false }, "onPremisesTagSet": { "onPremisesTagSetList": [] }, "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole", "autoScalingGroups": [], "deploymentGroupName": "my-deployment-group-2", "ec2TagSet": { "ec2TagSetList": [ [ { "Type": "KEY_AND_VALUE", "Value": "my-EC2-instance", "Key": "Name" } ] ] }, "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-22222example", "triggerConfigurations": [], "applicationName": "my-codedeploy-application", "computePlatform": "Server", "deploymentConfigName": "CodeDeployDefault.AllAtOnce" } ], "errorMessage": "" }
詳細については、BatchGetDeploymentGroups AWS リファレンスの APICodeDeploy を参照してください。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のBatchGetDeploymentGroups
」を参照してください。
-
次のコード例は、batch-get-deployment-targets
を使用する方法を示しています。
- AWS CLI
-
デプロイに関連付けられたターゲットを取得するには
次の
batch-get-deployment-targets
例では、指定されたデプロイに関連付けられたターゲットの 1 つに関する情報を返します。aws deploy batch-get-deployment-targets \ --deployment-id
"d-1A2B3C4D5"
\ --target-ids"i-01a2b3c4d5e6f1111"
出力:
{ "deploymentTargets": [ { "deploymentTargetType": "InstanceTarget", "instanceTarget": { "lifecycleEvents": [ { "startTime": 1556918592.162, "lifecycleEventName": "ApplicationStop", "status": "Succeeded", "endTime": 1556918592.247, "diagnostics": { "scriptName": "", "errorCode": "Success", "logTail": "", "message": "Succeeded" } }, { "startTime": 1556918593.193, "lifecycleEventName": "DownloadBundle", "status": "Succeeded", "endTime": 1556918593.981, "diagnostics": { "scriptName": "", "errorCode": "Success", "logTail": "", "message": "Succeeded" } }, { "startTime": 1556918594.805, "lifecycleEventName": "BeforeInstall", "status": "Succeeded", "endTime": 1556918681.807, "diagnostics": { "scriptName": "", "errorCode": "Success", "logTail": "", "message": "Succeeded" } } ], "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a2b3c4d5e6f1111", "deploymentId": "d-1A2B3C4D5", "lastUpdatedAt": 1556918687.504, "targetId": "i-01a2b3c4d5e6f1111", "status": "Succeeded" } } ] }
詳細については、BatchGetDeploymentTargets AWS リファレンスの APICodeDeploy を参照してください。
-
API の詳細については、 AWS CLI コマンドリファレンスの BatchGetDeploymentTargets
を参照してください。
-
次の例は、batch-get-deployments
を使用する方法を説明しています。
- AWS CLI
-
複数のデプロイに関する情報を取得するには
次の
batch-get-deployments
例は、ユーザーの AWS アカウントに関連付けられている複数のデプロイに関する情報を示しています。aws deploy batch-get-deployments --deployment-ids
d-A1B2C3111
d-A1B2C3222
出力:
{ "deploymentsInfo": [ { "applicationName": "WordPress_App", "status": "Failed", "deploymentOverview": { "Failed": 0, "InProgress": 0, "Skipped": 0, "Succeeded": 1, "Pending": 0 }, "deploymentConfigName": "CodeDeployDefault.OneAtATime", "creator": "user", "deploymentGroupName": "WordPress_DG", "revision": { "revisionType": "S3", "s3Location": { "bundleType": "zip", "version": "uTecLusEXAMPLEFXtfUcyfV8bEXAMPLE", "bucket": "CodeDeployDemoBucket", "key": "WordPressApp.zip" } }, "deploymentId": "d-A1B2C3111", "createTime": 1408480721.9, "completeTime": 1408480741.822 }, { "applicationName": "MyOther_App", "status": "Failed", "deploymentOverview": { "Failed": 1, "InProgress": 0, "Skipped": 0, "Succeeded": 0, "Pending": 0 }, "deploymentConfigName": "CodeDeployDefault.OneAtATime", "creator": "user", "errorInformation": { "message": "Deployment failed: Constraint default violated: No hosts succeeded.", "code": "HEALTH_CONSTRAINTS" }, "deploymentGroupName": "MyOther_DG", "revision": { "revisionType": "S3", "s3Location": { "bundleType": "zip", "eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"", "bucket": "CodeDeployDemoBucket", "key": "MyOtherApp.zip" } }, "deploymentId": "d-A1B2C3222", "createTime": 1409764576.589, "completeTime": 1409764596.101 } ] }
-
API の詳細については、 AWS CLI コマンドリファレンスの BatchGetDeployments
を参照してください。
-
次の例は、batch-get-on-premises-instances
を使用する方法を説明しています。
- AWS CLI
-
1 つ以上のオンプレミスインスタンスに関する情報を取得するには
次の
batch-get-on-premises-instances
例では、2 つのオンプレミスインスタンスに関する情報を取得します。aws deploy batch-get-on-premises-instances --instance-names
AssetTag12010298EX
AssetTag23121309EX
出力:
{ "instanceInfos": [ { "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX", "tags": [ { "Value": "CodeDeployDemo-OnPrem", "Key": "Name" } ], "instanceName": "AssetTag12010298EX", "registerTime": 1425579465.228, "instanceArn": "arn:aws:codedeploy:us-west-2:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh" }, { "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag23121309EX", "tags": [ { "Value": "CodeDeployDemo-OnPrem", "Key": "Name" } ], "instanceName": "AssetTag23121309EX", "registerTime": 1425595585.988, "instanceArn": "arn:aws:codedeploy:us-west-2:80398EXAMPLE:instance/AssetTag23121309EX_PomUy64Was" } ] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のBatchGetOnPremisesInstances
」を参照してください。
-
次の例は、continue-deployment
を使用する方法を説明しています。
- AWS CLI
-
指定された待機時間が経過するのを待たずにトラフィックのルート変更を開始するには。
次の
continue-deployment
例では、元の環境のインスタンスから、代替環境のインスタンスへのトラフィックのシフトを開始する準備ができているインスタンスへのトラフィックの再ルーティングを開始します。aws deploy continue-deployment \ --deployment-id
"d-A1B2C3111"
\ --deployment-wait-type"READY_WAIT"
このコマンドでは何も出力されません。
詳細については、ContinueDeployment AWS リファレンスの APICodeDeploy を参照してください。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のContinueDeployment
」を参照してください。
-
次の例は、create-application
を使用する方法を説明しています。
- AWS CLI
-
アプリケーションを作成するには
次の
create-application
例では、アプリケーションを作成し、ユーザーの AWS アカウントに関連付けることができます。aws deploy create-application --application-name
MyOther_App
出力:
{ "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のCreateApplication
」を参照してください。
-
次の例は、create-deployment-config
を使用する方法を説明しています。
- AWS CLI
-
カスタムデプロイ設定を作成するには
次の
create-deployment-config
例では、カスタムデプロイ設定を作成し、ユーザーの AWS アカウントと関連付けます。aws deploy create-deployment-config \ --deployment-config-name
ThreeQuartersHealthy
\ --minimum-healthy-hoststype=FLEET_PERCENT,value=75
出力:
{ "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のCreateDeploymentConfig
」を参照してください。
-
次の例は、create-deployment-group
を使用する方法を説明しています。
- AWS CLI
-
デプロイグループを作成するには
次の
create-deployment-group
例では、デプロイグループを作成し、指定されたアプリケーションとユーザーの AWS アカウントと関連付けます。aws deploy create-deployment-group \ --application-name
WordPress_App
\ --auto-scaling-groupsCodeDeployDemo-ASG
\ --deployment-config-nameCodeDeployDefault.OneAtATime
\ --deployment-group-nameWordPress_DG
\ --ec2-tag-filtersKey=Name,Value=CodeDeployDemo,Type=KEY_AND_VALUE
\ --service-role-arnarn:aws:iam::123456789012:role/CodeDeployDemoRole
出力:
{ "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のCreateDeploymentGroup
」を参照してください。
-
次のコード例は、create-deployment
を使用する方法を示しています。
- AWS CLI
-
例 1: CodeDeploy /オンプレミスコンピューティングプラットフォームを使用して EC2 デプロイを作成するには
次の
create-deployment
例では、デプロイを作成し、ユーザーの AWS アカウントと関連付けます。aws deploy create-deployment \ --application-name
WordPress_App
\ --deployment-config-nameCodeDeployDefault.OneAtATime
\ --deployment-group-nameWordPress_DG
\ --description"My demo deployment"
\ --s3-locationbucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip
出力:
{ "deploymentId": "d-A1B2C3111" }
例 2: Amazon CodeDeploy コンピューティングプラットフォームを使用して aECS デプロイを作成するには
次の
create-deployment
例では、次の 2 つのファイルを使用して Amazon ECS サービスをデプロイします。create-deployment.json
ファイルの内容。{ "applicationName": "ecs-deployment", "deploymentGroupName": "ecs-deployment-dg", "revision": { "revisionType": "S3", "s3Location": { "bucket": "ecs-deployment-bucket", "key": "appspec.yaml", "bundleType": "YAML" } } }
このファイルは、 という S3 バケット
appspec.yaml
から次のファイルを取得しますecs-deployment-bucket
。version: 0.0 Resources: - TargetService: Type: AWS::ECS::Service Properties: TaskDefinition: "arn:aws:ecs:region:123456789012:task-definition/ecs-task-def:2" LoadBalancerInfo: ContainerName: "sample-app" ContainerPort: 80 PlatformVersion: "LATEST"
コマンド:
aws deploy create-deployment \ --cli-input-json
file://create-deployment.json
\ --regionus-east-1
出力:
{ "deploymentId": "d-1234ABCDE" }
詳細については、CreateDeployment AWS リファレンスの CodeDeploy API を参照してください。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のCreateDeployment
」を参照してください。
-
次の例は、delete-application
を使用する方法を説明しています。
- AWS CLI
-
アプリケーションを削除するには
次の
delete-application
例では、ユーザーの AWS アカウントに関連付けられている指定されたアプリケーションを削除します。aws deploy delete-application --application-name
WordPress_App
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のDeleteApplication
」を参照してください。
-
次の例は、delete-deployment-config
を使用する方法を説明しています。
- AWS CLI
-
デプロイ設定を削除するには
次の
delete-deployment-config
例では、ユーザーの AWS アカウントに関連付けられているカスタムデプロイ設定を削除します。aws deploy delete-deployment-config --deployment-config-name
ThreeQuartersHealthy
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のDeleteDeploymentConfig
」を参照してください。
-
次のコード例は、delete-deployment-group
を使用する方法を示しています。
- AWS CLI
-
デプロイグループを削除するには
次の
delete-deployment-group
例では、指定されたアプリケーションに関連付けられているデプロイグループを削除します。aws deploy delete-deployment-group \ --application-name
WordPress_App
\ --deployment-group-nameWordPress_DG
出力:
{ "hooksNotCleanedUp": [] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のDeleteDeploymentGroup
」を参照してください。
-
次の例は、delete-git-hub-account-token
を使用する方法を説明しています。
- AWS CLI
-
a GitHub アカウント接続を削除するには
次の
delete-git-hub-account-token
例では、指定された GitHub アカウントの接続を削除します。aws deploy delete-git-hub-account-token --token-name
my-github-account
出力:
{ "tokenName": "my-github-account" }
詳細については、DeleteGitHubAccountToken AWS リファレンスの CodeDeploy API を参照してください。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のDeleteGitHubAccountToken
」を参照してください。
-
次のコード例は、deregister-on-premises-instance
を使用する方法を示しています。
- AWS CLI
-
オンプレミスインスタンスの登録を解除するには
次の
deregister-on-premises-instance
例では、オンプレミスインスタンスを AWS CodeDeploy に登録解除しますが、インスタンスに関連付けられた IAM ユーザーを削除したり、インスタンスから in AWS CodeDeploy インスタンスタグの関連付けを解除したりすることはありません。また、インスタンスから AWS CodeDeploy Agent をアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したりすることはありません。aws deploy deregister-on-premises-instance --instance-name
AssetTag12010298EX
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のDeregisterOnPremisesInstance
」を参照してください。
-
次のコード例は、deregister
を使用する方法を示しています。
- AWS CLI
-
オンプレミスインスタンスの登録を解除するには
次の
deregister
例では、オンプレミスインスタンスを AWS CodeDeploy に登録解除します。インスタンスに関連付けられている IAM ユーザーを削除しません。インスタンスから in AWS CodeDeploy オンプレミスタグの関連付けを解除します。インスタンスから AWS CodeDeploy Agent をアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したりすることはありません。aws deploy deregister \ --instance-name
AssetTag12010298EX
\ --no-delete-iam-user \ --regionus-west-2
出力:
Retrieving on-premises instance information... DONE IamUserArn: arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX Tags: Key=Name,Value=CodeDeployDemo-OnPrem Removing tags from the on-premises instance... DONE Deregistering the on-premises instance... DONE Run the following command on the on-premises instance to uninstall the codedeploy-agent: aws deploy uninstall
-
API の詳細については、 AWS CLI コマンドリファレンスの「登録解除
」を参照してください。
-
次のコード例は、get-application-revision
を使用する方法を示しています。
- AWS CLI
-
アプリケーションリビジョンに関する情報を取得するには
次の
get-application-revision
例は、指定されたアプリケーションに関連付けられているアプリケーションリビジョンに関する情報を示しています。aws deploy get-application-revision \ --application-name
WordPress_App
\ --s3-locationbucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip
出力:
{ "applicationName": "WordPress_App", "revisionInfo": { "description": "Application revision registered by Deployment ID: d-A1B2C3111", "registerTime": 1411076520.009, "deploymentGroups": "WordPress_DG", "lastUsedTime": 1411076520.009, "firstUsedTime": 1411076520.009 }, "revision": { "revisionType": "S3", "s3Location": { "bundleType": "zip", "eTag": "dd56cfdEXAMPLE8e768f9d77fEXAMPLE", "bucket": "CodeDeployDemoBucket", "key": "WordPressApp.zip" } } }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のGetApplicationRevision
」を参照してください。
-
次のコード例は、get-application
を使用する方法を示しています。
- AWS CLI
-
アプリケーションに関する情報を取得するには
次の
get-application
例は、ユーザーの AWS アカウントに関連付けられているアプリケーションに関する情報を示しています。aws deploy get-application --application-name
WordPress_App
出力:
{ "application": { "applicationName": "WordPress_App", "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "createTime": 1407878168.078, "linkedToGitHub": false } }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のGetApplication
」を参照してください。
-
次の例は、get-deployment-config
を使用する方法を説明しています。
- AWS CLI
-
デプロイ設定に関する情報を取得するには
次の
get-deployment-config
例は、ユーザーの AWS アカウントに関連付けられているデプロイ設定に関する情報を示しています。aws deploy get-deployment-config --deployment-config-name
ThreeQuartersHealthy
出力:
{ "deploymentConfigInfo": { "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "minimumHealthyHosts": { "type": "FLEET_PERCENT", "value": 75 }, "createTime": 1411081164.379, "deploymentConfigName": "ThreeQuartersHealthy" } }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のGetDeploymentConfig
」を参照してください。
-
次のコード例は、get-deployment-group
を使用する方法を示しています。
- AWS CLI
-
デプロイグループに関する情報を表示するには
次の
get-deployment-group
例は、指定されたアプリケーションに関連付けられているデプロイグループに関する情報を示しています。aws deploy get-deployment-group \ --application-name
WordPress_App
\ --deployment-group-nameWordPress_DG
出力:
{ "deploymentGroupInfo": { "applicationName": "WordPress_App", "autoScalingGroups": [ "CodeDeployDemo-ASG" ], "deploymentConfigName": "CodeDeployDefault.OneAtATime", "ec2TagFilters": [ { "Type": "KEY_AND_VALUE", "Value": "CodeDeployDemo", "Key": "Name" } ], "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployDemoRole", "deploymentGroupName": "WordPress_DG" } }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のGetDeploymentGroup
」を参照してください。
-
次のコード例は、get-deployment-instance
を使用する方法を示しています。
- AWS CLI
-
デプロイインスタンスに関する情報を取得するには
次の
get-deployment-instance
例では、指定されたデプロイに関連付けられているデプロイインスタンスに関する情報を表示します。aws deploy get-deployment-instance --deployment-id
d-QA4G4F9EX
--instance-idi-902e9fEX
出力:
{ "instanceSummary": { "instanceId": "arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-902e9fEX", "lifecycleEvents": [ { "status": "Succeeded", "endTime": 1408480726.569, "startTime": 1408480726.437, "lifecycleEventName": "ApplicationStop" }, { "status": "Succeeded", "endTime": 1408480728.016, "startTime": 1408480727.665, "lifecycleEventName": "DownloadBundle" }, { "status": "Succeeded", "endTime": 1408480729.744, "startTime": 1408480729.125, "lifecycleEventName": "BeforeInstall" }, { "status": "Succeeded", "endTime": 1408480730.979, "startTime": 1408480730.844, "lifecycleEventName": "Install" }, { "status": "Failed", "endTime": 1408480732.603, "startTime": 1408480732.1, "lifecycleEventName": "AfterInstall" }, { "status": "Skipped", "endTime": 1408480732.606, "lifecycleEventName": "ApplicationStart" }, { "status": "Skipped", "endTime": 1408480732.606, "lifecycleEventName": "ValidateService" } ], "deploymentId": "d-QA4G4F9EX", "lastUpdatedAt": 1408480733.152, "status": "Failed" } }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のGetDeploymentInstance
」を参照してください。
-
次の例は、get-deployment-target
を使用する方法を説明しています。
- AWS CLI
-
デプロイターゲットに関する情報を返すには
次の
get-deployment-target
例では、指定されたデプロイに関連付けられているデプロイターゲットに関する情報を返します。aws deploy get-deployment-target \ --deployment-id
"d-A1B2C3111"
\ --target-id"i-a1b2c3d4e5f611111"
出力:
{ "deploymentTarget": { "deploymentTargetType": "InstanceTarget", "instanceTarget": { "lastUpdatedAt": 1556918687.504, "targetId": "i-a1b2c3d4e5f611111", "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-a1b2c3d4e5f611111", "status": "Succeeded", "lifecycleEvents": [ { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "ApplicationStop", "startTime": 1556918592.162, "endTime": 1556918592.247 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "DownloadBundle", "startTime": 1556918593.193, "endTime": 1556918593.981 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "BeforeInstall", "startTime": 1556918594.805, "endTime": 1556918681.807 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "Install", "startTime": 1556918682.696, "endTime": 1556918683.005 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "AfterInstall", "startTime": 1556918684.135, "endTime": 1556918684.216 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "ApplicationStart", "startTime": 1556918685.211, "endTime": 1556918685.295 }, { "status": "Succeeded", "diagnostics": { "errorCode": "Success", "message": "Succeeded", "logTail": "", "scriptName": "" }, "lifecycleEventName": "ValidateService", "startTime": 1556918686.65, "endTime": 1556918686.747 } ], "deploymentId": "d-A1B2C3111" } } }
詳細については、GetDeploymentTarget AWS リファレンスの CodeDeploy API を参照してください。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のGetDeploymentTarget
」を参照してください。
-
次の例は、get-deployment
を使用する方法を説明しています。
- AWS CLI
-
デプロイに関する情報を取得するには
次の
get-deployment
例は、ユーザーの AWS アカウントに関連付けられているデプロイに関する情報を示しています。aws deploy get-deployment --deployment-id
d-A1B2C3123
出力:
{ "deploymentInfo": { "applicationName": "WordPress_App", "status": "Succeeded", "deploymentOverview": { "Failed": 0, "InProgress": 0, "Skipped": 0, "Succeeded": 1, "Pending": 0 }, "deploymentConfigName": "CodeDeployDefault.OneAtATime", "creator": "user", "description": "My WordPress app deployment", "revision": { "revisionType": "S3", "s3Location": { "bundleType": "zip", "eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"", "bucket": "CodeDeployDemoBucket", "key": "WordPressApp.zip" } }, "deploymentId": "d-A1B2C3123", "deploymentGroupName": "WordPress_DG", "createTime": 1409764576.589, "completeTime": 1409764596.101, "ignoreApplicationStopFailures": false } }
-
API の詳細については、 AWS CLI コマンドリファレンスの GetDeployment
を参照してください。
-
次のコード例は、get-on-premises-instance
を使用する方法を示しています。
- AWS CLI
-
オンプレミスインスタンスに関する情報を取得するには
次の
get-on-premises-instance
例では、指定されたオンプレミスインスタンスに関する情報を取得します。aws deploy get-on-premises-instance --instance-name
AssetTag12010298EX
出力:
{ "instanceInfo": { "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX", "tags": [ { "Value": "CodeDeployDemo-OnPrem", "Key": "Name" } ], "instanceName": "AssetTag12010298EX", "registerTime": 1425579465.228, "instanceArn": "arn:aws:codedeploy:us-east-1:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh" } }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のGetOnPremisesInstance
」を参照してください。
-
次の例は、install
を使用する方法を説明しています。
- AWS CLI
-
オンプレミスインスタンスをインストールするには
次の
install
例では、インスタンス上の指定された場所から AWS CodeDeploy Agent が見つけることを期待するインスタンス上の場所にオンプレミス設定ファイルをコピーします。また、インスタンスに AWS CodeDeploy エージェントをインストールします。IAM ユーザーを作成したり、オンプレミスインスタンスを AWS CodeDeploy に登録したり、インスタンスのオンプレミスインスタンスタグを AWS CodeDeploy に関連付けることはありません。aws deploy install \ --override-config \ --config-file C:\temp\codedeploy.onpremises.yml \ --region
us-west-2
\ --agent-installers3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi
出力:
Creating the on-premises instance configuration file... DONE Installing the AWS CodeDeploy Agent... DONE
-
API の詳細については、AWS CLI 「 コマンドリファレンス」の「インストール
」を参照してください。
-
次のコード例は、list-application-revisions
を使用する方法を示しています。
- AWS CLI
-
アプリケーションリビジョンに関する情報を取得するには
次の
list-application-revisions
例は、指定されたアプリケーションに関連付けられているすべてのアプリケーションリビジョンに関する情報を示しています。aws deploy list-application-revisions \ --application-name
WordPress_App
\ --s-3-bucketCodeDeployDemoBucket
\ --deployedexclude
\ --s-3-key-prefixWordPress_
\ --sort-bylastUsedTime
\ --sort-orderdescending
出力:
{ "revisions": [ { "revisionType": "S3", "s3Location": { "version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE", "bucket": "CodeDeployDemoBucket", "key": "WordPress_App.zip", "bundleType": "zip" } }, { "revisionType": "S3", "s3Location": { "version": "tMk.UxgDpMEVb7V187ZM6wVAWEXAMPLE", "bucket": "CodeDeployDemoBucket", "key": "WordPress_App_2-0.zip", "bundleType": "zip" } } ] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListApplicationRevisions
」を参照してください。
-
次の例は、list-applications
を使用する方法を説明しています。
- AWS CLI
-
アプリケーションに関する情報を取得するには
次の
list-applications
例は、ユーザーの AWS アカウントに関連付けられているすべてのアプリケーションに関する情報を示しています。aws deploy list-applications
出力:
{ "applications": [ "WordPress_App", "MyOther_App" ] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListApplications
」を参照してください。
-
次のコード例は、list-deployment-configs
を使用する方法を示しています。
- AWS CLI
-
デプロイ設定に関する情報を取得するには
次の
list-deployment-configs
例は、ユーザーの AWS アカウントに関連付けられているすべてのデプロイ設定に関する情報を示しています。aws deploy list-deployment-configs
出力:
{ "deploymentConfigsList": [ "ThreeQuartersHealthy", "CodeDeployDefault.AllAtOnce", "CodeDeployDefault.HalfAtATime", "CodeDeployDefault.OneAtATime" ] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListDeploymentConfigs
」を参照してください。
-
次のコード例は、list-deployment-groups
を使用する方法を示しています。
- AWS CLI
-
デプロイグループに関する情報を取得するには
次の
list-deployment-groups
例では、指定されたアプリケーションに関連付けられているすべてのデプロイグループに関する情報を表示します。aws deploy list-deployment-groups --application-name
WordPress_App
出力:
{ "applicationName": "WordPress_App", "deploymentGroups": [ "WordPress_DG", "WordPress_Beta_DG" ] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListDeploymentGroups
」を参照してください。
-
次の例は、list-deployment-instances
を使用する方法を説明しています。
- AWS CLI
-
デプロイインスタンスに関する情報を取得するには
次の
list-deployment-instances
例では、指定されたデプロイに関連付けられているすべてのデプロイインスタンスに関する情報を表示します。aws deploy list-deployment-instances \ --deployment-id
d-A1B2C3111
\ --instance-status-filterSucceeded
出力:
{ "instancesList": [ "i-EXAMPLE11", "i-EXAMPLE22" ] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListDeploymentInstances
」を参照してください。
-
次のコード例は、list-deployment-targets
を使用する方法を示しています。
- AWS CLI
-
デプロイに関連付けられているターゲット IDs のリストを取得するには
次の
list-deployment-targets
例では、「Failed」またはIDs」のステータスを持つデプロイに関連付けられたターゲット InProgress のリストを取得します。aws deploy list-deployment-targets \ --deployment-id
"d-A1B2C3111"
\ --target-filters "{\"TargetStatus\":[\"Failed\",\"InProgress\"]}"出力:
{ "targetIds": [ "i-0f1558aaf90e5f1f9" ] }
詳細については、ListDeploymentTargets AWS リファレンスの CodeDeploy API を参照してください。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListDeploymentTargets
」を参照してください。
-
次のコード例は、list-deployments
を使用する方法を示しています。
- AWS CLI
-
デプロイに関する情報を取得するには
次の
list-deployments
例では、指定されたアプリケーションとデプロイグループに関連付けられているすべてのデプロイに関する情報を表示します。aws deploy list-deployments \ --application-name
WordPress_App
\ --create-time-rangestart=2014-08-19T00:00:00,end=2014-08-20T00:00:00
\ --deployment-group-nameWordPress_DG
\ --include-only-statusesFailed
出力:
{ "deployments": [ "d-EXAMPLE11", "d-EXAMPLE22", "d-EXAMPLE33" ] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListDeployments
」を参照してください。
-
次のコード例は、list-git-hub-account-token-names
を使用する方法を示しています。
- AWS CLI
-
GitHub アカウントへの保存済み接続の名前を一覧表示するには
次の
list-git-hub-account-token-names
例では、現在の AWS ユーザーの GitHub アカウントへの保存済み接続の名前を一覧表示します。aws deploy list-git-hub-account-token-names
出力:
{ "tokenNameList": [ "my-first-token", "my-second-token", "my-third-token" ] }
詳細については、ListGitHubAccountTokenNames AWS リファレンスの APICodeDeploy を参照してください。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListGitHubAccountTokenNames
」を参照してください。
-
次のコード例は、list-on-premises-instances
を使用する方法を示しています。
- AWS CLI
-
1 つ以上のオンプレミスインスタンスに関する情報を取得するには
次の
list-on-premises-instances
例では、in AWS CodeDeploy に登録され、インスタンス AWS CodeDeploy に関連付けられた指定されたオンプレミスインスタンスタグを持つインスタンスで使用可能なオンプレミスインスタンス名のリストを取得します。aws deploy list-on-premises-instances \ --registration-status
Registered
\ --tag-filtersKey=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE
出力:
{ "instanceNames": [ "AssetTag12010298EX" ] }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のListOnPremisesInstances
」を参照してください。
-
次のコード例は、list-tags-for-resource
を使用する方法を示しています。
- AWS CLI
-
リソースのタグを一覧表示するには (アプリケーション)
次の
list-tags-for-resource
例では、 testApp in CodeDeploy という名前のアプリケーションに適用されるタグを一覧表示します。aws deploy list-tags-for-resource \ --resource-arn
arn:aws:codedeploy:us-west-2:111122223333:application:testApp
出力:
{ "Tags": [ { "Key": "Type", "Value": "testType" }, { "Key": "Name", "Value": "testName" } ] }
詳細については、 CodeDeploy ユーザーガイドの「Word でのデプロイグループのインスタンスのタグ付け」を参照してください。 AWS CodeDeploy
-
API の詳細については、 AWS CLI コマンドリファレンスの ListTagsForResource
を参照してください。
-
次のコード例は、push
を使用する方法を示しています。
- AWS CLI
-
Amazon S3 に AWS CodeDeploy 互換アプリケーションリビジョンをバンドルしてデプロイするには
次の
push
例では、アプリケーションリビジョンをバンドルして Amazon S3 にデプロイし、アプリケーションリビジョンを指定されたアプリケーションに関連付けます。aws deploy push \ --application-name
WordPress_App
\ --description"This is my deployment"
\ --ignore-hidden-files \ --s3-locations3://CodeDeployDemoBucket/WordPressApp.zip
\ --source/tmp/MyLocalDeploymentFolder/
出力では、
create-deployment
コマンドを使用して、アップロードされたアプリケーションリビジョンを使用するデプロイを作成する方法について説明します。To deploy with this revision, run: aws deploy create-deployment --application-name WordPress_App --deployment-config-name <deployment-config-name> --deployment-group-name <deployment-group-name> --s3-location bucket=CodeDeployDemoBucket,key=WordPressApp.zip,bundleType=zip,eTag="cecc9b8EXAMPLE50a6e71fdb88EXAMPLE",version=LFsJAUdEXAMPLEfvKtvi79L8EXAMPLE
-
API の詳細については、「 コマンドAWS CLI リファレンスでプッシュ
」を参照してください。
-
次のコード例は、register-application-revision
を使用する方法を示しています。
- AWS CLI
-
既にアップロードされたアプリケーションリビジョンに関する情報を登録するには
次の
register-application-revision
例では、Amazon S3 with AWS CodeDeploy に保存されている既にアップロードされたアプリケーションリビジョンに関する情報を登録します。aws deploy register-application-revision \ --application-name
WordPress_App
\ --description"Revised WordPress application"
\ --s3-locationbucket=CodeDeployDemoBucket,key=RevisedWordPressApp.zip,bundleType=zip,eTag=cecc9b8a08eac650a6e71fdb88EXAMPLE
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のRegisterApplicationRevision
」を参照してください。
-
次の例は、register-on-premises-instance
を使用する方法を説明しています。
- AWS CLI
-
オンプレミスインスタンスを登録するには
次の
register-on-premises-instance
例では、オンプレミスインスタンスを AWS CodeDeploy に登録します。指定された IAM ユーザーを作成したり、 AWS CodeDeploy オンプレミスインスタンスのタグを登録インスタンスに関連付けることはありません。aws deploy register-on-premises-instance \ --instance-name
AssetTag12010298EX
\ --iam-user-arnarn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のRegisterOnPremisesInstance
」を参照してください。
-
次のコード例は、register
を使用する方法を示しています。
- AWS CLI
-
オンプレミスインスタンスを登録するには
次の
register
例では、オンプレミスインスタンスを AWS CodeDeploy に登録し、指定されたオンプレミスインスタンスタグ AWS CodeDeploy を登録済みインスタンスに関連付け、インスタンスにコピーできるオンプレミス設定ファイルを作成します。IAM ユーザーを作成したり、インスタンスに AWS CodeDeploy エージェントをインストールしたりすることはありません。aws deploy register \ --instance-name
AssetTag12010298EX
\ --iam-user-arnarn:aws:iam::80398EXAMPLE:user/CodeDeployUser-OnPrem
\ --tagsKey=Name,Value=CodeDeployDemo-OnPrem
\ --regionus-west-2
出力:
Registering the on-premises instance... DONE Adding tags to the on-premises instance... DONE Copy the on-premises configuration file named codedeploy.onpremises.yml to the on-premises instance, and run the following command on the on-premises instance to install and configure the AWS CodeDeploy Agent: aws deploy install --config-file codedeploy.onpremises.yml
-
API の詳細については、 AWS CLI コマンドリファレンスの登録
を参照してください。
-
次のコード例は、remove-tags-from-on-premises-instances
を使用する方法を示しています。
- AWS CLI
-
1 つ以上のオンプレミスインスタンスからタグを削除するには
次の
remove-tags-from-on-premises-instances
例では、 AWS CodeDeploy で指定されたオンプレミスタグとオンプレミスインスタンスの関連付けを解除します。オンプレミスインスタンスの in AWS CodeDeploy の登録を解除したり、インスタンスから AWS CodeDeploy エージェントをアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したり、インスタンスに関連付けられている IAM ユーザーを削除したりすることはありません。aws deploy remove-tags-from-on-premises-instances \ --instance-names
AssetTag12010298EX
AssetTag23121309EX
\ --tagsKey=Name,Value=CodeDeployDemo-OnPrem
このコマンドでは何も出力されません。
-
API の詳細については、 AWS CLI コマンドリファレンスの RemoveTagsFromOnPremisesInstances
を参照してください。
-
次のコード例は、stop-deployment
を使用する方法を示しています。
- AWS CLI
-
デプロイを停止するには
次の
stop-deployment
例では、ユーザーの AWS アカウントに関連付けられている進行中のデプロイを停止しようとします。aws デプロイ停止 --deployment-id d-A1B2C3111
出力:
{ "status": "Succeeded", "statusMessage": "No more commands will be scheduled for execution in the deployment instances" }
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のStopDeployment
」を参照してください。
-
次のコード例は、tag-resource
を使用する方法を示しています。
- AWS CLI
-
リソースにタグを付けるには (アプリケーション)
次の
tag-resource
例では、キー Name と Type、 testName と testType を含む 2 つのタグを、 CodeDeploy in testApp という名前のアプリケーションに追加します。aws deploy tag-resource \ --resource-arn
arn:aws:codedeploy:us-west-2:111122223333:application:testApp
\ --tagsKey=Name,Value=testName
Key=Type,Value=testType
このコマンドが成功した場合、出力は生成されません。
詳細については、 CodeDeploy ユーザーガイドの「Word でのデプロイグループのインスタンスのタグ付け」を参照してください。 AWS CodeDeploy
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のTagResource
」を参照してください。
-
次の例は、uninstall
を使用する方法を説明しています。
- AWS CLI
-
オンプレミスインスタンスをアンインストールするには
次の
uninstall
例では、オンプレミスインスタンスから AWS CodeDeploy Agent をアンインストールし、インスタンスからオンプレミス設定ファイルを削除します。インスタンス in AWS CodeDeploy の登録を解除したり、インスタンス AWS CodeDeploy からオンプレミスインスタンスタグの関連付けを解除したり、インスタンスに関連付けられている IAM ユーザーを削除したりすることはありません。aws deploy uninstall
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」の「アンインストール
」を参照してください。
-
次のコード例は、untag-resource
を使用する方法を示しています。
- AWS CLI
-
リソースからタグを削除するには (アプリケーション)
次の
untag-resource
例では、Word in testApp という名前のアプリケーションから、 キーの名前とタイプを持つ 2 つのタグを削除します CodeDeploy。aws deploy untag-resource \ --resource-arn
arn:aws:codedeploy:us-west-2:111122223333:application:testApp
\ --tag-keysName
Type
このコマンドが成功した場合、出力は生成されません。
詳細については、 CodeDeploy ユーザーガイドの「Word でのデプロイグループのインスタンスのタグ付け」を参照してください。 AWS CodeDeploy
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のUntagResource
」を参照してください。
-
次のコード例は、update-application
を使用する方法を示しています。
- AWS CLI
-
アプリケーションの詳細を変更するには
次の
update-application
例では、ユーザーの AWS アカウントに関連付けられているアプリケーションの名前を変更します。aws deploy update-application \ --application-name
WordPress_App
\ --new-application-nameMy_WordPress_App
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のUpdateApplication
」を参照してください。
-
次の例は、update-deployment-group
を使用する方法を説明しています。
- AWS CLI
-
デプロイグループに関する情報を変更するには
次の
update-deployment-group
例では、指定されたアプリケーションに関連付けられているデプロイグループの設定を変更します。aws deploy update-deployment-group \ --application-name
WordPress_App
\ --auto-scaling-groupsMy_CodeDeployDemo_ASG
\ --current-deployment-group-nameWordPress_DG
\ --deployment-config-nameCodeDeployDefault.AllAtOnce
\ --ec2-tag-filtersKey=Name,Type=KEY_AND_VALUE,Value=My_CodeDeployDemo
\ --new-deployment-group-nameMy_WordPress_DepGroup
\ --service-role-arnarn:aws:iam::80398EXAMPLE:role/CodeDeployDemo-2
このコマンドでは何も出力されません。
-
API の詳細については、AWS CLI 「 コマンドリファレンス」のUpdateDeploymentGroup
」を参照してください。
-