Exemplos do CodeDeploy usando a AWS CLI - AWS Command Line Interface
Ações

Exemplos do CodeDeploy usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o CodeDeploy.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar add-tags-to-on-premises-instances.

AWS CLI

Para adicionar tags a uma ou mais instâncias on-premises

O exemplo add-tags-to-on-premises-instances a seguir associa no AWS CodeDeploy a mesma tag de instância on-premises a duas instâncias on-premises. Ele não registra as instâncias on-premises no AWS CodeDeploy.

aws deploy add-tags-to-on-premises-instances \
    --instance-names AssetTag12010298EX AssetTag23121309EX \
    --tags Key=Name,Value=CodeDeployDemo-OnPrem

Este comando não produz saída.

O código de exemplo a seguir mostra como usar batch-get-application-revisions.

AWS CLI

Para recuperar informações sobre revisões de aplicações

O exemplo batch-get-application-revisions a seguir recupera informações sobre a revisão especificada armazenada em um repositório do GitHub.

aws deploy batch-get-application-revisions \
    --application-name my-codedeploy-application \
    --revisions "[{\"gitHubLocation\": {\"commitId\": \"fa85936EXAMPLEa31736c051f10d77297EXAMPLE\",\"repository\": \"my-github-token/my-repository\"},\"revisionType\": \"GitHub\"}]"

Saída:

{
    "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": ""
}

Para obter mais informações, consulte BatchGetApplicationRevisions na Referência da API do AWS CodeDeploy.

O código de exemplo a seguir mostra como usar batch-get-applications.

AWS CLI

Para obter informações sobre várias aplicações

O exemplo batch-get-applications a seguir exibe informações sobre várias aplicações associadas à conta da AWS do usuário.

aws deploy batch-get-applications --application-names WordPress_App MyOther_App

Saída:

{
    "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
        }
    ]
}

O código de exemplo a seguir mostra como usar batch-get-deployment-groups.

AWS CLI

Para recuperar informações sobre um ou mais grupos de implantação

O exemplo batch-get-deployment-groups a seguir recupera informações sobre dois dos grupos de implantação associados à aplicação do CodeDeploy especificado.

aws deploy batch-get-deployment-groups \
    --application-name my-codedeploy-application \
    --deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]"

Saída:

{
    "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": ""
}

Para obter mais informações, consulte BatchGetDeploymentGroups na Referência da API do AWS CodeDeploy.

O código de exemplo a seguir mostra como usar batch-get-deployment-targets.

AWS CLI

Para recuperar os destinos associados a uma implantação

O exemplo batch-get-deployment-targets a seguir retorna informações sobre um dos destinos associados à implantação especificada.

aws deploy batch-get-deployment-targets \
    --deployment-id "d-1A2B3C4D5" \
    --target-ids "i-01a2b3c4d5e6f1111"

Saída:

{
    "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"
            }
        }
    ]
}

Para obter mais informações, consulte BatchGetDeploymentTargets na Referência da API do AWS CodeDeploy.

O código de exemplo a seguir mostra como usar batch-get-deployments.

AWS CLI

Para obter informações sobre várias implantações

O exemplo batch-get-deployments a seguir exibe informações sobre várias implantações associadas à conta da AWS do usuário.

aws deploy batch-get-deployments --deployment-ids d-A1B2C3111 d-A1B2C3222

Saída:

{
    "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": "amzn-s3-demo-bucket",
                "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": "amzn-s3-demo-bucket",
                "key": "MyOtherApp.zip"
                }
            },
            "deploymentId": "d-A1B2C3222",
            "createTime": 1409764576.589,
            "completeTime": 1409764596.101
        }
    ]
}

  • Para receber detalhes da API, consulte BatchGetDeployments na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar batch-get-on-premises-instances.

AWS CLI

Para obter informações sobre uma ou mais instâncias on-premises

O exemplo batch-get-on-premises-instances a seguir obtém informações sobre duas instâncias on-premises.

aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX

Saída:

