CodeDeployClient

Suggest an Edit

CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use CodeDeploy.

CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

CodeDeploy Components

Use the information in this guide to help you work with the following CodeDeploy components:

  • Application: A name that uniquely identifies the application you want to deploy. CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.

  • Deployment group: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.

  • Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.

  • Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.

  • Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.

This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.

CodeDeploy Information Resources

Installation

NPM
npm install @aws-sdk/client-codedeploy
Yarn
yarn add @aws-sdk/client-codedeploy
pnpm
pnpm add @aws-sdk/client-codedeploy

CodeDeployClient Operations

Command
Summary
AddTagsToOnPremisesInstancesCommand

Adds tags to on-premises instances.

BatchGetApplicationRevisionsCommand

Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.

BatchGetApplicationsCommand

Gets information about one or more applications. The maximum number of applications that can be returned is 100.

BatchGetDeploymentGroupsCommand

Gets information about one or more deployment groups.

BatchGetDeploymentInstancesCommand

This method works, but is deprecated. Use BatchGetDeploymentTargets instead.

Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.

BatchGetDeploymentTargetsCommand

Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25.

The type of targets returned depends on the deployment's compute platform or deployment method:

  • EC2/On-premises: Information about Amazon EC2 instance targets.

  • Lambda: Information about Lambda functions targets.

  • Amazon ECS: Information about Amazon ECS service targets.

  • CloudFormation: Information about targets of blue/green deployments initiated by a CloudFormation stack update.

BatchGetDeploymentsCommand

Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.

BatchGetOnPremisesInstancesCommand

Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

ContinueDeploymentCommand

For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)

CreateApplicationCommand

Creates an application.

CreateDeploymentCommand

Deploys an application revision through the specified deployment group.

CreateDeploymentConfigCommand

Creates a deployment configuration.

CreateDeploymentGroupCommand

Creates a deployment group to which application revisions are deployed.

DeleteApplicationCommand

Deletes an application.

DeleteDeploymentConfigCommand

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.

DeleteDeploymentGroupCommand

Deletes a deployment group.

DeleteGitHubAccountTokenCommand

Deletes a GitHub account connection.

DeleteResourcesByExternalIdCommand

Deletes resources linked to an external ID. This action only applies if you have configured blue/green deployments through CloudFormation.

It is not necessary to call this action directly. CloudFormation calls it on your behalf when it needs to delete stack resources. This action is offered publicly in case you need to delete resources to comply with General Data Protection Regulation (GDPR) requirements.

DeregisterOnPremisesInstanceCommand

Deregisters an on-premises instance.

GetApplicationCommand

Gets information about an application.

GetApplicationRevisionCommand

Gets information about an application revision.

GetDeploymentCommand

Gets information about a deployment.

The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.

GetDeploymentConfigCommand

Gets information about a deployment configuration.

GetDeploymentGroupCommand

Gets information about a deployment group.

GetDeploymentInstanceCommand

Gets information about an instance as part of a deployment.

GetDeploymentTargetCommand

Returns information about a deployment target.

GetOnPremisesInstanceCommand

Gets information about an on-premises instance.

ListApplicationRevisionsCommand

Lists information about revisions for an application.

ListApplicationsCommand

Lists the applications registered with the user or Amazon Web Services account.

ListDeploymentConfigsCommand

Lists the deployment configurations with the user or Amazon Web Services account.

ListDeploymentGroupsCommand

Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.

ListDeploymentInstancesCommand

The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or Lambda.

Lists the instance for a deployment associated with the user or Amazon Web Services account.

ListDeploymentTargetsCommand

Returns an array of target IDs that are associated a deployment.

ListDeploymentsCommand

Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.

ListGitHubAccountTokenNamesCommand

Lists the names of stored connections to GitHub accounts.

ListOnPremisesInstancesCommand

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

ListTagsForResourceCommand

Returns a list of tags for the resource identified by a specified Amazon Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy resources.

PutLifecycleEventHookExecutionStatusCommand

Sets the result of a Lambda validation function. The function validates lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available lifecycle hooks are BeforeAllowTraffic and AfterAllowTraffic. For Amazon ECS deployments, the available lifecycle hooks are BeforeInstall, AfterInstall, AfterAllowTestTraffic, BeforeAllowTraffic, and AfterAllowTraffic. Lambda validation functions return Succeeded or Failed. For more information, see AppSpec 'hooks' Section for an Lambda Deployment   and AppSpec 'hooks' Section for an Amazon ECS Deployment .

RegisterApplicationRevisionCommand

Registers with CodeDeploy a revision for the specified application.

RegisterOnPremisesInstanceCommand

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

RemoveTagsFromOnPremisesInstancesCommand

Removes one or more tags from one or more on-premises instances.

SkipWaitTimeForInstanceTerminationCommand

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.

StopDeploymentCommand

Attempts to stop an ongoing deployment.

TagResourceCommand

Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.

UntagResourceCommand

Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input parameter. The tags are identified by the list of keys in the TagKeys input parameter.

UpdateApplicationCommand

Changes the name of an application.

UpdateDeploymentGroupCommand

Changes information about a deployment group.

CodeDeployClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: CodeDeployClientConfig