@aws-sdk/client-codedeploy

Description

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

Types

Type Name
Type
_InstanceTypeTypeAlias
_InstanceTypeenumVariable
AddTagsToOnPremisesInstancesCommandClass
AddTagsToOnPremisesInstancesCommandInputInterface
AddTagsToOnPremisesInstancesCommandOutputInterface
AddTagsToOnPremisesInstancesInputInterface
AlarmInterface
AlarmConfigurationInterface
AlarmsLimitExceededExceptionClass
ApplicationAlreadyExistsExceptionClass
ApplicationDoesNotExistExceptionClass
ApplicationInfoInterface
ApplicationLimitExceededExceptionClass
ApplicationNameRequiredExceptionClass
ApplicationRevisionSortByTypeAlias
ApplicationRevisionSortByenumVariable
AppSpecContentInterface
ArnNotSupportedExceptionClass
AutoRollbackConfigurationInterface
AutoRollbackEventTypeAlias
AutoRollbackEventenumVariable
AutoScalingGroupInterface
BatchGetApplicationRevisionsCommandClass
BatchGetApplicationRevisionsCommandInputInterface
BatchGetApplicationRevisionsCommandOutputInterface
BatchGetApplicationRevisionsInputInterface
BatchGetApplicationRevisionsOutputInterface
BatchGetApplicationsCommandClass
BatchGetApplicationsCommandInputInterface
BatchGetApplicationsCommandOutputInterface
BatchGetApplicationsInputInterface
BatchGetApplicationsOutputInterface
BatchGetDeploymentGroupsCommandClass
BatchGetDeploymentGroupsCommandInputInterface
BatchGetDeploymentGroupsCommandOutputInterface
BatchGetDeploymentGroupsInputInterface
BatchGetDeploymentGroupsOutputInterface
BatchGetDeploymentInstancesCommanddeprecatedClass
BatchGetDeploymentInstancesCommandInputInterface
BatchGetDeploymentInstancesCommandOutputInterface
BatchGetDeploymentInstancesInputInterface
BatchGetDeploymentInstancesOutputInterface
BatchGetDeploymentsCommandClass
BatchGetDeploymentsCommandInputInterface
BatchGetDeploymentsCommandOutputInterface
BatchGetDeploymentsInputInterface
BatchGetDeploymentsOutputInterface
BatchGetDeploymentTargetsCommandClass
BatchGetDeploymentTargetsCommandInputInterface
BatchGetDeploymentTargetsCommandOutputInterface
BatchGetDeploymentTargetsInputInterface
BatchGetDeploymentTargetsOutputInterface
BatchGetOnPremisesInstancesCommandClass
BatchGetOnPremisesInstancesCommandInputInterface
BatchGetOnPremisesInstancesCommandOutputInterface
BatchGetOnPremisesInstancesInputInterface
BatchGetOnPremisesInstancesOutputInterface
BatchLimitExceededExceptionClass
BlueGreenDeploymentConfigurationInterface
BlueInstanceTerminationOptionInterface
BucketNameFilterRequiredExceptionClass
BundleTypeTypeAlias
BundleTypeenumVariable
ClientDefaultsInterface
ClientInputEndpointParametersInterface
CloudFormationTargetInterface
CodeDeployClass
CodeDeployInterface
CodeDeployClientClass
CodeDeployClientConfigInterface
CodeDeployClientConfigTypeTypeAlias
CodeDeployClientResolvedConfigInterface
CodeDeployClientResolvedConfigTypeTypeAlias
CodeDeployPaginationConfigurationInterface
CodeDeployServiceExceptionClass
ComputePlatformTypeAlias
ComputePlatformenumVariable
ContinueDeploymentCommandClass
ContinueDeploymentCommandInputInterface
ContinueDeploymentCommandOutputInterface
ContinueDeploymentInputInterface
CreateApplicationCommandClass
CreateApplicationCommandInputInterface
CreateApplicationCommandOutputInterface
CreateApplicationInputInterface
CreateApplicationOutputInterface
CreateDeploymentCommandClass
CreateDeploymentCommandInputInterface
CreateDeploymentCommandOutputInterface
CreateDeploymentConfigCommandClass
CreateDeploymentConfigCommandInputInterface
CreateDeploymentConfigCommandOutputInterface
CreateDeploymentConfigInputInterface
CreateDeploymentConfigOutputInterface
CreateDeploymentGroupCommandClass
CreateDeploymentGroupCommandInputInterface
CreateDeploymentGroupCommandOutputInterface
CreateDeploymentGroupInputInterface
CreateDeploymentGroupOutputInterface
CreateDeploymentInputInterface
CreateDeploymentOutputInterface
DeleteApplicationCommandClass
DeleteApplicationCommandInputInterface
DeleteApplicationCommandOutputInterface
DeleteApplicationInputInterface
DeleteDeploymentConfigCommandClass
DeleteDeploymentConfigCommandInputInterface
DeleteDeploymentConfigCommandOutputInterface
DeleteDeploymentConfigInputInterface
DeleteDeploymentGroupCommandClass
DeleteDeploymentGroupCommandInputInterface
DeleteDeploymentGroupCommandOutputInterface
DeleteDeploymentGroupInputInterface
DeleteDeploymentGroupOutputInterface
DeleteGitHubAccountTokenCommandClass
DeleteGitHubAccountTokenCommandInputInterface
DeleteGitHubAccountTokenCommandOutputInterface
DeleteGitHubAccountTokenInputInterface
DeleteGitHubAccountTokenOutputInterface
DeleteResourcesByExternalIdCommandClass
DeleteResourcesByExternalIdCommandInputInterface
DeleteResourcesByExternalIdCommandOutputInterface
DeleteResourcesByExternalIdInputInterface
DeleteResourcesByExternalIdOutputInterface
DeploymentAlreadyCompletedExceptionClass
DeploymentConfigAlreadyExistsExceptionClass
DeploymentConfigDoesNotExistExceptionClass
DeploymentConfigInfoInterface
DeploymentConfigInUseExceptionClass
DeploymentConfigLimitExceededExceptionClass
DeploymentConfigNameRequiredExceptionClass
DeploymentCreatorTypeAlias
DeploymentCreatorenumVariable
DeploymentDoesNotExistExceptionClass
DeploymentGroupAlreadyExistsExceptionClass
DeploymentGroupDoesNotExistExceptionClass
DeploymentGroupInfoInterface
DeploymentGroupLimitExceededExceptionClass
DeploymentGroupNameRequiredExceptionClass
DeploymentIdRequiredExceptionClass
DeploymentInfoInterface
DeploymentIsNotInReadyStateExceptionClass
DeploymentLimitExceededExceptionClass
DeploymentNotStartedExceptionClass
DeploymentOptionTypeAlias
DeploymentOptionenumVariable
DeploymentOverviewInterface
DeploymentReadyActionTypeAlias
DeploymentReadyActionenumVariable
DeploymentReadyOptionInterface
DeploymentStatusTypeAlias
DeploymentStatusenumVariable
DeploymentStyleInterface
DeploymentTargetInterface
DeploymentTargetDoesNotExistExceptionClass
DeploymentTargetIdRequiredExceptionClass
DeploymentTargetListSizeExceededExceptionClass
DeploymentTargetTypeTypeAlias
DeploymentTargetTypeenumVariable
DeploymentTypeTypeAlias
DeploymentTypeenumVariable
DeploymentWaitTypeTypeAlias
DeploymentWaitTypeenumVariable
DeregisterOnPremisesInstanceCommandClass
DeregisterOnPremisesInstanceCommandInputInterface
DeregisterOnPremisesInstanceCommandOutputInterface
DeregisterOnPremisesInstanceInputInterface
DescriptionTooLongExceptionClass
DiagnosticsInterface
EC2TagFilterInterface
EC2TagFilterTypeTypeAlias
EC2TagFilterTypeenumVariable
EC2TagSetInterface
ECSServiceInterface
ECSServiceMappingLimitExceededExceptionClass
ECSTargetInterface
ECSTaskSetInterface
ELBInfoInterface
ErrorCodeTypeAlias
ErrorCodeenumVariable
ErrorInformationInterface
FileExistsBehaviorTypeAlias
FileExistsBehaviorenumVariable
GenericRevisionInfoInterface
GetApplicationCommandClass
GetApplicationCommandInputInterface
GetApplicationCommandOutputInterface
GetApplicationInputInterface
GetApplicationOutputInterface
GetApplicationRevisionCommandClass
GetApplicationRevisionCommandInputInterface
GetApplicationRevisionCommandOutputInterface
GetApplicationRevisionInputInterface
GetApplicationRevisionOutputInterface
GetDeploymentCommandClass
GetDeploymentCommandInputInterface
GetDeploymentCommandOutputInterface
GetDeploymentConfigCommandClass
GetDeploymentConfigCommandInputInterface
GetDeploymentConfigCommandOutputInterface
GetDeploymentConfigInputInterface
GetDeploymentConfigOutputInterface
GetDeploymentGroupCommandClass
GetDeploymentGroupCommandInputInterface
GetDeploymentGroupCommandOutputInterface
GetDeploymentGroupInputInterface
GetDeploymentGroupOutputInterface
GetDeploymentInputInterface
GetDeploymentInstanceCommanddeprecatedClass
GetDeploymentInstanceCommandInputInterface
GetDeploymentInstanceCommandOutputInterface
GetDeploymentInstanceInputInterface
GetDeploymentInstanceOutputInterface
GetDeploymentOutputInterface
GetDeploymentTargetCommandClass
GetDeploymentTargetCommandInputInterface
GetDeploymentTargetCommandOutputInterface
GetDeploymentTargetInputInterface
GetDeploymentTargetOutputInterface
GetOnPremisesInstanceCommandClass
GetOnPremisesInstanceCommandInputInterface
GetOnPremisesInstanceCommandOutputInterface
GetOnPremisesInstanceInputInterface
GetOnPremisesInstanceOutputInterface
GitHubAccountTokenDoesNotExistExceptionClass
GitHubAccountTokenNameRequiredExceptionClass
GitHubLocationInterface
GreenFleetProvisioningActionTypeAlias
GreenFleetProvisioningActionenumVariable
GreenFleetProvisioningOptionInterface
IamArnRequiredExceptionClass
IamSessionArnAlreadyRegisteredExceptionClass
IamUserArnAlreadyRegisteredExceptionClass
IamUserArnRequiredExceptionClass
InstanceActionTypeAlias
InstanceActionenumVariable
InstanceDoesNotExistExceptiondeprecatedClass
InstanceIdRequiredExceptiondeprecatedClass
InstanceInfoInterface
InstanceLimitExceededExceptionClass
InstanceNameAlreadyRegisteredExceptionClass
InstanceNameRequiredExceptionClass
InstanceNotRegisteredExceptionClass
InstanceStatusTypeAlias
InstanceStatusenumVariable
InstanceSummarydeprecatedInterface
InstanceTargetInterface
InvalidAlarmConfigExceptionClass
InvalidApplicationNameExceptionClass
InvalidArnExceptionClass
InvalidAutoRollbackConfigExceptionClass
InvalidAutoScalingGroupExceptionClass
InvalidBlueGreenDeploymentConfigurationExceptionClass
InvalidBucketNameFilterExceptionClass
InvalidComputePlatformExceptionClass
InvalidDeployedStateFilterExceptionClass
InvalidDeploymentConfigNameExceptionClass
InvalidDeploymentGroupNameExceptionClass
InvalidDeploymentIdExceptionClass
InvalidDeploymentInstanceTypeExceptionClass
InvalidDeploymentStatusExceptionClass
InvalidDeploymentStyleExceptionClass
InvalidDeploymentTargetIdExceptionClass
InvalidDeploymentWaitTypeExceptionClass
InvalidEC2TagCombinationExceptionClass
InvalidEC2TagExceptionClass
InvalidECSServiceExceptionClass
InvalidExternalIdExceptionClass
InvalidFileExistsBehaviorExceptionClass
InvalidGitHubAccountTokenExceptionClass
InvalidGitHubAccountTokenNameExceptionClass
InvalidIamSessionArnExceptionClass
InvalidIamUserArnExceptionClass
InvalidIgnoreApplicationStopFailuresValueExceptionClass
InvalidInputExceptionClass
InvalidInstanceNameExceptionClass
InvalidInstanceStatusExceptionClass
InvalidInstanceTypeExceptionClass
InvalidKeyPrefixFilterExceptionClass
InvalidLifecycleEventHookExecutionIdExceptionClass
InvalidLifecycleEventHookExecutionStatusExceptionClass
InvalidLoadBalancerInfoExceptionClass
InvalidMinimumHealthyHostValueExceptionClass
InvalidNextTokenExceptionClass
InvalidOnPremisesTagCombinationExceptionClass
InvalidOperationExceptionClass
InvalidRegistrationStatusExceptionClass
InvalidRevisionExceptionClass
InvalidRoleExceptionClass
InvalidSortByExceptionClass
InvalidSortOrderExceptionClass
InvalidTagExceptionClass
InvalidTagFilterExceptionClass
InvalidTagsToAddExceptionClass
InvalidTargetFilterNameExceptionClass
InvalidTargetGroupPairExceptionClass
InvalidTargetInstancesExceptionClass
InvalidTimeRangeExceptionClass
InvalidTrafficRoutingConfigurationExceptionClass
InvalidTriggerConfigExceptionClass
InvalidUpdateOutdatedInstancesOnlyValueExceptionClass
InvalidZonalDeploymentConfigurationExceptionClass
LambdaFunctionInfoInterface
LambdaTargetInterface
LastDeploymentInfoInterface
LifecycleErrorCodeTypeAlias
LifecycleErrorCodeenumVariable
LifecycleEventInterface
LifecycleEventAlreadyCompletedExceptionClass
LifecycleEventStatusTypeAlias
LifecycleEventStatusenumVariable
LifecycleHookLimitExceededExceptionClass
ListApplicationRevisionsCommandClass
ListApplicationRevisionsCommandInputInterface
ListApplicationRevisionsCommandOutputInterface
ListApplicationRevisionsInputInterface
ListApplicationRevisionsOutputInterface
ListApplicationsCommandClass
ListApplicationsCommandInputInterface
ListApplicationsCommandOutputInterface
ListApplicationsInputInterface
ListApplicationsOutputInterface
ListDeploymentConfigsCommandClass
ListDeploymentConfigsCommandInputInterface
ListDeploymentConfigsCommandOutputInterface
ListDeploymentConfigsInputInterface
ListDeploymentConfigsOutputInterface
ListDeploymentGroupsCommandClass
ListDeploymentGroupsCommandInputInterface
ListDeploymentGroupsCommandOutputInterface
ListDeploymentGroupsInputInterface
ListDeploymentGroupsOutputInterface
ListDeploymentInstancesCommanddeprecatedClass
ListDeploymentInstancesCommandInputInterface
ListDeploymentInstancesCommandOutputInterface
ListDeploymentInstancesInputInterface
ListDeploymentInstancesOutputInterface
ListDeploymentsCommandClass
ListDeploymentsCommandInputInterface
ListDeploymentsCommandOutputInterface
ListDeploymentsInputInterface
ListDeploymentsOutputInterface
ListDeploymentTargetsCommandClass
ListDeploymentTargetsCommandInputInterface
ListDeploymentTargetsCommandOutputInterface
ListDeploymentTargetsInputInterface
ListDeploymentTargetsOutputInterface
ListGitHubAccountTokenNamesCommandClass
ListGitHubAccountTokenNamesCommandInputInterface
ListGitHubAccountTokenNamesCommandOutputInterface
ListGitHubAccountTokenNamesInputInterface
ListGitHubAccountTokenNamesOutputInterface
ListOnPremisesInstancesCommandClass
ListOnPremisesInstancesCommandInputInterface
ListOnPremisesInstancesCommandOutputInterface
ListOnPremisesInstancesInputInterface
ListOnPremisesInstancesOutputInterface
ListStateFilterActionTypeAlias
ListStateFilterActionenumVariable
ListTagsForResourceCommandClass
ListTagsForResourceCommandInputInterface
ListTagsForResourceCommandOutputInterface
ListTagsForResourceInputInterface
ListTagsForResourceOutputInterface
LoadBalancerInfoInterface
MinimumHealthyHostsInterface
MinimumHealthyHostsPerZoneInterface
MinimumHealthyHostsPerZoneTypeTypeAlias
MinimumHealthyHostsPerZoneTypeenumVariable
MinimumHealthyHostsTypeTypeAlias
MinimumHealthyHostsTypeenumVariable
MultipleIamArnsProvidedExceptionClass
OnPremisesTagSetInterface
OperationNotSupportedExceptionClass
OutdatedInstancesStrategyTypeAlias
OutdatedInstancesStrategyenumVariable
paginateListApplicationRevisionsVariable
paginateListApplicationsVariable
paginateListDeploymentConfigsVariable
paginateListDeploymentGroupsVariable
paginateListDeploymentInstancesVariable
paginateListDeploymentsVariable
PutLifecycleEventHookExecutionStatusCommandClass
PutLifecycleEventHookExecutionStatusCommandInputInterface
PutLifecycleEventHookExecutionStatusCommandOutputInterface
PutLifecycleEventHookExecutionStatusInputInterface
PutLifecycleEventHookExecutionStatusOutputInterface
RawStringdeprecatedInterface
RegisterApplicationRevisionCommandClass
RegisterApplicationRevisionCommandInputInterface
RegisterApplicationRevisionCommandOutputInterface
RegisterApplicationRevisionInputInterface
RegisterOnPremisesInstanceCommandClass
RegisterOnPremisesInstanceCommandInputInterface
RegisterOnPremisesInstanceCommandOutputInterface
RegisterOnPremisesInstanceInputInterface
RegistrationStatusTypeAlias
RegistrationStatusenumVariable
RelatedDeploymentsInterface
RemoveTagsFromOnPremisesInstancesCommandClass
RemoveTagsFromOnPremisesInstancesCommandInputInterface
RemoveTagsFromOnPremisesInstancesCommandOutputInterface
RemoveTagsFromOnPremisesInstancesInputInterface
ResourceArnRequiredExceptionClass
ResourceValidationExceptionClass
RevisionDoesNotExistExceptionClass
RevisionInfoInterface
RevisionLocationInterface
RevisionLocationTypeTypeAlias
RevisionLocationTypeenumVariable
RevisionRequiredExceptionClass
RoleRequiredExceptionClass
RollbackInfoInterface
RuntimeExtensionInterface
S3LocationInterface
ServiceInputTypesTypeAlias
ServiceOutputTypesTypeAlias
SkipWaitTimeForInstanceTerminationCommanddeprecatedClass
SkipWaitTimeForInstanceTerminationCommandInputInterface
SkipWaitTimeForInstanceTerminationCommandOutputInterface
SkipWaitTimeForInstanceTerminationInputInterface
SortOrderTypeAlias
SortOrderenumVariable
StopDeploymentCommandClass
StopDeploymentCommandInputInterface
StopDeploymentCommandOutputInterface
StopDeploymentInputInterface
StopDeploymentOutputInterface
StopStatusTypeAlias
StopStatusenumVariable
TagInterface
TagFilterInterface
TagFilterTypeTypeAlias
TagFilterTypeenumVariable
TagLimitExceededExceptionClass
TagRequiredExceptionClass
TagResourceCommandClass
TagResourceCommandInputInterface
TagResourceCommandOutputInterface
TagResourceInputInterface
TagResourceOutputInterface
TagSetListLimitExceededExceptionClass
TargetFilterNameTypeAlias
TargetFilterNameenumVariable
TargetGroupInfoInterface
TargetGroupPairInfoInterface
TargetInstancesInterface
TargetLabelTypeAlias
TargetLabelenumVariable
TargetStatusTypeAlias
TargetStatusenumVariable
ThrottlingExceptionClass
TimeBasedCanaryInterface
TimeBasedLinearInterface
TimeRangeInterface
TrafficRouteInterface
TrafficRoutingConfigInterface
TrafficRoutingTypeTypeAlias
TrafficRoutingTypeenumVariable
TriggerConfigInterface
TriggerEventTypeTypeAlias
TriggerEventTypeenumVariable
TriggerTargetsLimitExceededExceptionClass
UnsupportedActionForDeploymentTypeExceptionClass
UntagResourceCommandClass
UntagResourceCommandInputInterface
UntagResourceCommandOutputInterface
UntagResourceInputInterface
UntagResourceOutputInterface
UpdateApplicationCommandClass
UpdateApplicationCommandInputInterface
UpdateApplicationCommandOutputInterface
UpdateApplicationInputInterface
UpdateDeploymentGroupCommandClass
UpdateDeploymentGroupCommandInputInterface
UpdateDeploymentGroupCommandOutputInterface
UpdateDeploymentGroupInputInterface
UpdateDeploymentGroupOutputInterface
waitForDeploymentSuccessfuldeprecatedVariable
waitUntilDeploymentSuccessfulVariable
ZonalConfigInterface