{
    "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"
        }
    ]
}

O código de exemplo a seguir mostra como usar continue-deployment.

AWS CLI

Como começar a redirecionamento do tráfego sem esperar que ocorra um tempo de espera especificado.

O exemplo continue-deployment a seguir inicia o redirecionamento do tráfego de instâncias no ambiente original que estão prontas para começar a transferir tráfego para instâncias no ambiente de substituição.

aws deploy continue-deployment \
    --deployment-id "d-A1B2C3111" \
    --deployment-wait-type "READY_WAIT"

Este comando não produz saída.

Para obter mais informações, consulte ContinueDeployment na Referência da API do AWS CodeDeploy.

  • Para ver detalhes da API, consulte ContinueDeployment na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-application.

AWS CLI

Para criar uma aplicação

O exemplo create-application a seguir cria uma aplicação e o associa à conta da AWS do usuário.

aws deploy create-application --application-name MyOther_App

Saída:

{
    "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}

  • Para ver detalhes da API, consulte CreateApplication na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-deployment-config.

AWS CLI

Para criar uma configuração de implantação personalizada

O exemplo create-deployment-config a seguir cria uma configuração de implantação personalizada e a associa à conta da AWS do usuário.

aws deploy create-deployment-config \
    --deployment-config-name ThreeQuartersHealthy \
    --minimum-healthy-hosts type=FLEET_PERCENT,value=75

Saída:

{
    "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}

O código de exemplo a seguir mostra como usar create-deployment-group.

AWS CLI

Para criar um grupo de implantação

O exemplo create-deployment-group a seguir cria um grupo de implantação e o associa à aplicação especificada e à conta da AWS do usuário.

aws deploy create-deployment-group \
    --application-name WordPress_App \
    --auto-scaling-groups CodeDeployDemo-ASG \
    --deployment-config-name CodeDeployDefault.OneAtATime \
    --deployment-group-name WordPress_DG \
    --ec2-tag-filters Key=Name,Value=CodeDeployDemo,Type=KEY_AND_VALUE \
    --service-role-arn arn:aws:iam::123456789012:role/CodeDeployDemoRole

Saída:

{
    "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}

O código de exemplo a seguir mostra como usar create-deployment.

AWS CLI

Exemplo 1: criar uma implantação do CodeDeploy usando a plataforma de computação EC2/on-premises

O exemplo create-deployment a seguir cria uma implantação e a associa à conta da AWS do usuário.

aws deploy create-deployment \
    --application-name WordPress_App \
    --deployment-config-name CodeDeployDefault.OneAtATime \
    --deployment-group-name WordPress_DG \
    --description "My demo deployment" \
    --s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip

Saída:

{
    "deploymentId": "d-A1B2C3111"
}

Exemplo 2: criar uma implantação do CodeDeploy usando a plataforma de computação do Amazon ECS

O exemplo create-deployment a seguir usa os dois arquivos a seguir para implantar um serviço do Amazon ECS.

Conteúdo do arquivo create-deployment.json:

{
    "applicationName": "ecs-deployment",
    "deploymentGroupName": "ecs-deployment-dg",
    "revision": {
        "revisionType": "S3",
        "s3Location": {
            "bucket": "ecs-deployment-bucket",
            "key": "appspec.yaml",
            "bundleType": "YAML"
        }
    }
}

Esse arquivo, por sua vez, recupera o seguinte arquivo appspec.yaml de um bucket do S3 chamado 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"

Comando:

aws deploy create-deployment \
    --cli-input-json file://create-deployment.json \
    --region us-east-1

Saída:

{
    "deploymentId": "d-1234ABCDE"
}

Para obter mais informações, consulte CreateDeployment na Referência da API do AWS CodeDeploy.

  • Para obter detalhes da API, consulte CreateDeployment na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-application.

AWS CLI

Como excluir uma aplicação

O exemplo delete-application a seguir exclui a aplicação especificada que está associada à conta da AWS do usuário.

aws deploy delete-application --application-name WordPress_App

Este comando não produz saída.

  • Para ver detalhes da API, consulte DeleteApplication na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-deployment-config.

AWS CLI

Para excluir uma configuração de implantação

O exemplo delete-deployment-config a seguir exclui uma configuração de implantação personalizada associada à conta da AWS do usuário.

aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy

Este comando não produz saída.

O código de exemplo a seguir mostra como usar delete-deployment-group.

AWS CLI

Para excluir um grupo de implantação

O exemplo delete-deployment-group a seguir exclui um grupo de implantação associado à aplicação especificada.

aws deploy delete-deployment-group \
    --application-name WordPress_App \
    --deployment-group-name WordPress_DG

Saída:

{
    "hooksNotCleanedUp": []
}

O código de exemplo a seguir mostra como usar delete-git-hub-account-token.

AWS CLI

Para excluir uma conexão de conta do GitHub

O exemplo delete-git-hub-account-token a seguir exclui a conexão da conta especificada do GitHub.

aws deploy delete-git-hub-account-token --token-name my-github-account

Saída:

{
    "tokenName": "my-github-account"
}

Para obter mais informações, consulte DeleteGitHubAccountToken na Referência da API do AWS CodeDeploy.

O código de exemplo a seguir mostra como usar deregister-on-premises-instance.

AWS CLI

Como cancelar o registro de uma instância on-premises

O exemplo deregister-on-premises-instance a seguir cancela o registro de uma instância on-premises com o AWS CodeDeploy, mas não exclui o usuário do IAM associado à instância nem desassocia no AWS CodeDeploy as tags da instância on-premises da instância. Ele também não desinstala o agente do AWS CodeDeploy da instância nem remove o arquivo de configuração on-premises da instância.

aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX

Este comando não produz saída.

O código de exemplo a seguir mostra como usar deregister.

AWS CLI

Como cancelar o registro de uma instância on-premises

O exemplo deregister a seguir cancela o registro da instância on-premises no AWS CodeDeploy. Ele não exclui o usuário do IAM que está associado à instância. Ele dissocia no AWS CodeDeploy as tags on-premises da instância. Ele não desinstala o agente do AWS CodeDeploy da instância nem remove o arquivo de configuração on-premises da instância.

aws deploy deregister \
    --instance-name AssetTag12010298EX \
    --no-delete-iam-user \
    --region us-west-2

Saída:

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

  • Para ver detalhes da API, consulte Deregister na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-application-revision.

AWS CLI

Para obter informações sobre uma revisão da aplicação

O exemplo get-application-revision a seguir exibe informações sobre uma revisão da aplicação associada à aplicação especificada.

aws deploy get-application-revision \
    --application-name WordPress_App \
    --s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip

Saída:

{
    "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": "amzn-s3-demo-bucket",
            "key": "WordPressApp.zip"
        }
    }
}

O código de exemplo a seguir mostra como usar get-application.

AWS CLI

Para obter informações sobre uma aplicação

O exemplo get-application a seguir exibe informações sobre uma aplicação associada à conta da AWS do usuário.

aws deploy get-application --application-name WordPress_App

Saída:

{
    "application": {
        "applicationName": "WordPress_App",
        "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "createTime": 1407878168.078,
        "linkedToGitHub": false
    }
}

  • Para ver detalhes da API, consulte GetApplication na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-deployment-config.

AWS CLI

Para obter informações sobre uma configuração de implantação

O exemplo get-deployment-config a seguir exibe informações sobre uma configuração de implantação associada à conta da AWS do usuário.

aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy

Saída:

{
    "deploymentConfigInfo": {
        "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "minimumHealthyHosts": {
            "type": "FLEET_PERCENT",
            "value": 75
        },
        "createTime": 1411081164.379,
        "deploymentConfigName": "ThreeQuartersHealthy"
    }
}

  • Para receber detalhes da API, consulte GetDeploymentConfig na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-deployment-group.

