@aws-sdk/client-codedeploy 3.180.0 → 3.182.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/README.md +42 -50
- package/dist-cjs/models/models_0.js +23 -18
- package/dist-cjs/protocols/Aws_json1_1.js +65 -47
- package/dist-es/models/models_0.js +17 -12
- package/dist-es/protocols/Aws_json1_1.js +150 -124
- package/dist-types/CodeDeploy.d.ts +71 -79
- package/dist-types/CodeDeployClient.d.ts +42 -49
- package/dist-types/commands/BatchGetDeploymentInstancesCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetDeploymentTargetsCommand.d.ts +7 -8
- package/dist-types/commands/ListApplicationsCommand.d.ts +1 -1
- package/dist-types/commands/ListDeploymentConfigsCommand.d.ts +1 -1
- package/dist-types/commands/ListDeploymentGroupsCommand.d.ts +2 -2
- package/dist-types/commands/ListDeploymentInstancesCommand.d.ts +4 -3
- package/dist-types/commands/ListDeploymentsCommand.d.ts +2 -2
- package/dist-types/commands/PutLifecycleEventHookExecutionStatusCommand.d.ts +9 -9
- package/dist-types/commands/RegisterApplicationRevisionCommand.d.ts +1 -1
- package/dist-types/commands/RegisterOnPremisesInstanceCommand.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +375 -352
- package/dist-types/ts3.4/models/models_0.d.ts +13 -8
- package/package.json +3 -3
|
@@ -48,30 +48,29 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
48
48
|
import { UpdateApplicationCommandInput, UpdateApplicationCommandOutput } from "./commands/UpdateApplicationCommand";
|
|
49
49
|
import { UpdateDeploymentGroupCommandInput, UpdateDeploymentGroupCommandOutput } from "./commands/UpdateDeploymentGroupCommand";
|
|
50
50
|
/**
|
|
51
|
-
* <
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
51
|
+
* <p>CodeDeploy is a deployment service that automates application deployments
|
|
52
|
+
* to Amazon EC2 instances, on-premises instances running in your own facility,
|
|
53
|
+
* serverless Lambda functions, or applications in an Amazon ECS
|
|
54
|
+
* service.</p>
|
|
55
55
|
* <p>You can deploy a nearly unlimited variety of application content, such as an updated
|
|
56
|
-
*
|
|
57
|
-
* configuration files, executables, packages, scripts, multimedia files, and
|
|
58
|
-
* CodeDeploy can deploy application content stored in Amazon S3
|
|
59
|
-
* repositories, or Bitbucket repositories. You do not need to make changes
|
|
60
|
-
* existing code before you can use
|
|
61
|
-
* <p>
|
|
62
|
-
* avoid downtime during application deployment, and handles the complexity of updating
|
|
56
|
+
* Lambda function, updated applications in an Amazon ECS service,
|
|
57
|
+
* code, web and configuration files, executables, packages, scripts, multimedia files, and
|
|
58
|
+
* so on. CodeDeploy can deploy application content stored in Amazon S3
|
|
59
|
+
* buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes
|
|
60
|
+
* to your existing code before you can use CodeDeploy.</p>
|
|
61
|
+
* <p>CodeDeploy makes it easier for you to rapidly release new features, helps
|
|
62
|
+
* you avoid downtime during application deployment, and handles the complexity of updating
|
|
63
63
|
* your applications, without many of the risks associated with error-prone manual
|
|
64
64
|
* deployments.</p>
|
|
65
65
|
* <p>
|
|
66
|
-
* <b>
|
|
66
|
+
* <b>CodeDeploy Components</b>
|
|
67
67
|
* </p>
|
|
68
|
-
* <p>Use the information in this guide to help you work with the following
|
|
69
|
-
* components:</p>
|
|
68
|
+
* <p>Use the information in this guide to help you work with the following CodeDeploy components:</p>
|
|
70
69
|
* <ul>
|
|
71
70
|
* <li>
|
|
72
71
|
* <p>
|
|
73
72
|
* <b>Application</b>: A name that uniquely identifies
|
|
74
|
-
* the application you want to deploy.
|
|
73
|
+
* the application you want to deploy. CodeDeploy uses this name, which
|
|
75
74
|
* functions as a container, to ensure the correct combination of revision,
|
|
76
75
|
* deployment configuration, and deployment group are referenced during a
|
|
77
76
|
* deployment.</p>
|
|
@@ -79,72 +78,66 @@ import { UpdateDeploymentGroupCommandInput, UpdateDeploymentGroupCommandOutput }
|
|
|
79
78
|
* <li>
|
|
80
79
|
* <p>
|
|
81
80
|
* <b>Deployment group</b>: A set of individual
|
|
82
|
-
* instances, CodeDeploy
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
* specifies the service created in Amazon ECS to deploy, a load balancer, and a
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
* groups can specify optional trigger, alarm, and rollback settings.</p>
|
|
81
|
+
* instances, CodeDeploy
|
|
82
|
+
* Lambda deployment configuration settings, or an Amazon ECS
|
|
83
|
+
* service and network details. A Lambda deployment group specifies how
|
|
84
|
+
* 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
|
|
85
|
+
* 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
|
|
86
|
+
* deployment groups can specify optional trigger, alarm, and rollback
|
|
87
|
+
* settings.</p>
|
|
90
88
|
* </li>
|
|
91
89
|
* <li>
|
|
92
90
|
* <p>
|
|
93
91
|
* <b>Deployment configuration</b>: A set of deployment
|
|
94
|
-
* rules and deployment success and failure conditions used by
|
|
95
|
-
* during a deployment.</p>
|
|
92
|
+
* rules and deployment success and failure conditions used by CodeDeploy during a deployment.</p>
|
|
96
93
|
* </li>
|
|
97
94
|
* <li>
|
|
98
95
|
* <p>
|
|
99
96
|
* <b>Deployment</b>: The process and the components used
|
|
100
|
-
* when updating a Lambda function, a containerized application in an
|
|
101
|
-
*
|
|
97
|
+
* when updating a Lambda function, a containerized application in an
|
|
98
|
+
* Amazon ECS service, or of installing content on one or more
|
|
99
|
+
* instances. </p>
|
|
102
100
|
* </li>
|
|
103
101
|
* <li>
|
|
104
102
|
* <p>
|
|
105
|
-
* <b>Application revisions</b>: For an
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* object key and its ETag, version, or both. For GitHub, a revision is uniquely
|
|
103
|
+
* <b>Application revisions</b>: For an Lambda deployment, this is an AppSpec file that specifies the
|
|
104
|
+
* Lambda function to be updated and one or more functions to
|
|
105
|
+
* validate deployment lifecycle events. For an Amazon ECS deployment, this
|
|
106
|
+
* is an AppSpec file that specifies the Amazon ECS task definition,
|
|
107
|
+
* container, and port where production traffic is rerouted. For an EC2/On-premises
|
|
108
|
+
* deployment, this is an archive file that contains source content—source code,
|
|
109
|
+
* webpages, executable files, and deployment scripts—along with an AppSpec file.
|
|
110
|
+
* Revisions are stored in Amazon S3 buckets or GitHub repositories. For
|
|
111
|
+
* 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
|
|
115
112
|
* identified by its commit ID.</p>
|
|
116
113
|
* </li>
|
|
117
114
|
* </ul>
|
|
118
115
|
* <p>This guide also contains information to help you get details about the instances in
|
|
119
|
-
* your deployments, to make on-premises instances available for
|
|
120
|
-
* deployments, to get details about a Lambda function deployment, and to get
|
|
121
|
-
* Amazon ECS service deployments.</p>
|
|
116
|
+
* your deployments, to make on-premises instances available for CodeDeploy
|
|
117
|
+
* deployments, to get details about a Lambda function deployment, and to get
|
|
118
|
+
* details about Amazon ECS service deployments.</p>
|
|
122
119
|
* <p>
|
|
123
|
-
* <b>
|
|
120
|
+
* <b>CodeDeploy Information Resources</b>
|
|
124
121
|
* </p>
|
|
125
122
|
* <ul>
|
|
126
123
|
* <li>
|
|
127
124
|
* <p>
|
|
128
|
-
* <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">
|
|
129
|
-
* User Guide</a>
|
|
125
|
+
* <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a>
|
|
130
126
|
* </p>
|
|
131
127
|
* </li>
|
|
132
128
|
* <li>
|
|
133
129
|
* <p>
|
|
134
|
-
* <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">
|
|
135
|
-
* CodeDeploy API Reference Guide</a>
|
|
130
|
+
* <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">CodeDeploy API Reference Guide</a>
|
|
136
131
|
* </p>
|
|
137
132
|
* </li>
|
|
138
133
|
* <li>
|
|
139
134
|
* <p>
|
|
140
|
-
* <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">
|
|
141
|
-
* CLI Reference for AWS CodeDeploy</a>
|
|
135
|
+
* <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">CLI Reference for CodeDeploy</a>
|
|
142
136
|
* </p>
|
|
143
137
|
* </li>
|
|
144
138
|
* <li>
|
|
145
139
|
* <p>
|
|
146
|
-
* <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">
|
|
147
|
-
* Developer Forum</a>
|
|
140
|
+
* <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">CodeDeploy Developer Forum</a>
|
|
148
141
|
* </p>
|
|
149
142
|
* </li>
|
|
150
143
|
* </ul>
|
|
@@ -184,7 +177,7 @@ export declare class CodeDeploy extends CodeDeployClient {
|
|
|
184
177
|
* instead. </p>
|
|
185
178
|
* </note>
|
|
186
179
|
* <p> Returns an array of one or more instances associated with a deployment. This method
|
|
187
|
-
* works with EC2/On-premises and
|
|
180
|
+
* works with EC2/On-premises and Lambda compute platforms. The newer
|
|
188
181
|
* <code>BatchGetDeploymentTargets</code> works with all compute platforms. The maximum
|
|
189
182
|
* number of instances that can be returned is 25.</p>
|
|
190
183
|
*/
|
|
@@ -208,23 +201,22 @@ export declare class CodeDeploy extends CodeDeployClient {
|
|
|
208
201
|
* <ul>
|
|
209
202
|
* <li>
|
|
210
203
|
* <p>
|
|
211
|
-
* <b>EC2/On-premises</b>: Information about EC2 instance
|
|
212
|
-
* targets. </p>
|
|
204
|
+
* <b>EC2/On-premises</b>: Information about Amazon EC2 instance targets. </p>
|
|
213
205
|
* </li>
|
|
214
206
|
* <li>
|
|
215
207
|
* <p>
|
|
216
|
-
* <b>
|
|
217
|
-
*
|
|
208
|
+
* <b>Lambda</b>: Information about
|
|
209
|
+
* Lambda functions targets. </p>
|
|
218
210
|
* </li>
|
|
219
211
|
* <li>
|
|
220
212
|
* <p>
|
|
221
|
-
* <b>Amazon ECS</b>: Information about Amazon ECS
|
|
222
|
-
* service targets. </p>
|
|
213
|
+
* <b>Amazon ECS</b>: Information about Amazon ECS service targets. </p>
|
|
223
214
|
* </li>
|
|
224
215
|
* <li>
|
|
225
216
|
* <p>
|
|
226
|
-
* <b>CloudFormation</b>: Information about
|
|
227
|
-
* blue/green deployments initiated by a CloudFormation stack
|
|
217
|
+
* <b>CloudFormation</b>: Information about
|
|
218
|
+
* targets of blue/green deployments initiated by a CloudFormation stack
|
|
219
|
+
* update.</p>
|
|
228
220
|
* </li>
|
|
229
221
|
* </ul>
|
|
230
222
|
*/
|
|
@@ -375,20 +367,20 @@ export declare class CodeDeploy extends CodeDeployClient {
|
|
|
375
367
|
listApplicationRevisions(args: ListApplicationRevisionsCommandInput, cb: (err: any, data?: ListApplicationRevisionsCommandOutput) => void): void;
|
|
376
368
|
listApplicationRevisions(args: ListApplicationRevisionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationRevisionsCommandOutput) => void): void;
|
|
377
369
|
/**
|
|
378
|
-
* <p>Lists the applications registered with the IAM user or
|
|
370
|
+
* <p>Lists the applications registered with the IAM user or Amazon Web Services account.</p>
|
|
379
371
|
*/
|
|
380
372
|
listApplications(args: ListApplicationsCommandInput, options?: __HttpHandlerOptions): Promise<ListApplicationsCommandOutput>;
|
|
381
373
|
listApplications(args: ListApplicationsCommandInput, cb: (err: any, data?: ListApplicationsCommandOutput) => void): void;
|
|
382
374
|
listApplications(args: ListApplicationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListApplicationsCommandOutput) => void): void;
|
|
383
375
|
/**
|
|
384
|
-
* <p>Lists the deployment configurations with the IAM user or
|
|
376
|
+
* <p>Lists the deployment configurations with the IAM user or Amazon Web Services account.</p>
|
|
385
377
|
*/
|
|
386
378
|
listDeploymentConfigs(args: ListDeploymentConfigsCommandInput, options?: __HttpHandlerOptions): Promise<ListDeploymentConfigsCommandOutput>;
|
|
387
379
|
listDeploymentConfigs(args: ListDeploymentConfigsCommandInput, cb: (err: any, data?: ListDeploymentConfigsCommandOutput) => void): void;
|
|
388
380
|
listDeploymentConfigs(args: ListDeploymentConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentConfigsCommandOutput) => void): void;
|
|
389
381
|
/**
|
|
390
|
-
* <p>Lists the deployment groups for an application registered with the IAM
|
|
391
|
-
* account.</p>
|
|
382
|
+
* <p>Lists the deployment groups for an application registered with the IAM
|
|
383
|
+
* user or Amazon Web Services account.</p>
|
|
392
384
|
*/
|
|
393
385
|
listDeploymentGroups(args: ListDeploymentGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListDeploymentGroupsCommandOutput>;
|
|
394
386
|
listDeploymentGroups(args: ListDeploymentGroupsCommandInput, cb: (err: any, data?: ListDeploymentGroupsCommandOutput) => void): void;
|
|
@@ -399,17 +391,18 @@ export declare class CodeDeploy extends CodeDeployClient {
|
|
|
399
391
|
* <note>
|
|
400
392
|
* <p> The newer <code>BatchGetDeploymentTargets</code> should be used instead because
|
|
401
393
|
* it works with all compute types. <code>ListDeploymentInstances</code> throws an
|
|
402
|
-
* exception if it is used with a compute platform other than EC2/On-premises or
|
|
403
|
-
*
|
|
394
|
+
* exception if it is used with a compute platform other than EC2/On-premises or
|
|
395
|
+
* Lambda. </p>
|
|
404
396
|
* </note>
|
|
405
|
-
* <p> Lists the instance for a deployment associated with the IAM user or
|
|
397
|
+
* <p> Lists the instance for a deployment associated with the IAM user or
|
|
398
|
+
* Amazon Web Services account. </p>
|
|
406
399
|
*/
|
|
407
400
|
listDeploymentInstances(args: ListDeploymentInstancesCommandInput, options?: __HttpHandlerOptions): Promise<ListDeploymentInstancesCommandOutput>;
|
|
408
401
|
listDeploymentInstances(args: ListDeploymentInstancesCommandInput, cb: (err: any, data?: ListDeploymentInstancesCommandOutput) => void): void;
|
|
409
402
|
listDeploymentInstances(args: ListDeploymentInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeploymentInstancesCommandOutput) => void): void;
|
|
410
403
|
/**
|
|
411
|
-
* <p>Lists the deployments in a deployment group for an application registered with the
|
|
412
|
-
*
|
|
404
|
+
* <p>Lists the deployments in a deployment group for an application registered with the
|
|
405
|
+
* IAM user or Amazon Web Services account.</p>
|
|
413
406
|
*/
|
|
414
407
|
listDeployments(args: ListDeploymentsCommandInput, options?: __HttpHandlerOptions): Promise<ListDeploymentsCommandOutput>;
|
|
415
408
|
listDeployments(args: ListDeploymentsCommandInput, cb: (err: any, data?: ListDeploymentsCommandOutput) => void): void;
|
|
@@ -443,21 +436,21 @@ export declare class CodeDeploy extends CodeDeployClient {
|
|
|
443
436
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
444
437
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
445
438
|
/**
|
|
446
|
-
* <p> Sets the result of a Lambda validation function. The function validates
|
|
447
|
-
* hooks during a deployment that uses the
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
* <code>
|
|
452
|
-
* <code>
|
|
453
|
-
*
|
|
454
|
-
*
|
|
439
|
+
* <p> Sets the result of a Lambda validation function. The function validates
|
|
440
|
+
* lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available
|
|
441
|
+
* lifecycle hooks are <code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>.
|
|
442
|
+
* For Amazon ECS deployments, the available lifecycle hooks are
|
|
443
|
+
* <code>BeforeInstall</code>, <code>AfterInstall</code>,
|
|
444
|
+
* <code>AfterAllowTestTraffic</code>, <code>BeforeAllowTraffic</code>, and
|
|
445
|
+
* <code>AfterAllowTraffic</code>. Lambda validation functions return
|
|
446
|
+
* <code>Succeeded</code> or <code>Failed</code>. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda">AppSpec 'hooks' Section for an Lambda Deployment </a> and
|
|
447
|
+
* <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs">AppSpec 'hooks' Section for an Amazon ECS Deployment</a>.</p>
|
|
455
448
|
*/
|
|
456
449
|
putLifecycleEventHookExecutionStatus(args: PutLifecycleEventHookExecutionStatusCommandInput, options?: __HttpHandlerOptions): Promise<PutLifecycleEventHookExecutionStatusCommandOutput>;
|
|
457
450
|
putLifecycleEventHookExecutionStatus(args: PutLifecycleEventHookExecutionStatusCommandInput, cb: (err: any, data?: PutLifecycleEventHookExecutionStatusCommandOutput) => void): void;
|
|
458
451
|
putLifecycleEventHookExecutionStatus(args: PutLifecycleEventHookExecutionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecycleEventHookExecutionStatusCommandOutput) => void): void;
|
|
459
452
|
/**
|
|
460
|
-
* <p>Registers with
|
|
453
|
+
* <p>Registers with CodeDeploy a revision for the specified application.</p>
|
|
461
454
|
*/
|
|
462
455
|
registerApplicationRevision(args: RegisterApplicationRevisionCommandInput, options?: __HttpHandlerOptions): Promise<RegisterApplicationRevisionCommandOutput>;
|
|
463
456
|
registerApplicationRevision(args: RegisterApplicationRevisionCommandInput, cb: (err: any, data?: RegisterApplicationRevisionCommandOutput) => void): void;
|
|
@@ -465,8 +458,7 @@ export declare class CodeDeploy extends CodeDeployClient {
|
|
|
465
458
|
/**
|
|
466
459
|
* <p>Registers an on-premises instance.</p>
|
|
467
460
|
* <note>
|
|
468
|
-
* <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request.
|
|
469
|
-
* You cannot use both.</p>
|
|
461
|
+
* <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.</p>
|
|
470
462
|
* </note>
|
|
471
463
|
*/
|
|
472
464
|
registerOnPremisesInstance(args: RegisterOnPremisesInstanceCommandInput, options?: __HttpHandlerOptions): Promise<RegisterOnPremisesInstanceCommandOutput>;
|
|
@@ -173,30 +173,29 @@ declare type CodeDeployClientResolvedConfigType = __SmithyResolvedConfiguration<
|
|
|
173
173
|
export interface CodeDeployClientResolvedConfig extends CodeDeployClientResolvedConfigType {
|
|
174
174
|
}
|
|
175
175
|
/**
|
|
176
|
-
* <
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
176
|
+
* <p>CodeDeploy is a deployment service that automates application deployments
|
|
177
|
+
* to Amazon EC2 instances, on-premises instances running in your own facility,
|
|
178
|
+
* serverless Lambda functions, or applications in an Amazon ECS
|
|
179
|
+
* service.</p>
|
|
180
180
|
* <p>You can deploy a nearly unlimited variety of application content, such as an updated
|
|
181
|
-
*
|
|
182
|
-
* configuration files, executables, packages, scripts, multimedia files, and
|
|
183
|
-
* CodeDeploy can deploy application content stored in Amazon S3
|
|
184
|
-
* repositories, or Bitbucket repositories. You do not need to make changes
|
|
185
|
-
* existing code before you can use
|
|
186
|
-
* <p>
|
|
187
|
-
* avoid downtime during application deployment, and handles the complexity of updating
|
|
181
|
+
* Lambda function, updated applications in an Amazon ECS service,
|
|
182
|
+
* code, web and configuration files, executables, packages, scripts, multimedia files, and
|
|
183
|
+
* so on. CodeDeploy can deploy application content stored in Amazon S3
|
|
184
|
+
* buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes
|
|
185
|
+
* to your existing code before you can use CodeDeploy.</p>
|
|
186
|
+
* <p>CodeDeploy makes it easier for you to rapidly release new features, helps
|
|
187
|
+
* you avoid downtime during application deployment, and handles the complexity of updating
|
|
188
188
|
* your applications, without many of the risks associated with error-prone manual
|
|
189
189
|
* deployments.</p>
|
|
190
190
|
* <p>
|
|
191
|
-
* <b>
|
|
191
|
+
* <b>CodeDeploy Components</b>
|
|
192
192
|
* </p>
|
|
193
|
-
* <p>Use the information in this guide to help you work with the following
|
|
194
|
-
* components:</p>
|
|
193
|
+
* <p>Use the information in this guide to help you work with the following CodeDeploy components:</p>
|
|
195
194
|
* <ul>
|
|
196
195
|
* <li>
|
|
197
196
|
* <p>
|
|
198
197
|
* <b>Application</b>: A name that uniquely identifies
|
|
199
|
-
* the application you want to deploy.
|
|
198
|
+
* the application you want to deploy. CodeDeploy uses this name, which
|
|
200
199
|
* functions as a container, to ensure the correct combination of revision,
|
|
201
200
|
* deployment configuration, and deployment group are referenced during a
|
|
202
201
|
* deployment.</p>
|
|
@@ -204,72 +203,66 @@ export interface CodeDeployClientResolvedConfig extends CodeDeployClientResolved
|
|
|
204
203
|
* <li>
|
|
205
204
|
* <p>
|
|
206
205
|
* <b>Deployment group</b>: A set of individual
|
|
207
|
-
* instances, CodeDeploy
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
* specifies the service created in Amazon ECS to deploy, a load balancer, and a
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
* groups can specify optional trigger, alarm, and rollback settings.</p>
|
|
206
|
+
* instances, CodeDeploy
|
|
207
|
+
* Lambda deployment configuration settings, or an Amazon ECS
|
|
208
|
+
* service and network details. A Lambda deployment group specifies how
|
|
209
|
+
* 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
|
|
210
|
+
* 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
|
|
211
|
+
* deployment groups can specify optional trigger, alarm, and rollback
|
|
212
|
+
* settings.</p>
|
|
215
213
|
* </li>
|
|
216
214
|
* <li>
|
|
217
215
|
* <p>
|
|
218
216
|
* <b>Deployment configuration</b>: A set of deployment
|
|
219
|
-
* rules and deployment success and failure conditions used by
|
|
220
|
-
* during a deployment.</p>
|
|
217
|
+
* rules and deployment success and failure conditions used by CodeDeploy during a deployment.</p>
|
|
221
218
|
* </li>
|
|
222
219
|
* <li>
|
|
223
220
|
* <p>
|
|
224
221
|
* <b>Deployment</b>: The process and the components used
|
|
225
|
-
* when updating a Lambda function, a containerized application in an
|
|
226
|
-
*
|
|
222
|
+
* when updating a Lambda function, a containerized application in an
|
|
223
|
+
* Amazon ECS service, or of installing content on one or more
|
|
224
|
+
* instances. </p>
|
|
227
225
|
* </li>
|
|
228
226
|
* <li>
|
|
229
227
|
* <p>
|
|
230
|
-
* <b>Application revisions</b>: For an
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
*
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
* object key and its ETag, version, or both. For GitHub, a revision is uniquely
|
|
228
|
+
* <b>Application revisions</b>: For an Lambda deployment, this is an AppSpec file that specifies the
|
|
229
|
+
* Lambda function to be updated and one or more functions to
|
|
230
|
+
* validate deployment lifecycle events. For an Amazon ECS deployment, this
|
|
231
|
+
* is an AppSpec file that specifies the Amazon ECS task definition,
|
|
232
|
+
* container, and port where production traffic is rerouted. For an EC2/On-premises
|
|
233
|
+
* deployment, this is an archive file that contains source content—source code,
|
|
234
|
+
* webpages, executable files, and deployment scripts—along with an AppSpec file.
|
|
235
|
+
* Revisions are stored in Amazon S3 buckets or GitHub repositories. For
|
|
236
|
+
* 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
|
|
240
237
|
* identified by its commit ID.</p>
|
|
241
238
|
* </li>
|
|
242
239
|
* </ul>
|
|
243
240
|
* <p>This guide also contains information to help you get details about the instances in
|
|
244
|
-
* your deployments, to make on-premises instances available for
|
|
245
|
-
* deployments, to get details about a Lambda function deployment, and to get
|
|
246
|
-
* Amazon ECS service deployments.</p>
|
|
241
|
+
* your deployments, to make on-premises instances available for CodeDeploy
|
|
242
|
+
* deployments, to get details about a Lambda function deployment, and to get
|
|
243
|
+
* details about Amazon ECS service deployments.</p>
|
|
247
244
|
* <p>
|
|
248
|
-
* <b>
|
|
245
|
+
* <b>CodeDeploy Information Resources</b>
|
|
249
246
|
* </p>
|
|
250
247
|
* <ul>
|
|
251
248
|
* <li>
|
|
252
249
|
* <p>
|
|
253
|
-
* <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">
|
|
254
|
-
* User Guide</a>
|
|
250
|
+
* <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide">CodeDeploy User Guide</a>
|
|
255
251
|
* </p>
|
|
256
252
|
* </li>
|
|
257
253
|
* <li>
|
|
258
254
|
* <p>
|
|
259
|
-
* <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">
|
|
260
|
-
* CodeDeploy API Reference Guide</a>
|
|
255
|
+
* <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/">CodeDeploy API Reference Guide</a>
|
|
261
256
|
* </p>
|
|
262
257
|
* </li>
|
|
263
258
|
* <li>
|
|
264
259
|
* <p>
|
|
265
|
-
* <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">
|
|
266
|
-
* CLI Reference for AWS CodeDeploy</a>
|
|
260
|
+
* <a href="https://docs.aws.amazon.com/cli/latest/reference/deploy/index.html">CLI Reference for CodeDeploy</a>
|
|
267
261
|
* </p>
|
|
268
262
|
* </li>
|
|
269
263
|
* <li>
|
|
270
264
|
* <p>
|
|
271
|
-
* <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">
|
|
272
|
-
* Developer Forum</a>
|
|
265
|
+
* <a href="https://forums.aws.amazon.com/forum.jspa?forumID=179">CodeDeploy Developer Forum</a>
|
|
273
266
|
* </p>
|
|
274
267
|
* </li>
|
|
275
268
|
* </ul>
|
|
@@ -14,7 +14,7 @@ export interface BatchGetDeploymentInstancesCommandOutput extends BatchGetDeploy
|
|
|
14
14
|
* instead. </p>
|
|
15
15
|
* </note>
|
|
16
16
|
* <p> Returns an array of one or more instances associated with a deployment. This method
|
|
17
|
-
* works with EC2/On-premises and
|
|
17
|
+
* works with EC2/On-premises and Lambda compute platforms. The newer
|
|
18
18
|
* <code>BatchGetDeploymentTargets</code> works with all compute platforms. The maximum
|
|
19
19
|
* number of instances that can be returned is 25.</p>
|
|
20
20
|
* @example
|
|
@@ -16,23 +16,22 @@ export interface BatchGetDeploymentTargetsCommandOutput extends BatchGetDeployme
|
|
|
16
16
|
* <ul>
|
|
17
17
|
* <li>
|
|
18
18
|
* <p>
|
|
19
|
-
* <b>EC2/On-premises</b>: Information about EC2 instance
|
|
20
|
-
* targets. </p>
|
|
19
|
+
* <b>EC2/On-premises</b>: Information about Amazon EC2 instance targets. </p>
|
|
21
20
|
* </li>
|
|
22
21
|
* <li>
|
|
23
22
|
* <p>
|
|
24
|
-
* <b>
|
|
25
|
-
*
|
|
23
|
+
* <b>Lambda</b>: Information about
|
|
24
|
+
* Lambda functions targets. </p>
|
|
26
25
|
* </li>
|
|
27
26
|
* <li>
|
|
28
27
|
* <p>
|
|
29
|
-
* <b>Amazon ECS</b>: Information about Amazon ECS
|
|
30
|
-
* service targets. </p>
|
|
28
|
+
* <b>Amazon ECS</b>: Information about Amazon ECS service targets. </p>
|
|
31
29
|
* </li>
|
|
32
30
|
* <li>
|
|
33
31
|
* <p>
|
|
34
|
-
* <b>CloudFormation</b>: Information about
|
|
35
|
-
* blue/green deployments initiated by a CloudFormation stack
|
|
32
|
+
* <b>CloudFormation</b>: Information about
|
|
33
|
+
* targets of blue/green deployments initiated by a CloudFormation stack
|
|
34
|
+
* update.</p>
|
|
36
35
|
* </li>
|
|
37
36
|
* </ul>
|
|
38
37
|
* @example
|
|
@@ -7,7 +7,7 @@ export interface ListApplicationsCommandInput extends ListApplicationsInput {
|
|
|
7
7
|
export interface ListApplicationsCommandOutput extends ListApplicationsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the applications registered with the IAM user or
|
|
10
|
+
* <p>Lists the applications registered with the IAM user or Amazon Web Services account.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface ListDeploymentConfigsCommandInput extends ListDeploymentConfigs
|
|
|
7
7
|
export interface ListDeploymentConfigsCommandOutput extends ListDeploymentConfigsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the deployment configurations with the IAM user or
|
|
10
|
+
* <p>Lists the deployment configurations with the IAM user or Amazon Web Services account.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface ListDeploymentGroupsCommandInput extends ListDeploymentGroupsIn
|
|
|
7
7
|
export interface ListDeploymentGroupsCommandOutput extends ListDeploymentGroupsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the deployment groups for an application registered with the IAM
|
|
11
|
-
* account.</p>
|
|
10
|
+
* <p>Lists the deployment groups for an application registered with the IAM
|
|
11
|
+
* user or Amazon Web Services account.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -12,10 +12,11 @@ export interface ListDeploymentInstancesCommandOutput extends ListDeploymentInst
|
|
|
12
12
|
* <note>
|
|
13
13
|
* <p> The newer <code>BatchGetDeploymentTargets</code> should be used instead because
|
|
14
14
|
* it works with all compute types. <code>ListDeploymentInstances</code> throws an
|
|
15
|
-
* exception if it is used with a compute platform other than EC2/On-premises or
|
|
16
|
-
*
|
|
15
|
+
* exception if it is used with a compute platform other than EC2/On-premises or
|
|
16
|
+
* Lambda. </p>
|
|
17
17
|
* </note>
|
|
18
|
-
* <p> Lists the instance for a deployment associated with the IAM user or
|
|
18
|
+
* <p> Lists the instance for a deployment associated with the IAM user or
|
|
19
|
+
* Amazon Web Services account. </p>
|
|
19
20
|
* @example
|
|
20
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
22
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface ListDeploymentsCommandInput extends ListDeploymentsInput {
|
|
|
7
7
|
export interface ListDeploymentsCommandOutput extends ListDeploymentsOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the deployments in a deployment group for an application registered with the
|
|
11
|
-
*
|
|
10
|
+
* <p>Lists the deployments in a deployment group for an application registered with the
|
|
11
|
+
* IAM user or Amazon Web Services account.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -7,15 +7,15 @@ export interface PutLifecycleEventHookExecutionStatusCommandInput extends PutLif
|
|
|
7
7
|
export interface PutLifecycleEventHookExecutionStatusCommandOutput extends PutLifecycleEventHookExecutionStatusOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p> Sets the result of a Lambda validation function. The function validates
|
|
11
|
-
* hooks during a deployment that uses the
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* <code>
|
|
16
|
-
* <code>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
10
|
+
* <p> Sets the result of a Lambda validation function. The function validates
|
|
11
|
+
* lifecycle hooks during a deployment that uses the Lambda or Amazon ECS compute platform. For Lambda deployments, the available
|
|
12
|
+
* lifecycle hooks are <code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>.
|
|
13
|
+
* For Amazon ECS deployments, the available lifecycle hooks are
|
|
14
|
+
* <code>BeforeInstall</code>, <code>AfterInstall</code>,
|
|
15
|
+
* <code>AfterAllowTestTraffic</code>, <code>BeforeAllowTraffic</code>, and
|
|
16
|
+
* <code>AfterAllowTraffic</code>. Lambda validation functions return
|
|
17
|
+
* <code>Succeeded</code> or <code>Failed</code>. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda">AppSpec 'hooks' Section for an Lambda Deployment </a> and
|
|
18
|
+
* <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-ecs">AppSpec 'hooks' Section for an Amazon ECS Deployment</a>.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface RegisterApplicationRevisionCommandInput extends RegisterApplica
|
|
|
7
7
|
export interface RegisterApplicationRevisionCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Registers with
|
|
10
|
+
* <p>Registers with CodeDeploy a revision for the specified application.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -9,8 +9,7 @@ export interface RegisterOnPremisesInstanceCommandOutput extends __MetadataBeare
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Registers an on-premises instance.</p>
|
|
11
11
|
* <note>
|
|
12
|
-
* <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request.
|
|
13
|
-
* You cannot use both.</p>
|
|
12
|
+
* <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.</p>
|
|
14
13
|
* </note>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|