AWS CLI

Como visualizar informações sobre um grupo de implantação

O exemplo get-deployment-group a seguir exibe informações sobre um grupo de implantação associado à aplicação especificada.

aws deploy get-deployment-group \
    --application-name WordPress_App \
    --deployment-group-name WordPress_DG

Saída:

{
    "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"
    }
}

  • Para ver detalhes da API, consulte GetDeploymentGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-deployment-instance.

AWS CLI

Para obter informações sobre uma instância de implantação

O exemplo get-deployment-instance a seguir exibe informações sobre uma instância de implantação associada à implantação especificada.

aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX

Saída:

{
    "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"
    }
}

O código de exemplo a seguir mostra como usar get-deployment-target.

AWS CLI

Como retornar informações sobre um destino de implantação

O exemplo get-deployment-target a seguir retorna informações sobre um destino de implantação associado à implantação especificada.

aws deploy get-deployment-target \
    --deployment-id "d-A1B2C3111" \
    --target-id "i-a1b2c3d4e5f611111"

Saída:

{
    "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"
        }
    }
}

Para obter mais informações, consulte GetDeploymentTarget na Referência da API do AWS CodeDeploy.

  • Para receber detalhes da API, consulte GetDeploymentTarget na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-deployment.

AWS CLI

Para obter informações sobre uma implantação

O exemplo get-deployment a seguir exibe informações sobre uma implantação associada à conta da AWS do usuário.

aws deploy get-deployment --deployment-id d-A1B2C3123

Saída:

{
    "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": "amzn-s3-demo-bucket",
            "key": "WordPressApp.zip"
            }
        },
        "deploymentId": "d-A1B2C3123",
        "deploymentGroupName": "WordPress_DG",
        "createTime": 1409764576.589,
        "completeTime": 1409764596.101,
        "ignoreApplicationStopFailures": false
    }
}

  • Para ver detalhes da API, consulte GetDeployment na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-on-premises-instance.

AWS CLI

Para obter informações sobre uma única instância on-premises

O exemplo get-on-premises-instance a seguir retorna as informações sobre uma instância on-premises especificada.

aws deploy get-on-premises-instance --instance-name AssetTag12010298EX

Saída:

{
    "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"
    }
}

O código de exemplo a seguir mostra como usar install.

AWS CLI

Como instalar uma instância on-premises

O exemplo install a seguir copia o arquivo de configuração on-premises do local especificado na instância para o local na instância que o agente do AWS CodeDeploy espera encontrá-la. Ele também instala o agente do AWS CodeDeploy na instância. Ele não cria nenhum usuário do IAM, nem registra a instância on-premises com o AWS CodeDeploy, nem associa nenhuma tag de instância on-premises no AWS CodeDeploy para a instância.

aws deploy install \
    --override-config \
    --config-file C:\temp\codedeploy.onpremises.yml \
    --region us-west-2 \
    --agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi

Saída:

Creating the on-premises instance configuration file... DONE
Installing the AWS CodeDeploy Agent... DONE

  • Para ver detalhes da API, consulte Install na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-application-revisions.

AWS CLI

Para obter informações sobre revisões da aplicação

O exemplo list-application-revisions a seguir exibe informações sobre todas as revisões da aplicação associadas à aplicação especificada.

aws deploy list-application-revisions \
    --application-name WordPress_App \
    --s-3-bucket amzn-s3-demo-bucket \
    --deployed exclude \
    --s-3-key-prefix WordPress_ \
    --sort-by lastUsedTime \
    --sort-order descending

Saída:

{
    "revisions": [
        {
            "revisionType": "S3",
            "s3Location": {
                "version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE",
                "bucket": "amzn-s3-demo-bucket",
                "key": "WordPress_App.zip",
                "bundleType": "zip"
            }
        },
        {
            "revisionType": "S3",
            "s3Location": {
                "version": "tMk.UxgDpMEVb7V187ZM6wVAWEXAMPLE",
                "bucket": "amzn-s3-demo-bucket",
                "key": "WordPress_App_2-0.zip",
                "bundleType": "zip"
            }
        }
    ]
}

O código de exemplo a seguir mostra como usar list-applications.

AWS CLI

Para obter informações sobre aplicações

O exemplo list-applications a seguir exibe informações sobre todos as aplicações associadas à conta da AWS do usuário.

aws deploy list-applications

Saída:

{
    "applications": [
        "WordPress_App",
        "MyOther_App"
    ]
}

  • Para ver detalhes da API, consulte ListApplications na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-deployment-configs.

AWS CLI

Para obter informações sobre configurações de implantação

O exemplo list-deployment-configs a seguir exibe informações sobre todas as configurações de implantação associadas à conta da AWS do usuário.

aws deploy list-deployment-configs

Saída:

{
    "deploymentConfigsList": [
        "ThreeQuartersHealthy",
        "CodeDeployDefault.AllAtOnce",
        "CodeDeployDefault.HalfAtATime",
        "CodeDeployDefault.OneAtATime"
    ]
}

O código de exemplo a seguir mostra como usar list-deployment-groups.

AWS CLI

Para obter informações sobre grupos de implantação

O exemplo list-deployment-groups a seguir exibe informações sobre todos os grupos de implantação associados à aplicação especificada.

aws deploy list-deployment-groups --application-name WordPress_App

Saída:

{
    "applicationName": "WordPress_App",
    "deploymentGroups": [
        "WordPress_DG",
        "WordPress_Beta_DG"
    ]
}

O código de exemplo a seguir mostra como usar list-deployment-instances.

AWS CLI

Para obter informações sobre instâncias de implantação

O exemplo list-deployment-instances a seguir exibe informações sobre todas as instâncias de implantação associadas à implantação especificada.

aws deploy list-deployment-instances \
    --deployment-id d-A1B2C3111 \
    --instance-status-filter Succeeded

Saída:

{
    "instancesList": [
        "i-EXAMPLE11",
        "i-EXAMPLE22"
    ]
}

O código de exemplo a seguir mostra como usar list-deployment-targets.

AWS CLI

Para recuperar uma lista de IDs de destino que estão associados a uma implantação

O exemplo list-deployment-targets a seguir recupera uma lista de IDs de destino associadas a implantações que têm um status de “Failed” ou “InProgress”.

aws deploy list-deployment-targets \
    --deployment-id "d-A1B2C3111" \
    --target-filters "{\"TargetStatus\":[\"Failed\",\"InProgress\"]}"

Saída:

{
    "targetIds": [
        "i-0f1558aaf90e5f1f9"
    ]
}

Para obter mais informações, consulte ListDeploymentTargets na Referência da API do AWS CodeDeploy.

O código de exemplo a seguir mostra como usar list-deployments.

AWS CLI

Para obter informações sobre implantações

O exemplo list-deployments a seguir exibe informações sobre todas as implantações associadas à aplicação e ao grupo de implantação especificados.

aws deploy list-deployments \
    --application-name WordPress_App \
    --create-time-range start=2014-08-19T00:00:00,end=2014-08-20T00:00:00 \
    --deployment-group-name WordPress_DG \
    --include-only-statuses Failed

Saída:

{
    "deployments": [
        "d-EXAMPLE11",
        "d-EXAMPLE22",
        "d-EXAMPLE33"
    ]
}

  • Para ver detalhes da API, consulte ListDeployments na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-git-hub-account-token-names.

AWS CLI

Para listar os nomes das conexões armazenadas para contas do GitHub

O exemplo list-git-hub-account-token-names a seguir lista os nomes das conexões armazenadas nas contas do GitHub para o usuário da AWS atual.

aws deploy list-git-hub-account-token-names

Saída:

{
    "tokenNameList": [
        "my-first-token",
        "my-second-token",
        "my-third-token"
    ]
}

Para obter mais informações, consulte ListGitHubAccountTokenNames na Referência da API do AWS CodeDeploy.

O código de exemplo a seguir mostra como usar list-on-premises-instances.

AWS CLI

Para obter informações sobre uma ou mais instâncias on-premises

O exemplo list-on-premises-instances a seguir recupera uma lista de nomes de instâncias on-premises disponíveis para instâncias registradas no AWS CodeDeploy e que também têm a tag de instância on-premises especificada associada no AWS CodeDeploy à instância.

aws deploy list-on-premises-instances \
    --registration-status Registered \
    --tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE

Saída:

{
    "instanceNames": [
        "AssetTag12010298EX"
    ]
}

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar tags para um recurso (aplicação)

O exemplo list-tags-for-resource a seguir lista as tags aplicadas a uma aplicação chamada testApp no CodeDeploy.

aws deploy list-tags-for-resource \
    --resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp

Saída:

{
    "Tags": [
        {
            "Key": "Type",
            "Value": "testType"
        },
        {
            "Key": "Name",
            "Value": "testName"
        }
    ]
}

Para obter mais informações, consulte Marcar instâncias de grupos de implantação no CodeDeploy no Guia do usuário do AWS CodeDeploy.

O código de exemplo a seguir mostra como usar push.

AWS CLI

Como agrupar e implantar uma revisão de aplicação compatível com o AWS CodeDeploy no Amazon S3

O exemplo push a seguir empacota e implanta uma revisão da aplicação no Amazon S3 e, em seguida, associa a revisão da aplicação à aplicação especificada.

aws deploy push \
    --application-name WordPress_App \
    --description "This is my deployment" \
    --ignore-hidden-files \
    --s3-location s3://amzn-s3-demo-bucket/WordPressApp.zip \
    --source /tmp/MyLocalDeploymentFolder/

A saída descreve como usar o comando create-deployment para criar uma implantação que usa a revisão da aplicação carregada.

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=amzn-s3-demo-bucket,key=WordPressApp.zip,bundleType=zip,eTag="cecc9b8EXAMPLE50a6e71fdb88EXAMPLE",version=LFsJAUdEXAMPLEfvKtvi79L8EXAMPLE

  • Para ver detalhes da API, consulte Push na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar register-application-revision.

AWS CLI

Para registrar informações sobre uma revisão de aplicação já carregada

O exemplo register-application-revision a seguir registra informações sobre uma revisão de aplicação já carregada armazenada no Amazon S3 com o AWS CodeDeploy.

aws deploy register-application-revision \
    --application-name WordPress_App \
    --description "Revised WordPress application" \
    --s3-location bucket=amzn-s3-demo-bucket,key=RevisedWordPressApp.zip,bundleType=zip,eTag=cecc9b8a08eac650a6e71fdb88EXAMPLE

Este comando não produz saída.

O código de exemplo a seguir mostra como usar register-on-premises-instance.

AWS CLI

Para registrar uma instância on-premises

O exemplo register-on-premises-instance a seguir registrar a instância on-premises no AWS CodeDeploy. Ele não cria o usuário do IAM especificado nem associa no AWS CodeDeploy nenhuma tag de instância on-premises à instância registrada.

aws deploy register-on-premises-instance \
    --instance-name AssetTag12010298EX \
    --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem

Este comando não produz saída.

O código de exemplo a seguir mostra como usar register.

AWS CLI

Para registrar uma instância on-premises

O exemplo register a seguir registra uma instância on-premises com o AWS CodeDeploy, associa no AWS CodeDeploy a tag de instância on-premises especificada à instância registrada e cria um arquivo de configuração on-premises que pode ser copiado para a instância. Ele não cria o usuário do IAM nem instala o agente do AWS CodeDeploy na instância.

aws deploy register \
    --instance-name AssetTag12010298EX \
    --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployUser-OnPrem \
    --tags Key=Name,Value=CodeDeployDemo-OnPrem \
    --region us-west-2

Saída:

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

  • Para ver detalhes da API, consulte Register na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar remove-tags-from-on-premises-instances.

AWS CLI

Para remover tags de uma ou mais instâncias on-premises

O exemplo remove-tags-from-on-premises-instances a seguir dissocia as tags on-premises especificadas no AWS CodeDeploy das instâncias on-premises. Ele não cancela o registro das instâncias on-premises no AWS CodeDeploy, nem desinstala o agente do AWS CodeDeploy da instância, nem remove o arquivo de configuração on-premises das instâncias, nem exclui os usuários do IAM associados às instâncias.

aws deploy remove-tags-from-on-premises-instances \
    --instance-names AssetTag12010298EX AssetTag23121309EX \
    --tags Key=Name,Value=CodeDeployDemo-OnPrem

Este comando não produz saída.

O código de exemplo a seguir mostra como usar stop-deployment.

AWS CLI

Como tentar interromper uma implantação

O exemplo stop-deployment a seguir tenta interromper uma implantação em andamento associada à conta da AWS do usuário.

aws deploy stop-deployment --deployment-id d-A1B2C3111

Saída:

{
    "status": "Succeeded",
    "statusMessage": "No more commands will be scheduled for execution in the deployment instances"
}

  • Para ver detalhes da API, consulte StopDeployment na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Como marcar um recurso (aplicação)

O exemplo tag-resource a seguir adiciona duas tags com as chaves Name e Type e os valores testName e testType a uma aplicação chamada testApp no CodeDeploy:

aws deploy tag-resource \
    --resource-arn  arn:aws:codedeploy:us-west-2:111122223333:application:testApp \
    --tags Key=Name,Value=testName Key=Type,Value=testType

Se for bem-sucedido, esse comando não gerará nenhum resultado.

Para obter mais informações, consulte Marcar instâncias de grupos de implantação no CodeDeploy no Guia do usuário do AWS CodeDeploy.

  • Para obter detalhes da API, consulte TagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar uninstall.

AWS CLI

Como desinstalar uma instância on-premises

O exemplo uninstall a seguir desinstala o agente do AWS CodeDeploy da instância on-premises e remove o arquivo de configuração on-premises da instância. Ele não cancela o registro da instância no AWS CodeDeploy, nem desassocia nenhuma tag de instância on-premises no AWS CodeDeploy da instância nem exclui o usuário do IAM associado à instância.

aws deploy uninstall

Este comando não produz saída.

  • Para ver detalhes da API, consulte Uninstall na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover tags de um recurso (aplicação)

O exemplo untag-resource a seguir remove duas tags com as chaves Name e Type de uma aplicação chamada testApp no CodeDeploy.

aws deploy untag-resource \
    --resource-arn  arn:aws:codedeploy:us-west-2:111122223333:application:testApp \
    --tag-keys Name Type

Se for bem-sucedido, esse comando não gerará nenhum resultado.

Para obter mais informações, consulte Marcar instâncias de grupos de implantação no CodeDeploy no Guia do usuário do AWS CodeDeploy.

  • Para obter detalhes sobre a API, consulte UntagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-application.

AWS CLI

Para alterar os detalhes de uma aplicação

O exemplo update-application a seguir altera o nome de uma aplicação associada à conta da AWS do usuário.

aws deploy update-application \
    --application-name WordPress_App \
    --new-application-name My_WordPress_App

Este comando não produz saída.

  • Para ver detalhes da API, consulte UpdateApplication na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-deployment-group.

AWS CLI

Para alterar as informações sobre um grupo de implantação

O exemplo update-deployment-group a seguir altera as configurações de um grupo de implantação associado à aplicação especificada.

aws deploy update-deployment-group \
    --application-name WordPress_App \
    --auto-scaling-groups My_CodeDeployDemo_ASG \
    --current-deployment-group-name WordPress_DG \
    --deployment-config-name CodeDeployDefault.AllAtOnce \
    --ec2-tag-filters Key=Name,Type=KEY_AND_VALUE,Value=My_CodeDeployDemo \
    --new-deployment-group-name My_WordPress_DepGroup \
    --service-role-arn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo-2

Este comando não produz saída.