@cdklabs/cdk-ecs-codedeploy 0.0.257 → 0.0.258
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/.jsii +3 -3
- package/API.md +18 -0
- package/lib/api-canary/index.js +3 -3
- package/lib/ecs-appspec/index.js +1 -1
- package/lib/ecs-deployment/index.js +1 -1
- package/lib/ecs-patterns/application-load-balanced-codedeployed-fargate-service.js +1 -1
- package/package.json +4 -4
- package/API.md.md +0 -2296
package/API.md.md
DELETED
|
@@ -1,2296 +0,0 @@
|
|
|
1
|
-
# API Reference <a name="API Reference" id="api-reference"></a>
|
|
2
|
-
|
|
3
|
-
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
|
-
|
|
5
|
-
### ApiCanary <a name="ApiCanary" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary"></a>
|
|
6
|
-
|
|
7
|
-
A CloudWatch Synthetic Canary for monitoring APIs.
|
|
8
|
-
|
|
9
|
-
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.Initializer"></a>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
import { ApiCanary } from '@cdklabs/cdk-ecs-codedeploy'
|
|
13
|
-
|
|
14
|
-
new ApiCanary(scope: Construct, id: string, props: ApiCanaryProps)
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
| **Name** | **Type** | **Description** |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
20
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
21
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps">ApiCanaryProps</a></code> | *No description.* |
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.Initializer.parameter.scope"></a>
|
|
26
|
-
|
|
27
|
-
- *Type:* constructs.Construct
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
##### `id`<sup>Required</sup> <a name="id" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.Initializer.parameter.id"></a>
|
|
32
|
-
|
|
33
|
-
- *Type:* string
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.Initializer.parameter.props"></a>
|
|
38
|
-
|
|
39
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps">ApiCanaryProps</a>
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
44
|
-
|
|
45
|
-
| **Name** | **Description** |
|
|
46
|
-
| --- | --- |
|
|
47
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
48
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
49
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricDuration">metricDuration</a></code> | Measure the Duration of a single canary run, in seconds. |
|
|
50
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricFailed">metricFailed</a></code> | Measure the number of failed canary runs over a given time period. |
|
|
51
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricSuccessPercent">metricSuccessPercent</a></code> | Measure the percentage of successful canary runs. |
|
|
52
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.addTestStep">addTestStep</a></code> | Add a new test step to this canary. |
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
##### `toString` <a name="toString" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.toString"></a>
|
|
57
|
-
|
|
58
|
-
```typescript
|
|
59
|
-
public toString(): string
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
Returns a string representation of this construct.
|
|
63
|
-
|
|
64
|
-
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.applyRemovalPolicy"></a>
|
|
65
|
-
|
|
66
|
-
```typescript
|
|
67
|
-
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
Apply the given removal policy to this resource.
|
|
71
|
-
|
|
72
|
-
The Removal Policy controls what happens to this resource when it stops
|
|
73
|
-
being managed by CloudFormation, either because you've removed it from the
|
|
74
|
-
CDK application or because you've made a change that requires the resource
|
|
75
|
-
to be replaced.
|
|
76
|
-
|
|
77
|
-
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
78
|
-
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
79
|
-
|
|
80
|
-
###### `policy`<sup>Required</sup> <a name="policy" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.applyRemovalPolicy.parameter.policy"></a>
|
|
81
|
-
|
|
82
|
-
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
83
|
-
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
##### `metricDuration` <a name="metricDuration" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricDuration"></a>
|
|
87
|
-
|
|
88
|
-
```typescript
|
|
89
|
-
public metricDuration(options?: MetricOptions): Metric
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
Measure the Duration of a single canary run, in seconds.
|
|
93
|
-
|
|
94
|
-
###### `options`<sup>Optional</sup> <a name="options" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricDuration.parameter.options"></a>
|
|
95
|
-
|
|
96
|
-
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
|
|
97
|
-
|
|
98
|
-
configuration options for the metric.
|
|
99
|
-
|
|
100
|
-
---
|
|
101
|
-
|
|
102
|
-
##### `metricFailed` <a name="metricFailed" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricFailed"></a>
|
|
103
|
-
|
|
104
|
-
```typescript
|
|
105
|
-
public metricFailed(options?: MetricOptions): Metric
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
Measure the number of failed canary runs over a given time period.
|
|
109
|
-
|
|
110
|
-
Default: sum over 5 minutes
|
|
111
|
-
|
|
112
|
-
###### `options`<sup>Optional</sup> <a name="options" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricFailed.parameter.options"></a>
|
|
113
|
-
|
|
114
|
-
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
|
|
115
|
-
|
|
116
|
-
configuration options for the metric.
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
##### `metricSuccessPercent` <a name="metricSuccessPercent" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricSuccessPercent"></a>
|
|
121
|
-
|
|
122
|
-
```typescript
|
|
123
|
-
public metricSuccessPercent(options?: MetricOptions): Metric
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
Measure the percentage of successful canary runs.
|
|
127
|
-
|
|
128
|
-
###### `options`<sup>Optional</sup> <a name="options" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.metricSuccessPercent.parameter.options"></a>
|
|
129
|
-
|
|
130
|
-
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
|
|
131
|
-
|
|
132
|
-
configuration options for the metric.
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
##### `addTestStep` <a name="addTestStep" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.addTestStep"></a>
|
|
137
|
-
|
|
138
|
-
```typescript
|
|
139
|
-
public addTestStep(step: ApiTestStep): void
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
Add a new test step to this canary.
|
|
143
|
-
|
|
144
|
-
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.addTestStep.parameter.step"></a>
|
|
145
|
-
|
|
146
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep">ApiTestStep</a>
|
|
147
|
-
|
|
148
|
-
ApiTestStep to add.
|
|
149
|
-
|
|
150
|
-
---
|
|
151
|
-
|
|
152
|
-
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
153
|
-
|
|
154
|
-
| **Name** | **Description** |
|
|
155
|
-
| --- | --- |
|
|
156
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
157
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
158
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
159
|
-
|
|
160
|
-
---
|
|
161
|
-
|
|
162
|
-
##### ~~`isConstruct`~~ <a name="isConstruct" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.isConstruct"></a>
|
|
163
|
-
|
|
164
|
-
```typescript
|
|
165
|
-
import { ApiCanary } from '@cdklabs/cdk-ecs-codedeploy'
|
|
166
|
-
|
|
167
|
-
ApiCanary.isConstruct(x: any)
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
Checks if `x` is a construct.
|
|
171
|
-
|
|
172
|
-
###### `x`<sup>Required</sup> <a name="x" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.isConstruct.parameter.x"></a>
|
|
173
|
-
|
|
174
|
-
- *Type:* any
|
|
175
|
-
|
|
176
|
-
Any object.
|
|
177
|
-
|
|
178
|
-
---
|
|
179
|
-
|
|
180
|
-
##### `isOwnedResource` <a name="isOwnedResource" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.isOwnedResource"></a>
|
|
181
|
-
|
|
182
|
-
```typescript
|
|
183
|
-
import { ApiCanary } from '@cdklabs/cdk-ecs-codedeploy'
|
|
184
|
-
|
|
185
|
-
ApiCanary.isOwnedResource(construct: IConstruct)
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
Returns true if the construct was created by CDK, and false otherwise.
|
|
189
|
-
|
|
190
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.isOwnedResource.parameter.construct"></a>
|
|
191
|
-
|
|
192
|
-
- *Type:* constructs.IConstruct
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
##### `isResource` <a name="isResource" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.isResource"></a>
|
|
197
|
-
|
|
198
|
-
```typescript
|
|
199
|
-
import { ApiCanary } from '@cdklabs/cdk-ecs-codedeploy'
|
|
200
|
-
|
|
201
|
-
ApiCanary.isResource(construct: IConstruct)
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
Check whether the given construct is a Resource.
|
|
205
|
-
|
|
206
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.isResource.parameter.construct"></a>
|
|
207
|
-
|
|
208
|
-
- *Type:* constructs.IConstruct
|
|
209
|
-
|
|
210
|
-
---
|
|
211
|
-
|
|
212
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
213
|
-
|
|
214
|
-
| **Name** | **Type** | **Description** |
|
|
215
|
-
| --- | --- | --- |
|
|
216
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
217
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
218
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
219
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.artifactsBucket">artifactsBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | Bucket where data from each canary run is stored. |
|
|
220
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.canaryId">canaryId</a></code> | <code>string</code> | The canary ID. |
|
|
221
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.canaryName">canaryName</a></code> | <code>string</code> | The canary Name. |
|
|
222
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.canaryState">canaryState</a></code> | <code>string</code> | The state of the canary. |
|
|
223
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.connections">connections</a></code> | <code>aws-cdk-lib.aws_ec2.Connections</code> | Access the Connections object. |
|
|
224
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | Execution role associated with this Canary. |
|
|
225
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.successAlarm">successAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.Alarm</code> | A CloudWatch Alarm that triggers when the success rate falls below 100% over the past 2 periods. |
|
|
226
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.durationAlarm">durationAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.Alarm</code> | A CloudWatch Alarm that triggers when the duration of the tests exceeds the given threshold over the past 2 periods. |
|
|
227
|
-
|
|
228
|
-
---
|
|
229
|
-
|
|
230
|
-
##### `node`<sup>Required</sup> <a name="node" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.node"></a>
|
|
231
|
-
|
|
232
|
-
```typescript
|
|
233
|
-
public readonly node: Node;
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
- *Type:* constructs.Node
|
|
237
|
-
|
|
238
|
-
The tree node.
|
|
239
|
-
|
|
240
|
-
---
|
|
241
|
-
|
|
242
|
-
##### `env`<sup>Required</sup> <a name="env" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.env"></a>
|
|
243
|
-
|
|
244
|
-
```typescript
|
|
245
|
-
public readonly env: ResourceEnvironment;
|
|
246
|
-
```
|
|
247
|
-
|
|
248
|
-
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
249
|
-
|
|
250
|
-
The environment this resource belongs to.
|
|
251
|
-
|
|
252
|
-
For resources that are created and managed by the CDK
|
|
253
|
-
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
254
|
-
this is always the same as the environment of the stack they belong to;
|
|
255
|
-
however, for imported resources
|
|
256
|
-
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
257
|
-
that might be different than the stack they were imported into.
|
|
258
|
-
|
|
259
|
-
---
|
|
260
|
-
|
|
261
|
-
##### `stack`<sup>Required</sup> <a name="stack" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.stack"></a>
|
|
262
|
-
|
|
263
|
-
```typescript
|
|
264
|
-
public readonly stack: Stack;
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
- *Type:* aws-cdk-lib.Stack
|
|
268
|
-
|
|
269
|
-
The stack in which this resource is defined.
|
|
270
|
-
|
|
271
|
-
---
|
|
272
|
-
|
|
273
|
-
##### `artifactsBucket`<sup>Required</sup> <a name="artifactsBucket" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.artifactsBucket"></a>
|
|
274
|
-
|
|
275
|
-
```typescript
|
|
276
|
-
public readonly artifactsBucket: IBucket;
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
280
|
-
|
|
281
|
-
Bucket where data from each canary run is stored.
|
|
282
|
-
|
|
283
|
-
---
|
|
284
|
-
|
|
285
|
-
##### `canaryId`<sup>Required</sup> <a name="canaryId" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.canaryId"></a>
|
|
286
|
-
|
|
287
|
-
```typescript
|
|
288
|
-
public readonly canaryId: string;
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
- *Type:* string
|
|
292
|
-
|
|
293
|
-
The canary ID.
|
|
294
|
-
|
|
295
|
-
---
|
|
296
|
-
|
|
297
|
-
##### `canaryName`<sup>Required</sup> <a name="canaryName" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.canaryName"></a>
|
|
298
|
-
|
|
299
|
-
```typescript
|
|
300
|
-
public readonly canaryName: string;
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
- *Type:* string
|
|
304
|
-
|
|
305
|
-
The canary Name.
|
|
306
|
-
|
|
307
|
-
---
|
|
308
|
-
|
|
309
|
-
##### `canaryState`<sup>Required</sup> <a name="canaryState" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.canaryState"></a>
|
|
310
|
-
|
|
311
|
-
```typescript
|
|
312
|
-
public readonly canaryState: string;
|
|
313
|
-
```
|
|
314
|
-
|
|
315
|
-
- *Type:* string
|
|
316
|
-
|
|
317
|
-
The state of the canary.
|
|
318
|
-
|
|
319
|
-
For example, 'RUNNING', 'STOPPED', 'NOT STARTED', or 'ERROR'.
|
|
320
|
-
|
|
321
|
-
---
|
|
322
|
-
|
|
323
|
-
##### `connections`<sup>Required</sup> <a name="connections" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.connections"></a>
|
|
324
|
-
|
|
325
|
-
```typescript
|
|
326
|
-
public readonly connections: Connections;
|
|
327
|
-
```
|
|
328
|
-
|
|
329
|
-
- *Type:* aws-cdk-lib.aws_ec2.Connections
|
|
330
|
-
|
|
331
|
-
Access the Connections object.
|
|
332
|
-
|
|
333
|
-
Will fail if not a VPC-enabled Canary
|
|
334
|
-
|
|
335
|
-
---
|
|
336
|
-
|
|
337
|
-
##### `role`<sup>Required</sup> <a name="role" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.role"></a>
|
|
338
|
-
|
|
339
|
-
```typescript
|
|
340
|
-
public readonly role: IRole;
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
344
|
-
|
|
345
|
-
Execution role associated with this Canary.
|
|
346
|
-
|
|
347
|
-
---
|
|
348
|
-
|
|
349
|
-
##### `successAlarm`<sup>Required</sup> <a name="successAlarm" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.successAlarm"></a>
|
|
350
|
-
|
|
351
|
-
```typescript
|
|
352
|
-
public readonly successAlarm: Alarm;
|
|
353
|
-
```
|
|
354
|
-
|
|
355
|
-
- *Type:* aws-cdk-lib.aws_cloudwatch.Alarm
|
|
356
|
-
|
|
357
|
-
A CloudWatch Alarm that triggers when the success rate falls below 100% over the past 2 periods.
|
|
358
|
-
|
|
359
|
-
---
|
|
360
|
-
|
|
361
|
-
##### `durationAlarm`<sup>Optional</sup> <a name="durationAlarm" id="@cdklabs/cdk-ecs-codedeploy.ApiCanary.property.durationAlarm"></a>
|
|
362
|
-
|
|
363
|
-
```typescript
|
|
364
|
-
public readonly durationAlarm: Alarm;
|
|
365
|
-
```
|
|
366
|
-
|
|
367
|
-
- *Type:* aws-cdk-lib.aws_cloudwatch.Alarm
|
|
368
|
-
|
|
369
|
-
A CloudWatch Alarm that triggers when the duration of the tests exceeds the given threshold over the past 2 periods.
|
|
370
|
-
|
|
371
|
-
---
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
### ApplicationLoadBalancedCodeDeployedFargateService <a name="ApplicationLoadBalancedCodeDeployedFargateService" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService"></a>
|
|
375
|
-
|
|
376
|
-
A Fargate service running on an ECS cluster fronted by an application load balancer and deployed by CodeDeploy.
|
|
377
|
-
|
|
378
|
-
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.Initializer"></a>
|
|
379
|
-
|
|
380
|
-
```typescript
|
|
381
|
-
import { ApplicationLoadBalancedCodeDeployedFargateService } from '@cdklabs/cdk-ecs-codedeploy'
|
|
382
|
-
|
|
383
|
-
new ApplicationLoadBalancedCodeDeployedFargateService(scope: Construct, id: string, props: ApplicationLoadBalancedCodeDeployedFargateServiceProps)
|
|
384
|
-
```
|
|
385
|
-
|
|
386
|
-
| **Name** | **Type** | **Description** |
|
|
387
|
-
| --- | --- | --- |
|
|
388
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
389
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
390
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps">ApplicationLoadBalancedCodeDeployedFargateServiceProps</a></code> | *No description.* |
|
|
391
|
-
|
|
392
|
-
---
|
|
393
|
-
|
|
394
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.Initializer.parameter.scope"></a>
|
|
395
|
-
|
|
396
|
-
- *Type:* constructs.Construct
|
|
397
|
-
|
|
398
|
-
---
|
|
399
|
-
|
|
400
|
-
##### `id`<sup>Required</sup> <a name="id" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.Initializer.parameter.id"></a>
|
|
401
|
-
|
|
402
|
-
- *Type:* string
|
|
403
|
-
|
|
404
|
-
---
|
|
405
|
-
|
|
406
|
-
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.Initializer.parameter.props"></a>
|
|
407
|
-
|
|
408
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps">ApplicationLoadBalancedCodeDeployedFargateServiceProps</a>
|
|
409
|
-
|
|
410
|
-
---
|
|
411
|
-
|
|
412
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
413
|
-
|
|
414
|
-
| **Name** | **Description** |
|
|
415
|
-
| --- | --- |
|
|
416
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
417
|
-
|
|
418
|
-
---
|
|
419
|
-
|
|
420
|
-
##### `toString` <a name="toString" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.toString"></a>
|
|
421
|
-
|
|
422
|
-
```typescript
|
|
423
|
-
public toString(): string
|
|
424
|
-
```
|
|
425
|
-
|
|
426
|
-
Returns a string representation of this construct.
|
|
427
|
-
|
|
428
|
-
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
429
|
-
|
|
430
|
-
| **Name** | **Description** |
|
|
431
|
-
| --- | --- |
|
|
432
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
433
|
-
|
|
434
|
-
---
|
|
435
|
-
|
|
436
|
-
##### ~~`isConstruct`~~ <a name="isConstruct" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.isConstruct"></a>
|
|
437
|
-
|
|
438
|
-
```typescript
|
|
439
|
-
import { ApplicationLoadBalancedCodeDeployedFargateService } from '@cdklabs/cdk-ecs-codedeploy'
|
|
440
|
-
|
|
441
|
-
ApplicationLoadBalancedCodeDeployedFargateService.isConstruct(x: any)
|
|
442
|
-
```
|
|
443
|
-
|
|
444
|
-
Checks if `x` is a construct.
|
|
445
|
-
|
|
446
|
-
###### `x`<sup>Required</sup> <a name="x" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.isConstruct.parameter.x"></a>
|
|
447
|
-
|
|
448
|
-
- *Type:* any
|
|
449
|
-
|
|
450
|
-
Any object.
|
|
451
|
-
|
|
452
|
-
---
|
|
453
|
-
|
|
454
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
455
|
-
|
|
456
|
-
| **Name** | **Type** | **Description** |
|
|
457
|
-
| --- | --- | --- |
|
|
458
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
459
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.ICluster</code> | The cluster that hosts the service. |
|
|
460
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.listener">listener</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener</code> | The listener for the service. |
|
|
461
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.loadBalancer">loadBalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer</code> | The Application Load Balancer for the service. |
|
|
462
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.targetGroup">targetGroup</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup</code> | The target group for the service. |
|
|
463
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.certificate">certificate</a></code> | <code>aws-cdk-lib.aws_certificatemanager.ICertificate</code> | Certificate Manager certificate to associate with the load balancer. |
|
|
464
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.internalDesiredCount">internalDesiredCount</a></code> | <code>number</code> | The desired number of instantiations of the task definition to keep running on the service. |
|
|
465
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.redirectListener">redirectListener</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener</code> | The redirect listener for the service if redirectHTTP is enabled. |
|
|
466
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Determines whether the service will be assigned a public IP address. |
|
|
467
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.service">service</a></code> | <code>aws-cdk-lib.aws_ecs.FargateService</code> | The Fargate service in this construct. |
|
|
468
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.taskDefinition">taskDefinition</a></code> | <code>aws-cdk-lib.aws_ecs.FargateTaskDefinition</code> | The Fargate task definition in this construct. |
|
|
469
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.accessLogBucket">accessLogBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | S3 Bucket used for access logs. |
|
|
470
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.application">application</a></code> | <code>aws-cdk-lib.aws_codedeploy.EcsApplication</code> | CodeDeploy application for this service. |
|
|
471
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.deployment">deployment</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeployment">EcsDeployment</a></code> | CodeDeploy deployment for this service. |
|
|
472
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.deploymentGroup">deploymentGroup</a></code> | <code>aws-cdk-lib.aws_codedeploy.EcsDeploymentGroup</code> | CodeDeploy deployment group for this service. |
|
|
473
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.greenTargetGroup">greenTargetGroup</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup</code> | Test target group to use for CodeDeploy deployments. |
|
|
474
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.healthAlarm">healthAlarm</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm</code> | Composite alarm for monitoring health of service. |
|
|
475
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.testListener">testListener</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener</code> | Test listener to use for CodeDeploy deployments. |
|
|
476
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.apiCanary">apiCanary</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary">ApiCanary</a></code> | API Canary for the service. |
|
|
477
|
-
|
|
478
|
-
---
|
|
479
|
-
|
|
480
|
-
##### `node`<sup>Required</sup> <a name="node" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.node"></a>
|
|
481
|
-
|
|
482
|
-
```typescript
|
|
483
|
-
public readonly node: Node;
|
|
484
|
-
```
|
|
485
|
-
|
|
486
|
-
- *Type:* constructs.Node
|
|
487
|
-
|
|
488
|
-
The tree node.
|
|
489
|
-
|
|
490
|
-
---
|
|
491
|
-
|
|
492
|
-
##### `cluster`<sup>Required</sup> <a name="cluster" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.cluster"></a>
|
|
493
|
-
|
|
494
|
-
```typescript
|
|
495
|
-
public readonly cluster: ICluster;
|
|
496
|
-
```
|
|
497
|
-
|
|
498
|
-
- *Type:* aws-cdk-lib.aws_ecs.ICluster
|
|
499
|
-
|
|
500
|
-
The cluster that hosts the service.
|
|
501
|
-
|
|
502
|
-
---
|
|
503
|
-
|
|
504
|
-
##### `listener`<sup>Required</sup> <a name="listener" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.listener"></a>
|
|
505
|
-
|
|
506
|
-
```typescript
|
|
507
|
-
public readonly listener: ApplicationListener;
|
|
508
|
-
```
|
|
509
|
-
|
|
510
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener
|
|
511
|
-
|
|
512
|
-
The listener for the service.
|
|
513
|
-
|
|
514
|
-
---
|
|
515
|
-
|
|
516
|
-
##### `loadBalancer`<sup>Required</sup> <a name="loadBalancer" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.loadBalancer"></a>
|
|
517
|
-
|
|
518
|
-
```typescript
|
|
519
|
-
public readonly loadBalancer: ApplicationLoadBalancer;
|
|
520
|
-
```
|
|
521
|
-
|
|
522
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer
|
|
523
|
-
|
|
524
|
-
The Application Load Balancer for the service.
|
|
525
|
-
|
|
526
|
-
---
|
|
527
|
-
|
|
528
|
-
##### `targetGroup`<sup>Required</sup> <a name="targetGroup" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.targetGroup"></a>
|
|
529
|
-
|
|
530
|
-
```typescript
|
|
531
|
-
public readonly targetGroup: ApplicationTargetGroup;
|
|
532
|
-
```
|
|
533
|
-
|
|
534
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup
|
|
535
|
-
|
|
536
|
-
The target group for the service.
|
|
537
|
-
|
|
538
|
-
---
|
|
539
|
-
|
|
540
|
-
##### `certificate`<sup>Optional</sup> <a name="certificate" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.certificate"></a>
|
|
541
|
-
|
|
542
|
-
```typescript
|
|
543
|
-
public readonly certificate: ICertificate;
|
|
544
|
-
```
|
|
545
|
-
|
|
546
|
-
- *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate
|
|
547
|
-
|
|
548
|
-
Certificate Manager certificate to associate with the load balancer.
|
|
549
|
-
|
|
550
|
-
---
|
|
551
|
-
|
|
552
|
-
##### `internalDesiredCount`<sup>Optional</sup> <a name="internalDesiredCount" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.internalDesiredCount"></a>
|
|
553
|
-
|
|
554
|
-
```typescript
|
|
555
|
-
public readonly internalDesiredCount: number;
|
|
556
|
-
```
|
|
557
|
-
|
|
558
|
-
- *Type:* number
|
|
559
|
-
|
|
560
|
-
The desired number of instantiations of the task definition to keep running on the service.
|
|
561
|
-
|
|
562
|
-
The default is 1 for all new services and uses the existing services desired count
|
|
563
|
-
when updating an existing service if one is not provided.
|
|
564
|
-
|
|
565
|
-
---
|
|
566
|
-
|
|
567
|
-
##### `redirectListener`<sup>Optional</sup> <a name="redirectListener" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.redirectListener"></a>
|
|
568
|
-
|
|
569
|
-
```typescript
|
|
570
|
-
public readonly redirectListener: ApplicationListener;
|
|
571
|
-
```
|
|
572
|
-
|
|
573
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener
|
|
574
|
-
|
|
575
|
-
The redirect listener for the service if redirectHTTP is enabled.
|
|
576
|
-
|
|
577
|
-
---
|
|
578
|
-
|
|
579
|
-
##### `assignPublicIp`<sup>Required</sup> <a name="assignPublicIp" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.assignPublicIp"></a>
|
|
580
|
-
|
|
581
|
-
```typescript
|
|
582
|
-
public readonly assignPublicIp: boolean;
|
|
583
|
-
```
|
|
584
|
-
|
|
585
|
-
- *Type:* boolean
|
|
586
|
-
|
|
587
|
-
Determines whether the service will be assigned a public IP address.
|
|
588
|
-
|
|
589
|
-
---
|
|
590
|
-
|
|
591
|
-
##### `service`<sup>Required</sup> <a name="service" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.service"></a>
|
|
592
|
-
|
|
593
|
-
```typescript
|
|
594
|
-
public readonly service: FargateService;
|
|
595
|
-
```
|
|
596
|
-
|
|
597
|
-
- *Type:* aws-cdk-lib.aws_ecs.FargateService
|
|
598
|
-
|
|
599
|
-
The Fargate service in this construct.
|
|
600
|
-
|
|
601
|
-
---
|
|
602
|
-
|
|
603
|
-
##### `taskDefinition`<sup>Required</sup> <a name="taskDefinition" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.taskDefinition"></a>
|
|
604
|
-
|
|
605
|
-
```typescript
|
|
606
|
-
public readonly taskDefinition: FargateTaskDefinition;
|
|
607
|
-
```
|
|
608
|
-
|
|
609
|
-
- *Type:* aws-cdk-lib.aws_ecs.FargateTaskDefinition
|
|
610
|
-
|
|
611
|
-
The Fargate task definition in this construct.
|
|
612
|
-
|
|
613
|
-
---
|
|
614
|
-
|
|
615
|
-
##### `accessLogBucket`<sup>Required</sup> <a name="accessLogBucket" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.accessLogBucket"></a>
|
|
616
|
-
|
|
617
|
-
```typescript
|
|
618
|
-
public readonly accessLogBucket: IBucket;
|
|
619
|
-
```
|
|
620
|
-
|
|
621
|
-
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
622
|
-
|
|
623
|
-
S3 Bucket used for access logs.
|
|
624
|
-
|
|
625
|
-
---
|
|
626
|
-
|
|
627
|
-
##### `application`<sup>Required</sup> <a name="application" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.application"></a>
|
|
628
|
-
|
|
629
|
-
```typescript
|
|
630
|
-
public readonly application: EcsApplication;
|
|
631
|
-
```
|
|
632
|
-
|
|
633
|
-
- *Type:* aws-cdk-lib.aws_codedeploy.EcsApplication
|
|
634
|
-
|
|
635
|
-
CodeDeploy application for this service.
|
|
636
|
-
|
|
637
|
-
---
|
|
638
|
-
|
|
639
|
-
##### `deployment`<sup>Required</sup> <a name="deployment" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.deployment"></a>
|
|
640
|
-
|
|
641
|
-
```typescript
|
|
642
|
-
public readonly deployment: EcsDeployment;
|
|
643
|
-
```
|
|
644
|
-
|
|
645
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeployment">EcsDeployment</a>
|
|
646
|
-
|
|
647
|
-
CodeDeploy deployment for this service.
|
|
648
|
-
|
|
649
|
-
---
|
|
650
|
-
|
|
651
|
-
##### `deploymentGroup`<sup>Required</sup> <a name="deploymentGroup" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.deploymentGroup"></a>
|
|
652
|
-
|
|
653
|
-
```typescript
|
|
654
|
-
public readonly deploymentGroup: EcsDeploymentGroup;
|
|
655
|
-
```
|
|
656
|
-
|
|
657
|
-
- *Type:* aws-cdk-lib.aws_codedeploy.EcsDeploymentGroup
|
|
658
|
-
|
|
659
|
-
CodeDeploy deployment group for this service.
|
|
660
|
-
|
|
661
|
-
---
|
|
662
|
-
|
|
663
|
-
##### `greenTargetGroup`<sup>Required</sup> <a name="greenTargetGroup" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.greenTargetGroup"></a>
|
|
664
|
-
|
|
665
|
-
```typescript
|
|
666
|
-
public readonly greenTargetGroup: ApplicationTargetGroup;
|
|
667
|
-
```
|
|
668
|
-
|
|
669
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup
|
|
670
|
-
|
|
671
|
-
Test target group to use for CodeDeploy deployments.
|
|
672
|
-
|
|
673
|
-
---
|
|
674
|
-
|
|
675
|
-
##### `healthAlarm`<sup>Required</sup> <a name="healthAlarm" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.healthAlarm"></a>
|
|
676
|
-
|
|
677
|
-
```typescript
|
|
678
|
-
public readonly healthAlarm: IAlarm;
|
|
679
|
-
```
|
|
680
|
-
|
|
681
|
-
- *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm
|
|
682
|
-
|
|
683
|
-
Composite alarm for monitoring health of service.
|
|
684
|
-
|
|
685
|
-
---
|
|
686
|
-
|
|
687
|
-
##### `testListener`<sup>Required</sup> <a name="testListener" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.testListener"></a>
|
|
688
|
-
|
|
689
|
-
```typescript
|
|
690
|
-
public readonly testListener: ApplicationListener;
|
|
691
|
-
```
|
|
692
|
-
|
|
693
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener
|
|
694
|
-
|
|
695
|
-
Test listener to use for CodeDeploy deployments.
|
|
696
|
-
|
|
697
|
-
---
|
|
698
|
-
|
|
699
|
-
##### `apiCanary`<sup>Optional</sup> <a name="apiCanary" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.property.apiCanary"></a>
|
|
700
|
-
|
|
701
|
-
```typescript
|
|
702
|
-
public readonly apiCanary: ApiCanary;
|
|
703
|
-
```
|
|
704
|
-
|
|
705
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanary">ApiCanary</a>
|
|
706
|
-
|
|
707
|
-
API Canary for the service.
|
|
708
|
-
|
|
709
|
-
---
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
### EcsDeployment <a name="EcsDeployment" id="@cdklabs/cdk-ecs-codedeploy.EcsDeployment"></a>
|
|
713
|
-
|
|
714
|
-
A CodeDeploy Deployment for a Amazon ECS service DeploymentGroup.
|
|
715
|
-
|
|
716
|
-
An EcsDeploymentGroup
|
|
717
|
-
must only have 1 EcsDeployment. This limit is enforced by removing the scope and id
|
|
718
|
-
from the constructor. The scope will always be set to the EcsDeploymentGroup
|
|
719
|
-
and the id will always be set to the string 'Deployment' to force an error if mulitiple
|
|
720
|
-
EcsDeployment constructs are created for a single EcsDeploymentGroup.
|
|
721
|
-
|
|
722
|
-
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ecs-codedeploy.EcsDeployment.Initializer"></a>
|
|
723
|
-
|
|
724
|
-
```typescript
|
|
725
|
-
import { EcsDeployment } from '@cdklabs/cdk-ecs-codedeploy'
|
|
726
|
-
|
|
727
|
-
new EcsDeployment(props: EcsDeploymentProps)
|
|
728
|
-
```
|
|
729
|
-
|
|
730
|
-
| **Name** | **Type** | **Description** |
|
|
731
|
-
| --- | --- | --- |
|
|
732
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeployment.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps">EcsDeploymentProps</a></code> | *No description.* |
|
|
733
|
-
|
|
734
|
-
---
|
|
735
|
-
|
|
736
|
-
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ecs-codedeploy.EcsDeployment.Initializer.parameter.props"></a>
|
|
737
|
-
|
|
738
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps">EcsDeploymentProps</a>
|
|
739
|
-
|
|
740
|
-
---
|
|
741
|
-
|
|
742
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
743
|
-
|
|
744
|
-
| **Name** | **Description** |
|
|
745
|
-
| --- | --- |
|
|
746
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeployment.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
747
|
-
|
|
748
|
-
---
|
|
749
|
-
|
|
750
|
-
##### `toString` <a name="toString" id="@cdklabs/cdk-ecs-codedeploy.EcsDeployment.toString"></a>
|
|
751
|
-
|
|
752
|
-
```typescript
|
|
753
|
-
public toString(): string
|
|
754
|
-
```
|
|
755
|
-
|
|
756
|
-
Returns a string representation of this construct.
|
|
757
|
-
|
|
758
|
-
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
759
|
-
|
|
760
|
-
| **Name** | **Description** |
|
|
761
|
-
| --- | --- |
|
|
762
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeployment.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
763
|
-
|
|
764
|
-
---
|
|
765
|
-
|
|
766
|
-
##### ~~`isConstruct`~~ <a name="isConstruct" id="@cdklabs/cdk-ecs-codedeploy.EcsDeployment.isConstruct"></a>
|
|
767
|
-
|
|
768
|
-
```typescript
|
|
769
|
-
import { EcsDeployment } from '@cdklabs/cdk-ecs-codedeploy'
|
|
770
|
-
|
|
771
|
-
EcsDeployment.isConstruct(x: any)
|
|
772
|
-
```
|
|
773
|
-
|
|
774
|
-
Checks if `x` is a construct.
|
|
775
|
-
|
|
776
|
-
###### `x`<sup>Required</sup> <a name="x" id="@cdklabs/cdk-ecs-codedeploy.EcsDeployment.isConstruct.parameter.x"></a>
|
|
777
|
-
|
|
778
|
-
- *Type:* any
|
|
779
|
-
|
|
780
|
-
Any object.
|
|
781
|
-
|
|
782
|
-
---
|
|
783
|
-
|
|
784
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
785
|
-
|
|
786
|
-
| **Name** | **Type** | **Description** |
|
|
787
|
-
| --- | --- | --- |
|
|
788
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeployment.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
789
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeployment.property.deploymentId">deploymentId</a></code> | <code>string</code> | The id of the deployment that was created. |
|
|
790
|
-
|
|
791
|
-
---
|
|
792
|
-
|
|
793
|
-
##### `node`<sup>Required</sup> <a name="node" id="@cdklabs/cdk-ecs-codedeploy.EcsDeployment.property.node"></a>
|
|
794
|
-
|
|
795
|
-
```typescript
|
|
796
|
-
public readonly node: Node;
|
|
797
|
-
```
|
|
798
|
-
|
|
799
|
-
- *Type:* constructs.Node
|
|
800
|
-
|
|
801
|
-
The tree node.
|
|
802
|
-
|
|
803
|
-
---
|
|
804
|
-
|
|
805
|
-
##### `deploymentId`<sup>Required</sup> <a name="deploymentId" id="@cdklabs/cdk-ecs-codedeploy.EcsDeployment.property.deploymentId"></a>
|
|
806
|
-
|
|
807
|
-
```typescript
|
|
808
|
-
public readonly deploymentId: string;
|
|
809
|
-
```
|
|
810
|
-
|
|
811
|
-
- *Type:* string
|
|
812
|
-
|
|
813
|
-
The id of the deployment that was created.
|
|
814
|
-
|
|
815
|
-
---
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
## Structs <a name="Structs" id="Structs"></a>
|
|
819
|
-
|
|
820
|
-
### ApiCanaryProps <a name="ApiCanaryProps" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps"></a>
|
|
821
|
-
|
|
822
|
-
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.Initializer"></a>
|
|
823
|
-
|
|
824
|
-
```typescript
|
|
825
|
-
import { ApiCanaryProps } from '@cdklabs/cdk-ecs-codedeploy'
|
|
826
|
-
|
|
827
|
-
const apiCanaryProps: ApiCanaryProps = { ... }
|
|
828
|
-
```
|
|
829
|
-
|
|
830
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
831
|
-
|
|
832
|
-
| **Name** | **Type** | **Description** |
|
|
833
|
-
| --- | --- | --- |
|
|
834
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.baseUrl">baseUrl</a></code> | <code>string</code> | The base URL to use for tests. |
|
|
835
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.artifactsBucketLocation">artifactsBucketLocation</a></code> | <code>aws-cdk-lib.aws-synthetics.ArtifactsBucketLocation</code> | The s3 location that stores the data of the canary runs. |
|
|
836
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.canaryName">canaryName</a></code> | <code>string</code> | The name of the canary. |
|
|
837
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.durationAlarmThreshold">durationAlarmThreshold</a></code> | <code>aws-cdk-lib.Duration</code> | The threshold for triggering an alarm on the test duration. |
|
|
838
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.failureRetentionPeriod">failureRetentionPeriod</a></code> | <code>aws-cdk-lib.Duration</code> | How many days should failed runs be retained. |
|
|
839
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | Canary execution role. |
|
|
840
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.schedule">schedule</a></code> | <code>aws-cdk-lib.aws-synthetics.Schedule</code> | Specify the schedule for how often the canary runs. |
|
|
841
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | The list of security groups to associate with the canary's network interfaces. |
|
|
842
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.startAfterCreation">startAfterCreation</a></code> | <code>boolean</code> | Whether or not the canary should start after creation. |
|
|
843
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.steps">steps</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep">ApiTestStep</a>[]</code> | The steps to perform in the synthetic test. |
|
|
844
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.successRetentionPeriod">successRetentionPeriod</a></code> | <code>aws-cdk-lib.Duration</code> | How many days should successful runs be retained. |
|
|
845
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.threadCount">threadCount</a></code> | <code>number</code> | The number of threads to run concurrently for the synthetic test. |
|
|
846
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.timeToLive">timeToLive</a></code> | <code>aws-cdk-lib.Duration</code> | How long the canary will be in a 'RUNNING' state. |
|
|
847
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC where this canary is run. |
|
|
848
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.vpcSubnets">vpcSubnets</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Where to place the network interfaces within the VPC. |
|
|
849
|
-
|
|
850
|
-
---
|
|
851
|
-
|
|
852
|
-
##### `baseUrl`<sup>Required</sup> <a name="baseUrl" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.baseUrl"></a>
|
|
853
|
-
|
|
854
|
-
```typescript
|
|
855
|
-
public readonly baseUrl: string;
|
|
856
|
-
```
|
|
857
|
-
|
|
858
|
-
- *Type:* string
|
|
859
|
-
|
|
860
|
-
The base URL to use for tests.
|
|
861
|
-
|
|
862
|
-
---
|
|
863
|
-
|
|
864
|
-
##### `artifactsBucketLocation`<sup>Optional</sup> <a name="artifactsBucketLocation" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.artifactsBucketLocation"></a>
|
|
865
|
-
|
|
866
|
-
```typescript
|
|
867
|
-
public readonly artifactsBucketLocation: ArtifactsBucketLocation;
|
|
868
|
-
```
|
|
869
|
-
|
|
870
|
-
- *Type:* aws-cdk-lib.aws-synthetics.ArtifactsBucketLocation
|
|
871
|
-
- *Default:* A new s3 bucket will be created without a prefix.
|
|
872
|
-
|
|
873
|
-
The s3 location that stores the data of the canary runs.
|
|
874
|
-
|
|
875
|
-
---
|
|
876
|
-
|
|
877
|
-
##### `canaryName`<sup>Optional</sup> <a name="canaryName" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.canaryName"></a>
|
|
878
|
-
|
|
879
|
-
```typescript
|
|
880
|
-
public readonly canaryName: string;
|
|
881
|
-
```
|
|
882
|
-
|
|
883
|
-
- *Type:* string
|
|
884
|
-
- *Default:* A unique name will be generated from the construct ID
|
|
885
|
-
|
|
886
|
-
The name of the canary.
|
|
887
|
-
|
|
888
|
-
Be sure to give it a descriptive name that distinguishes it from
|
|
889
|
-
other canaries in your account.
|
|
890
|
-
|
|
891
|
-
Do not include secrets or proprietary information in your canary name. The canary name
|
|
892
|
-
makes up part of the canary ARN, which is included in outbound calls over the internet.
|
|
893
|
-
|
|
894
|
-
> [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html)
|
|
895
|
-
|
|
896
|
-
---
|
|
897
|
-
|
|
898
|
-
##### `durationAlarmThreshold`<sup>Optional</sup> <a name="durationAlarmThreshold" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.durationAlarmThreshold"></a>
|
|
899
|
-
|
|
900
|
-
```typescript
|
|
901
|
-
public readonly durationAlarmThreshold: Duration;
|
|
902
|
-
```
|
|
903
|
-
|
|
904
|
-
- *Type:* aws-cdk-lib.Duration
|
|
905
|
-
- *Default:* no alarm is created for duration
|
|
906
|
-
|
|
907
|
-
The threshold for triggering an alarm on the test duration.
|
|
908
|
-
|
|
909
|
-
---
|
|
910
|
-
|
|
911
|
-
##### `failureRetentionPeriod`<sup>Optional</sup> <a name="failureRetentionPeriod" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.failureRetentionPeriod"></a>
|
|
912
|
-
|
|
913
|
-
```typescript
|
|
914
|
-
public readonly failureRetentionPeriod: Duration;
|
|
915
|
-
```
|
|
916
|
-
|
|
917
|
-
- *Type:* aws-cdk-lib.Duration
|
|
918
|
-
- *Default:* Duration.days(31)
|
|
919
|
-
|
|
920
|
-
How many days should failed runs be retained.
|
|
921
|
-
|
|
922
|
-
---
|
|
923
|
-
|
|
924
|
-
##### `role`<sup>Optional</sup> <a name="role" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.role"></a>
|
|
925
|
-
|
|
926
|
-
```typescript
|
|
927
|
-
public readonly role: IRole;
|
|
928
|
-
```
|
|
929
|
-
|
|
930
|
-
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
931
|
-
- *Default:* A unique role will be generated for this canary. You can add permissions to roles by calling 'addToRolePolicy'.
|
|
932
|
-
|
|
933
|
-
Canary execution role.
|
|
934
|
-
|
|
935
|
-
This is the role that will be assumed by the canary upon execution.
|
|
936
|
-
It controls the permissions that the canary will have. The role must
|
|
937
|
-
be assumable by the AWS Lambda service principal.
|
|
938
|
-
|
|
939
|
-
If not supplied, a role will be created with all the required permissions.
|
|
940
|
-
If you provide a Role, you must add the required permissions.
|
|
941
|
-
|
|
942
|
-
> [required permissions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn](required permissions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-synthetics-canary.html#cfn-synthetics-canary-executionrolearn)
|
|
943
|
-
|
|
944
|
-
---
|
|
945
|
-
|
|
946
|
-
##### `schedule`<sup>Optional</sup> <a name="schedule" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.schedule"></a>
|
|
947
|
-
|
|
948
|
-
```typescript
|
|
949
|
-
public readonly schedule: Schedule;
|
|
950
|
-
```
|
|
951
|
-
|
|
952
|
-
- *Type:* aws-cdk-lib.aws-synthetics.Schedule
|
|
953
|
-
- *Default:* 'rate(5 minutes)'
|
|
954
|
-
|
|
955
|
-
Specify the schedule for how often the canary runs.
|
|
956
|
-
|
|
957
|
-
For example, if you set `schedule` to `rate(10 minutes)`, then the canary will run every 10 minutes.
|
|
958
|
-
You can set the schedule with `Schedule.rate(Duration)` (recommended) or you can specify an expression using `Schedule.expression()`.
|
|
959
|
-
|
|
960
|
-
---
|
|
961
|
-
|
|
962
|
-
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.securityGroups"></a>
|
|
963
|
-
|
|
964
|
-
```typescript
|
|
965
|
-
public readonly securityGroups: ISecurityGroup[];
|
|
966
|
-
```
|
|
967
|
-
|
|
968
|
-
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
969
|
-
- *Default:* If the canary is placed within a VPC and a security group is not specified a dedicated security group will be created for this canary.
|
|
970
|
-
|
|
971
|
-
The list of security groups to associate with the canary's network interfaces.
|
|
972
|
-
|
|
973
|
-
You must provide `vpc` when using this prop.
|
|
974
|
-
|
|
975
|
-
---
|
|
976
|
-
|
|
977
|
-
##### `startAfterCreation`<sup>Optional</sup> <a name="startAfterCreation" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.startAfterCreation"></a>
|
|
978
|
-
|
|
979
|
-
```typescript
|
|
980
|
-
public readonly startAfterCreation: boolean;
|
|
981
|
-
```
|
|
982
|
-
|
|
983
|
-
- *Type:* boolean
|
|
984
|
-
- *Default:* true
|
|
985
|
-
|
|
986
|
-
Whether or not the canary should start after creation.
|
|
987
|
-
|
|
988
|
-
---
|
|
989
|
-
|
|
990
|
-
##### `steps`<sup>Optional</sup> <a name="steps" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.steps"></a>
|
|
991
|
-
|
|
992
|
-
```typescript
|
|
993
|
-
public readonly steps: ApiTestStep[];
|
|
994
|
-
```
|
|
995
|
-
|
|
996
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep">ApiTestStep</a>[]
|
|
997
|
-
|
|
998
|
-
The steps to perform in the synthetic test.
|
|
999
|
-
|
|
1000
|
-
---
|
|
1001
|
-
|
|
1002
|
-
##### `successRetentionPeriod`<sup>Optional</sup> <a name="successRetentionPeriod" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.successRetentionPeriod"></a>
|
|
1003
|
-
|
|
1004
|
-
```typescript
|
|
1005
|
-
public readonly successRetentionPeriod: Duration;
|
|
1006
|
-
```
|
|
1007
|
-
|
|
1008
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1009
|
-
- *Default:* Duration.days(31)
|
|
1010
|
-
|
|
1011
|
-
How many days should successful runs be retained.
|
|
1012
|
-
|
|
1013
|
-
---
|
|
1014
|
-
|
|
1015
|
-
##### `threadCount`<sup>Optional</sup> <a name="threadCount" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.threadCount"></a>
|
|
1016
|
-
|
|
1017
|
-
```typescript
|
|
1018
|
-
public readonly threadCount: number;
|
|
1019
|
-
```
|
|
1020
|
-
|
|
1021
|
-
- *Type:* number
|
|
1022
|
-
- *Default:* 20
|
|
1023
|
-
|
|
1024
|
-
The number of threads to run concurrently for the synthetic test.
|
|
1025
|
-
|
|
1026
|
-
---
|
|
1027
|
-
|
|
1028
|
-
##### `timeToLive`<sup>Optional</sup> <a name="timeToLive" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.timeToLive"></a>
|
|
1029
|
-
|
|
1030
|
-
```typescript
|
|
1031
|
-
public readonly timeToLive: Duration;
|
|
1032
|
-
```
|
|
1033
|
-
|
|
1034
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1035
|
-
- *Default:* no limit
|
|
1036
|
-
|
|
1037
|
-
How long the canary will be in a 'RUNNING' state.
|
|
1038
|
-
|
|
1039
|
-
For example, if you set `timeToLive` to be 1 hour and `schedule` to be `rate(10 minutes)`,
|
|
1040
|
-
your canary will run at 10 minute intervals for an hour, for a total of 6 times.
|
|
1041
|
-
|
|
1042
|
-
---
|
|
1043
|
-
|
|
1044
|
-
##### `vpc`<sup>Optional</sup> <a name="vpc" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.vpc"></a>
|
|
1045
|
-
|
|
1046
|
-
```typescript
|
|
1047
|
-
public readonly vpc: IVpc;
|
|
1048
|
-
```
|
|
1049
|
-
|
|
1050
|
-
- *Type:* aws-cdk-lib.aws_ec2.IVpc
|
|
1051
|
-
- *Default:* Not in VPC
|
|
1052
|
-
|
|
1053
|
-
The VPC where this canary is run.
|
|
1054
|
-
|
|
1055
|
-
Specify this if the canary needs to access resources in a VPC.
|
|
1056
|
-
|
|
1057
|
-
---
|
|
1058
|
-
|
|
1059
|
-
##### `vpcSubnets`<sup>Optional</sup> <a name="vpcSubnets" id="@cdklabs/cdk-ecs-codedeploy.ApiCanaryProps.property.vpcSubnets"></a>
|
|
1060
|
-
|
|
1061
|
-
```typescript
|
|
1062
|
-
public readonly vpcSubnets: SubnetSelection;
|
|
1063
|
-
```
|
|
1064
|
-
|
|
1065
|
-
- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection
|
|
1066
|
-
- *Default:* the Vpc default strategy if not specified
|
|
1067
|
-
|
|
1068
|
-
Where to place the network interfaces within the VPC.
|
|
1069
|
-
|
|
1070
|
-
You must provide `vpc` when using this prop.
|
|
1071
|
-
|
|
1072
|
-
---
|
|
1073
|
-
|
|
1074
|
-
### ApiTestStep <a name="ApiTestStep" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep"></a>
|
|
1075
|
-
|
|
1076
|
-
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep.Initializer"></a>
|
|
1077
|
-
|
|
1078
|
-
```typescript
|
|
1079
|
-
import { ApiTestStep } from '@cdklabs/cdk-ecs-codedeploy'
|
|
1080
|
-
|
|
1081
|
-
const apiTestStep: ApiTestStep = { ... }
|
|
1082
|
-
```
|
|
1083
|
-
|
|
1084
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
1085
|
-
|
|
1086
|
-
| **Name** | **Type** | **Description** |
|
|
1087
|
-
| --- | --- | --- |
|
|
1088
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.name">name</a></code> | <code>string</code> | Name of test. |
|
|
1089
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.path">path</a></code> | <code>string</code> | Path of HTTP request, relative to baseUrl. |
|
|
1090
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.body">body</a></code> | <code>string</code> | Optional body to include in HTTP request. |
|
|
1091
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.expectedValue">expectedValue</a></code> | <code>any</code> | Expected value to compare against the jmesPath. |
|
|
1092
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.headers">headers</a></code> | <code>{[ key: string ]: string}</code> | Optional headers to include in HTTP request. |
|
|
1093
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.jmesPath">jmesPath</a></code> | <code>string</code> | JMESPath to apply against the response from the HTTP request and compare against expected value. |
|
|
1094
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.method">method</a></code> | <code>string</code> | Optional method to for HTTP request. |
|
|
1095
|
-
|
|
1096
|
-
---
|
|
1097
|
-
|
|
1098
|
-
##### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.name"></a>
|
|
1099
|
-
|
|
1100
|
-
```typescript
|
|
1101
|
-
public readonly name: string;
|
|
1102
|
-
```
|
|
1103
|
-
|
|
1104
|
-
- *Type:* string
|
|
1105
|
-
|
|
1106
|
-
Name of test.
|
|
1107
|
-
|
|
1108
|
-
---
|
|
1109
|
-
|
|
1110
|
-
##### `path`<sup>Required</sup> <a name="path" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.path"></a>
|
|
1111
|
-
|
|
1112
|
-
```typescript
|
|
1113
|
-
public readonly path: string;
|
|
1114
|
-
```
|
|
1115
|
-
|
|
1116
|
-
- *Type:* string
|
|
1117
|
-
|
|
1118
|
-
Path of HTTP request, relative to baseUrl.
|
|
1119
|
-
|
|
1120
|
-
---
|
|
1121
|
-
|
|
1122
|
-
##### `body`<sup>Optional</sup> <a name="body" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.body"></a>
|
|
1123
|
-
|
|
1124
|
-
```typescript
|
|
1125
|
-
public readonly body: string;
|
|
1126
|
-
```
|
|
1127
|
-
|
|
1128
|
-
- *Type:* string
|
|
1129
|
-
- *Default:* no body included.
|
|
1130
|
-
|
|
1131
|
-
Optional body to include in HTTP request.
|
|
1132
|
-
|
|
1133
|
-
---
|
|
1134
|
-
|
|
1135
|
-
##### `expectedValue`<sup>Optional</sup> <a name="expectedValue" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.expectedValue"></a>
|
|
1136
|
-
|
|
1137
|
-
```typescript
|
|
1138
|
-
public readonly expectedValue: any;
|
|
1139
|
-
```
|
|
1140
|
-
|
|
1141
|
-
- *Type:* any
|
|
1142
|
-
- *Default:* undefined
|
|
1143
|
-
|
|
1144
|
-
Expected value to compare against the jmesPath.
|
|
1145
|
-
|
|
1146
|
-
---
|
|
1147
|
-
|
|
1148
|
-
##### `headers`<sup>Optional</sup> <a name="headers" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.headers"></a>
|
|
1149
|
-
|
|
1150
|
-
```typescript
|
|
1151
|
-
public readonly headers: {[ key: string ]: string};
|
|
1152
|
-
```
|
|
1153
|
-
|
|
1154
|
-
- *Type:* {[ key: string ]: string}
|
|
1155
|
-
- *Default:* no headers included.
|
|
1156
|
-
|
|
1157
|
-
Optional headers to include in HTTP request.
|
|
1158
|
-
|
|
1159
|
-
---
|
|
1160
|
-
|
|
1161
|
-
##### `jmesPath`<sup>Optional</sup> <a name="jmesPath" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.jmesPath"></a>
|
|
1162
|
-
|
|
1163
|
-
```typescript
|
|
1164
|
-
public readonly jmesPath: string;
|
|
1165
|
-
```
|
|
1166
|
-
|
|
1167
|
-
- *Type:* string
|
|
1168
|
-
- *Default:* no JMESPath assertion will be performed.
|
|
1169
|
-
|
|
1170
|
-
JMESPath to apply against the response from the HTTP request and compare against expected value.
|
|
1171
|
-
|
|
1172
|
-
---
|
|
1173
|
-
|
|
1174
|
-
##### `method`<sup>Optional</sup> <a name="method" id="@cdklabs/cdk-ecs-codedeploy.ApiTestStep.property.method"></a>
|
|
1175
|
-
|
|
1176
|
-
```typescript
|
|
1177
|
-
public readonly method: string;
|
|
1178
|
-
```
|
|
1179
|
-
|
|
1180
|
-
- *Type:* string
|
|
1181
|
-
- *Default:* GET
|
|
1182
|
-
|
|
1183
|
-
Optional method to for HTTP request.
|
|
1184
|
-
|
|
1185
|
-
---
|
|
1186
|
-
|
|
1187
|
-
### ApplicationLoadBalancedCodeDeployedFargateServiceProps <a name="ApplicationLoadBalancedCodeDeployedFargateServiceProps" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps"></a>
|
|
1188
|
-
|
|
1189
|
-
The properties for the ApplicationLoadBalancedCodeDeployedFargateService service.
|
|
1190
|
-
|
|
1191
|
-
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.Initializer"></a>
|
|
1192
|
-
|
|
1193
|
-
```typescript
|
|
1194
|
-
import { ApplicationLoadBalancedCodeDeployedFargateServiceProps } from '@cdklabs/cdk-ecs-codedeploy'
|
|
1195
|
-
|
|
1196
|
-
const applicationLoadBalancedCodeDeployedFargateServiceProps: ApplicationLoadBalancedCodeDeployedFargateServiceProps = { ... }
|
|
1197
|
-
```
|
|
1198
|
-
|
|
1199
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
1200
|
-
|
|
1201
|
-
| **Name** | **Type** | **Description** |
|
|
1202
|
-
| --- | --- | --- |
|
|
1203
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.capacityProviderStrategies">capacityProviderStrategies</a></code> | <code>aws-cdk-lib.aws_ecs.CapacityProviderStrategy[]</code> | A list of Capacity Provider strategies used to place a service. |
|
|
1204
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.certificate">certificate</a></code> | <code>aws-cdk-lib.aws_certificatemanager.ICertificate</code> | Certificate Manager certificate to associate with the load balancer. |
|
|
1205
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.circuitBreaker">circuitBreaker</a></code> | <code>aws-cdk-lib.aws_ecs.DeploymentCircuitBreaker</code> | Whether to enable the deployment circuit breaker. |
|
|
1206
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.cloudMapOptions">cloudMapOptions</a></code> | <code>aws-cdk-lib.aws_ecs.CloudMapOptions</code> | The options for configuring an Amazon ECS service to use service discovery. |
|
|
1207
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.ICluster</code> | The name of the cluster that hosts the service. |
|
|
1208
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.deploymentController">deploymentController</a></code> | <code>aws-cdk-lib.aws_ecs.DeploymentController</code> | Specifies which deployment controller to use for the service. |
|
|
1209
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.desiredCount">desiredCount</a></code> | <code>number</code> | The desired number of instantiations of the task definition to keep running on the service. |
|
|
1210
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.domainName">domainName</a></code> | <code>string</code> | The domain name for the service, e.g. "api.example.com.". |
|
|
1211
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.domainZone">domainZone</a></code> | <code>aws-cdk-lib.aws_route53.IHostedZone</code> | The Route53 hosted zone for the domain, e.g. "example.com.". |
|
|
1212
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.enableECSManagedTags">enableECSManagedTags</a></code> | <code>boolean</code> | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
|
|
1213
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.enableExecuteCommand">enableExecuteCommand</a></code> | <code>boolean</code> | Whether ECS Exec should be enabled. |
|
|
1214
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.healthCheckGracePeriod">healthCheckGracePeriod</a></code> | <code>aws-cdk-lib.Duration</code> | The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. |
|
|
1215
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.idleTimeout">idleTimeout</a></code> | <code>aws-cdk-lib.Duration</code> | The load balancer idle timeout, in seconds. |
|
|
1216
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.listenerPort">listenerPort</a></code> | <code>number</code> | Listener port of the application load balancer that will serve traffic to the service. |
|
|
1217
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.loadBalancer">loadBalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer</code> | The application load balancer that will serve traffic to the service. |
|
|
1218
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.loadBalancerName">loadBalancerName</a></code> | <code>string</code> | Name of the load balancer. |
|
|
1219
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.maxHealthyPercent">maxHealthyPercent</a></code> | <code>number</code> | The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment. |
|
|
1220
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.minHealthyPercent">minHealthyPercent</a></code> | <code>number</code> | The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment. |
|
|
1221
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.openListener">openListener</a></code> | <code>boolean</code> | Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default. |
|
|
1222
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.propagateTags">propagateTags</a></code> | <code>aws-cdk-lib.aws_ecs.PropagatedTagSource</code> | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
|
|
1223
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.protocol">protocol</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol</code> | The protocol for connections from clients to the load balancer. |
|
|
1224
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.protocolVersion">protocolVersion</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion</code> | The protocol version to use. |
|
|
1225
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.publicLoadBalancer">publicLoadBalancer</a></code> | <code>boolean</code> | Determines whether the Load Balancer will be internet-facing. |
|
|
1226
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.recordType">recordType</a></code> | <code>aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedServiceRecordType</code> | Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. |
|
|
1227
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.redirectHTTP">redirectHTTP</a></code> | <code>boolean</code> | Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS. |
|
|
1228
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.serviceName">serviceName</a></code> | <code>string</code> | The name of the service. |
|
|
1229
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.sslPolicy">sslPolicy</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.SslPolicy</code> | The security policy that defines which ciphers and protocols are supported by the ALB Listener. |
|
|
1230
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.targetProtocol">targetProtocol</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol</code> | The protocol for connections from the load balancer to the ECS tasks. |
|
|
1231
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.taskImageOptions">taskImageOptions</a></code> | <code>aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedTaskImageOptions</code> | The properties required to create a new task definition. |
|
|
1232
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. |
|
|
1233
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.cpu">cpu</a></code> | <code>number</code> | The number of cpu units used by the task. |
|
|
1234
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.memoryLimitMiB">memoryLimitMiB</a></code> | <code>number</code> | The amount (in MiB) of memory used by the task. |
|
|
1235
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.platformVersion">platformVersion</a></code> | <code>aws-cdk-lib.aws_ecs.FargatePlatformVersion</code> | The platform version on which to run your service. |
|
|
1236
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.runtimePlatform">runtimePlatform</a></code> | <code>aws-cdk-lib.aws_ecs.RuntimePlatform</code> | The runtime platform of the task definition. |
|
|
1237
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.taskDefinition">taskDefinition</a></code> | <code>aws-cdk-lib.aws_ecs.FargateTaskDefinition</code> | The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. |
|
|
1238
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Determines whether the service will be assigned a public IP address. |
|
|
1239
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | The security groups to associate with the service. |
|
|
1240
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.taskSubnets">taskSubnets</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | The subnets to associate with the service. |
|
|
1241
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.accessLogBucket">accessLogBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | The bucket to use for access logs from the Application Load Balancer. |
|
|
1242
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.accessLogPrefix">accessLogPrefix</a></code> | <code>string</code> | The prefix to use for access logs from the Application Load Balancer. |
|
|
1243
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.apiCanarySchedule">apiCanarySchedule</a></code> | <code>aws-cdk-lib.Duration</code> | The frequency for running the api canaries. |
|
|
1244
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.apiCanaryThreadCount">apiCanaryThreadCount</a></code> | <code>number</code> | The number of threads to run concurrently for the synthetic test. |
|
|
1245
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.apiCanaryTimeout">apiCanaryTimeout</a></code> | <code>aws-cdk-lib.Duration</code> | The threshold for how long a api canary can take to run. |
|
|
1246
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.apiTestSteps">apiTestSteps</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep">ApiTestStep</a>[]</code> | The steps to run in the canary. |
|
|
1247
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.deploymentConfig">deploymentConfig</a></code> | <code>aws-cdk-lib.aws_codedeploy.IEcsDeploymentConfig</code> | The deployment configuration to use for the deployment group. |
|
|
1248
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.deploymentTimeout">deploymentTimeout</a></code> | <code>aws-cdk-lib.Duration</code> | The timeout for a CodeDeploy deployment. |
|
|
1249
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.deregistrationDelay">deregistrationDelay</a></code> | <code>aws-cdk-lib.Duration</code> | The amount of time for ELB to wait before changing the state of a deregistering target from 'draining' to 'unused'. |
|
|
1250
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.healthCheck">healthCheck</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.HealthCheck</code> | The healthcheck to configure on the Application Load Balancer target groups. |
|
|
1251
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.responseTimeAlarmThreshold">responseTimeAlarmThreshold</a></code> | <code>aws-cdk-lib.Duration</code> | The threshold for response time alarm. |
|
|
1252
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.terminationWaitTime">terminationWaitTime</a></code> | <code>aws-cdk-lib.Duration</code> | The time to wait before terminating the original (blue) task set. |
|
|
1253
|
-
|
|
1254
|
-
---
|
|
1255
|
-
|
|
1256
|
-
##### `capacityProviderStrategies`<sup>Optional</sup> <a name="capacityProviderStrategies" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.capacityProviderStrategies"></a>
|
|
1257
|
-
|
|
1258
|
-
```typescript
|
|
1259
|
-
public readonly capacityProviderStrategies: CapacityProviderStrategy[];
|
|
1260
|
-
```
|
|
1261
|
-
|
|
1262
|
-
- *Type:* aws-cdk-lib.aws_ecs.CapacityProviderStrategy[]
|
|
1263
|
-
- *Default:* undefined
|
|
1264
|
-
|
|
1265
|
-
A list of Capacity Provider strategies used to place a service.
|
|
1266
|
-
|
|
1267
|
-
---
|
|
1268
|
-
|
|
1269
|
-
##### `certificate`<sup>Optional</sup> <a name="certificate" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.certificate"></a>
|
|
1270
|
-
|
|
1271
|
-
```typescript
|
|
1272
|
-
public readonly certificate: ICertificate;
|
|
1273
|
-
```
|
|
1274
|
-
|
|
1275
|
-
- *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate
|
|
1276
|
-
- *Default:* No certificate associated with the load balancer, if using the HTTP protocol. For HTTPS, a DNS-validated certificate will be created for the load balancer's specified domain name if a domain name and domain zone are specified.
|
|
1277
|
-
|
|
1278
|
-
Certificate Manager certificate to associate with the load balancer.
|
|
1279
|
-
|
|
1280
|
-
Setting this option will set the load balancer protocol to HTTPS.
|
|
1281
|
-
|
|
1282
|
-
---
|
|
1283
|
-
|
|
1284
|
-
##### `circuitBreaker`<sup>Optional</sup> <a name="circuitBreaker" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.circuitBreaker"></a>
|
|
1285
|
-
|
|
1286
|
-
```typescript
|
|
1287
|
-
public readonly circuitBreaker: DeploymentCircuitBreaker;
|
|
1288
|
-
```
|
|
1289
|
-
|
|
1290
|
-
- *Type:* aws-cdk-lib.aws_ecs.DeploymentCircuitBreaker
|
|
1291
|
-
- *Default:* disabled
|
|
1292
|
-
|
|
1293
|
-
Whether to enable the deployment circuit breaker.
|
|
1294
|
-
|
|
1295
|
-
If this property is defined, circuit breaker will be implicitly
|
|
1296
|
-
enabled.
|
|
1297
|
-
|
|
1298
|
-
---
|
|
1299
|
-
|
|
1300
|
-
##### `cloudMapOptions`<sup>Optional</sup> <a name="cloudMapOptions" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.cloudMapOptions"></a>
|
|
1301
|
-
|
|
1302
|
-
```typescript
|
|
1303
|
-
public readonly cloudMapOptions: CloudMapOptions;
|
|
1304
|
-
```
|
|
1305
|
-
|
|
1306
|
-
- *Type:* aws-cdk-lib.aws_ecs.CloudMapOptions
|
|
1307
|
-
- *Default:* AWS Cloud Map service discovery is not enabled.
|
|
1308
|
-
|
|
1309
|
-
The options for configuring an Amazon ECS service to use service discovery.
|
|
1310
|
-
|
|
1311
|
-
---
|
|
1312
|
-
|
|
1313
|
-
##### `cluster`<sup>Optional</sup> <a name="cluster" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.cluster"></a>
|
|
1314
|
-
|
|
1315
|
-
```typescript
|
|
1316
|
-
public readonly cluster: ICluster;
|
|
1317
|
-
```
|
|
1318
|
-
|
|
1319
|
-
- *Type:* aws-cdk-lib.aws_ecs.ICluster
|
|
1320
|
-
- *Default:* create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
|
|
1321
|
-
|
|
1322
|
-
The name of the cluster that hosts the service.
|
|
1323
|
-
|
|
1324
|
-
If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
|
|
1325
|
-
|
|
1326
|
-
---
|
|
1327
|
-
|
|
1328
|
-
##### `deploymentController`<sup>Optional</sup> <a name="deploymentController" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.deploymentController"></a>
|
|
1329
|
-
|
|
1330
|
-
```typescript
|
|
1331
|
-
public readonly deploymentController: DeploymentController;
|
|
1332
|
-
```
|
|
1333
|
-
|
|
1334
|
-
- *Type:* aws-cdk-lib.aws_ecs.DeploymentController
|
|
1335
|
-
- *Default:* Rolling update (ECS)
|
|
1336
|
-
|
|
1337
|
-
Specifies which deployment controller to use for the service.
|
|
1338
|
-
|
|
1339
|
-
For more information, see
|
|
1340
|
-
[Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)
|
|
1341
|
-
|
|
1342
|
-
---
|
|
1343
|
-
|
|
1344
|
-
##### `desiredCount`<sup>Optional</sup> <a name="desiredCount" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.desiredCount"></a>
|
|
1345
|
-
|
|
1346
|
-
```typescript
|
|
1347
|
-
public readonly desiredCount: number;
|
|
1348
|
-
```
|
|
1349
|
-
|
|
1350
|
-
- *Type:* number
|
|
1351
|
-
- *Default:* If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the default is 1 for all new services and uses the existing services desired count when updating an existing service.
|
|
1352
|
-
|
|
1353
|
-
The desired number of instantiations of the task definition to keep running on the service.
|
|
1354
|
-
|
|
1355
|
-
The minimum value is 1
|
|
1356
|
-
|
|
1357
|
-
---
|
|
1358
|
-
|
|
1359
|
-
##### `domainName`<sup>Optional</sup> <a name="domainName" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.domainName"></a>
|
|
1360
|
-
|
|
1361
|
-
```typescript
|
|
1362
|
-
public readonly domainName: string;
|
|
1363
|
-
```
|
|
1364
|
-
|
|
1365
|
-
- *Type:* string
|
|
1366
|
-
- *Default:* No domain name.
|
|
1367
|
-
|
|
1368
|
-
The domain name for the service, e.g. "api.example.com.".
|
|
1369
|
-
|
|
1370
|
-
---
|
|
1371
|
-
|
|
1372
|
-
##### `domainZone`<sup>Optional</sup> <a name="domainZone" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.domainZone"></a>
|
|
1373
|
-
|
|
1374
|
-
```typescript
|
|
1375
|
-
public readonly domainZone: IHostedZone;
|
|
1376
|
-
```
|
|
1377
|
-
|
|
1378
|
-
- *Type:* aws-cdk-lib.aws_route53.IHostedZone
|
|
1379
|
-
- *Default:* No Route53 hosted domain zone.
|
|
1380
|
-
|
|
1381
|
-
The Route53 hosted zone for the domain, e.g. "example.com.".
|
|
1382
|
-
|
|
1383
|
-
---
|
|
1384
|
-
|
|
1385
|
-
##### `enableECSManagedTags`<sup>Optional</sup> <a name="enableECSManagedTags" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.enableECSManagedTags"></a>
|
|
1386
|
-
|
|
1387
|
-
```typescript
|
|
1388
|
-
public readonly enableECSManagedTags: boolean;
|
|
1389
|
-
```
|
|
1390
|
-
|
|
1391
|
-
- *Type:* boolean
|
|
1392
|
-
- *Default:* false
|
|
1393
|
-
|
|
1394
|
-
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
|
|
1395
|
-
|
|
1396
|
-
For more information, see
|
|
1397
|
-
[Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
|
|
1398
|
-
|
|
1399
|
-
---
|
|
1400
|
-
|
|
1401
|
-
##### `enableExecuteCommand`<sup>Optional</sup> <a name="enableExecuteCommand" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.enableExecuteCommand"></a>
|
|
1402
|
-
|
|
1403
|
-
```typescript
|
|
1404
|
-
public readonly enableExecuteCommand: boolean;
|
|
1405
|
-
```
|
|
1406
|
-
|
|
1407
|
-
- *Type:* boolean
|
|
1408
|
-
- *Default:* false
|
|
1409
|
-
|
|
1410
|
-
Whether ECS Exec should be enabled.
|
|
1411
|
-
|
|
1412
|
-
---
|
|
1413
|
-
|
|
1414
|
-
##### `healthCheckGracePeriod`<sup>Optional</sup> <a name="healthCheckGracePeriod" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.healthCheckGracePeriod"></a>
|
|
1415
|
-
|
|
1416
|
-
```typescript
|
|
1417
|
-
public readonly healthCheckGracePeriod: Duration;
|
|
1418
|
-
```
|
|
1419
|
-
|
|
1420
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1421
|
-
- *Default:* defaults to 60 seconds if at least one load balancer is in-use and it is not already set
|
|
1422
|
-
|
|
1423
|
-
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
|
|
1424
|
-
|
|
1425
|
-
---
|
|
1426
|
-
|
|
1427
|
-
##### `idleTimeout`<sup>Optional</sup> <a name="idleTimeout" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.idleTimeout"></a>
|
|
1428
|
-
|
|
1429
|
-
```typescript
|
|
1430
|
-
public readonly idleTimeout: Duration;
|
|
1431
|
-
```
|
|
1432
|
-
|
|
1433
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1434
|
-
- *Default:* CloudFormation sets idle timeout to 60 seconds
|
|
1435
|
-
|
|
1436
|
-
The load balancer idle timeout, in seconds.
|
|
1437
|
-
|
|
1438
|
-
Can be between 1 and 4000 seconds
|
|
1439
|
-
|
|
1440
|
-
---
|
|
1441
|
-
|
|
1442
|
-
##### `listenerPort`<sup>Optional</sup> <a name="listenerPort" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.listenerPort"></a>
|
|
1443
|
-
|
|
1444
|
-
```typescript
|
|
1445
|
-
public readonly listenerPort: number;
|
|
1446
|
-
```
|
|
1447
|
-
|
|
1448
|
-
- *Type:* number
|
|
1449
|
-
- *Default:* The default listener port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS.
|
|
1450
|
-
|
|
1451
|
-
Listener port of the application load balancer that will serve traffic to the service.
|
|
1452
|
-
|
|
1453
|
-
---
|
|
1454
|
-
|
|
1455
|
-
##### `loadBalancer`<sup>Optional</sup> <a name="loadBalancer" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.loadBalancer"></a>
|
|
1456
|
-
|
|
1457
|
-
```typescript
|
|
1458
|
-
public readonly loadBalancer: IApplicationLoadBalancer;
|
|
1459
|
-
```
|
|
1460
|
-
|
|
1461
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer
|
|
1462
|
-
- *Default:* a new load balancer will be created.
|
|
1463
|
-
|
|
1464
|
-
The application load balancer that will serve traffic to the service.
|
|
1465
|
-
|
|
1466
|
-
The VPC attribute of a load balancer must be specified for it to be used
|
|
1467
|
-
to create a new service with this pattern.
|
|
1468
|
-
|
|
1469
|
-
[disable-awslint:ref-via-interface]
|
|
1470
|
-
|
|
1471
|
-
---
|
|
1472
|
-
|
|
1473
|
-
##### `loadBalancerName`<sup>Optional</sup> <a name="loadBalancerName" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.loadBalancerName"></a>
|
|
1474
|
-
|
|
1475
|
-
```typescript
|
|
1476
|
-
public readonly loadBalancerName: string;
|
|
1477
|
-
```
|
|
1478
|
-
|
|
1479
|
-
- *Type:* string
|
|
1480
|
-
- *Default:* Automatically generated name.
|
|
1481
|
-
|
|
1482
|
-
Name of the load balancer.
|
|
1483
|
-
|
|
1484
|
-
---
|
|
1485
|
-
|
|
1486
|
-
##### `maxHealthyPercent`<sup>Optional</sup> <a name="maxHealthyPercent" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.maxHealthyPercent"></a>
|
|
1487
|
-
|
|
1488
|
-
```typescript
|
|
1489
|
-
public readonly maxHealthyPercent: number;
|
|
1490
|
-
```
|
|
1491
|
-
|
|
1492
|
-
- *Type:* number
|
|
1493
|
-
- *Default:* 100 if daemon, otherwise 200
|
|
1494
|
-
|
|
1495
|
-
The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
|
|
1496
|
-
|
|
1497
|
-
---
|
|
1498
|
-
|
|
1499
|
-
##### `minHealthyPercent`<sup>Optional</sup> <a name="minHealthyPercent" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.minHealthyPercent"></a>
|
|
1500
|
-
|
|
1501
|
-
```typescript
|
|
1502
|
-
public readonly minHealthyPercent: number;
|
|
1503
|
-
```
|
|
1504
|
-
|
|
1505
|
-
- *Type:* number
|
|
1506
|
-
- *Default:* 0 if daemon, otherwise 50
|
|
1507
|
-
|
|
1508
|
-
The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
|
|
1509
|
-
|
|
1510
|
-
---
|
|
1511
|
-
|
|
1512
|
-
##### `openListener`<sup>Optional</sup> <a name="openListener" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.openListener"></a>
|
|
1513
|
-
|
|
1514
|
-
```typescript
|
|
1515
|
-
public readonly openListener: boolean;
|
|
1516
|
-
```
|
|
1517
|
-
|
|
1518
|
-
- *Type:* boolean
|
|
1519
|
-
- *Default:* true -- The security group allows ingress from all IP addresses.
|
|
1520
|
-
|
|
1521
|
-
Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
|
|
1522
|
-
|
|
1523
|
-
---
|
|
1524
|
-
|
|
1525
|
-
##### `propagateTags`<sup>Optional</sup> <a name="propagateTags" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.propagateTags"></a>
|
|
1526
|
-
|
|
1527
|
-
```typescript
|
|
1528
|
-
public readonly propagateTags: PropagatedTagSource;
|
|
1529
|
-
```
|
|
1530
|
-
|
|
1531
|
-
- *Type:* aws-cdk-lib.aws_ecs.PropagatedTagSource
|
|
1532
|
-
- *Default:* none
|
|
1533
|
-
|
|
1534
|
-
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
|
|
1535
|
-
|
|
1536
|
-
Tags can only be propagated to the tasks within the service during service creation.
|
|
1537
|
-
|
|
1538
|
-
---
|
|
1539
|
-
|
|
1540
|
-
##### `protocol`<sup>Optional</sup> <a name="protocol" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.protocol"></a>
|
|
1541
|
-
|
|
1542
|
-
```typescript
|
|
1543
|
-
public readonly protocol: ApplicationProtocol;
|
|
1544
|
-
```
|
|
1545
|
-
|
|
1546
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol
|
|
1547
|
-
- *Default:* HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.
|
|
1548
|
-
|
|
1549
|
-
The protocol for connections from clients to the load balancer.
|
|
1550
|
-
|
|
1551
|
-
The load balancer port is determined from the protocol (port 80 for
|
|
1552
|
-
HTTP, port 443 for HTTPS). If HTTPS, either a certificate or domain
|
|
1553
|
-
name and domain zone must also be specified.
|
|
1554
|
-
|
|
1555
|
-
---
|
|
1556
|
-
|
|
1557
|
-
##### `protocolVersion`<sup>Optional</sup> <a name="protocolVersion" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.protocolVersion"></a>
|
|
1558
|
-
|
|
1559
|
-
```typescript
|
|
1560
|
-
public readonly protocolVersion: ApplicationProtocolVersion;
|
|
1561
|
-
```
|
|
1562
|
-
|
|
1563
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion
|
|
1564
|
-
- *Default:* ApplicationProtocolVersion.HTTP1
|
|
1565
|
-
|
|
1566
|
-
The protocol version to use.
|
|
1567
|
-
|
|
1568
|
-
---
|
|
1569
|
-
|
|
1570
|
-
##### `publicLoadBalancer`<sup>Optional</sup> <a name="publicLoadBalancer" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.publicLoadBalancer"></a>
|
|
1571
|
-
|
|
1572
|
-
```typescript
|
|
1573
|
-
public readonly publicLoadBalancer: boolean;
|
|
1574
|
-
```
|
|
1575
|
-
|
|
1576
|
-
- *Type:* boolean
|
|
1577
|
-
- *Default:* true
|
|
1578
|
-
|
|
1579
|
-
Determines whether the Load Balancer will be internet-facing.
|
|
1580
|
-
|
|
1581
|
-
---
|
|
1582
|
-
|
|
1583
|
-
##### `recordType`<sup>Optional</sup> <a name="recordType" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.recordType"></a>
|
|
1584
|
-
|
|
1585
|
-
```typescript
|
|
1586
|
-
public readonly recordType: ApplicationLoadBalancedServiceRecordType;
|
|
1587
|
-
```
|
|
1588
|
-
|
|
1589
|
-
- *Type:* aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedServiceRecordType
|
|
1590
|
-
- *Default:* ApplicationLoadBalancedServiceRecordType.ALIAS
|
|
1591
|
-
|
|
1592
|
-
Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
|
|
1593
|
-
|
|
1594
|
-
This is useful if you need to work with DNS systems that do not support alias records.
|
|
1595
|
-
|
|
1596
|
-
---
|
|
1597
|
-
|
|
1598
|
-
##### `redirectHTTP`<sup>Optional</sup> <a name="redirectHTTP" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.redirectHTTP"></a>
|
|
1599
|
-
|
|
1600
|
-
```typescript
|
|
1601
|
-
public readonly redirectHTTP: boolean;
|
|
1602
|
-
```
|
|
1603
|
-
|
|
1604
|
-
- *Type:* boolean
|
|
1605
|
-
- *Default:* false
|
|
1606
|
-
|
|
1607
|
-
Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.
|
|
1608
|
-
|
|
1609
|
-
---
|
|
1610
|
-
|
|
1611
|
-
##### `serviceName`<sup>Optional</sup> <a name="serviceName" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.serviceName"></a>
|
|
1612
|
-
|
|
1613
|
-
```typescript
|
|
1614
|
-
public readonly serviceName: string;
|
|
1615
|
-
```
|
|
1616
|
-
|
|
1617
|
-
- *Type:* string
|
|
1618
|
-
- *Default:* CloudFormation-generated name.
|
|
1619
|
-
|
|
1620
|
-
The name of the service.
|
|
1621
|
-
|
|
1622
|
-
---
|
|
1623
|
-
|
|
1624
|
-
##### `sslPolicy`<sup>Optional</sup> <a name="sslPolicy" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.sslPolicy"></a>
|
|
1625
|
-
|
|
1626
|
-
```typescript
|
|
1627
|
-
public readonly sslPolicy: SslPolicy;
|
|
1628
|
-
```
|
|
1629
|
-
|
|
1630
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.SslPolicy
|
|
1631
|
-
- *Default:* The recommended elastic load balancing security policy
|
|
1632
|
-
|
|
1633
|
-
The security policy that defines which ciphers and protocols are supported by the ALB Listener.
|
|
1634
|
-
|
|
1635
|
-
---
|
|
1636
|
-
|
|
1637
|
-
##### `targetProtocol`<sup>Optional</sup> <a name="targetProtocol" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.targetProtocol"></a>
|
|
1638
|
-
|
|
1639
|
-
```typescript
|
|
1640
|
-
public readonly targetProtocol: ApplicationProtocol;
|
|
1641
|
-
```
|
|
1642
|
-
|
|
1643
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol
|
|
1644
|
-
- *Default:* HTTP.
|
|
1645
|
-
|
|
1646
|
-
The protocol for connections from the load balancer to the ECS tasks.
|
|
1647
|
-
|
|
1648
|
-
The default target port is determined from the protocol (port 80 for
|
|
1649
|
-
HTTP, port 443 for HTTPS).
|
|
1650
|
-
|
|
1651
|
-
---
|
|
1652
|
-
|
|
1653
|
-
##### `taskImageOptions`<sup>Optional</sup> <a name="taskImageOptions" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.taskImageOptions"></a>
|
|
1654
|
-
|
|
1655
|
-
```typescript
|
|
1656
|
-
public readonly taskImageOptions: ApplicationLoadBalancedTaskImageOptions;
|
|
1657
|
-
```
|
|
1658
|
-
|
|
1659
|
-
- *Type:* aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedTaskImageOptions
|
|
1660
|
-
- *Default:* none
|
|
1661
|
-
|
|
1662
|
-
The properties required to create a new task definition.
|
|
1663
|
-
|
|
1664
|
-
TaskDefinition or TaskImageOptions must be specified, but not both.
|
|
1665
|
-
|
|
1666
|
-
---
|
|
1667
|
-
|
|
1668
|
-
##### `vpc`<sup>Optional</sup> <a name="vpc" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.vpc"></a>
|
|
1669
|
-
|
|
1670
|
-
```typescript
|
|
1671
|
-
public readonly vpc: IVpc;
|
|
1672
|
-
```
|
|
1673
|
-
|
|
1674
|
-
- *Type:* aws-cdk-lib.aws_ec2.IVpc
|
|
1675
|
-
- *Default:* uses the VPC defined in the cluster or creates a new VPC.
|
|
1676
|
-
|
|
1677
|
-
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
|
|
1678
|
-
|
|
1679
|
-
If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.
|
|
1680
|
-
|
|
1681
|
-
---
|
|
1682
|
-
|
|
1683
|
-
##### `cpu`<sup>Optional</sup> <a name="cpu" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.cpu"></a>
|
|
1684
|
-
|
|
1685
|
-
```typescript
|
|
1686
|
-
public readonly cpu: number;
|
|
1687
|
-
```
|
|
1688
|
-
|
|
1689
|
-
- *Type:* number
|
|
1690
|
-
- *Default:* 256
|
|
1691
|
-
|
|
1692
|
-
The number of cpu units used by the task.
|
|
1693
|
-
|
|
1694
|
-
Valid values, which determines your range of valid values for the memory parameter:
|
|
1695
|
-
|
|
1696
|
-
256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
|
|
1697
|
-
|
|
1698
|
-
512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
|
|
1699
|
-
|
|
1700
|
-
1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
|
|
1701
|
-
|
|
1702
|
-
2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
|
|
1703
|
-
|
|
1704
|
-
4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
|
|
1705
|
-
|
|
1706
|
-
8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments
|
|
1707
|
-
|
|
1708
|
-
16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments
|
|
1709
|
-
|
|
1710
|
-
This default is set in the underlying FargateTaskDefinition construct.
|
|
1711
|
-
|
|
1712
|
-
---
|
|
1713
|
-
|
|
1714
|
-
##### `memoryLimitMiB`<sup>Optional</sup> <a name="memoryLimitMiB" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.memoryLimitMiB"></a>
|
|
1715
|
-
|
|
1716
|
-
```typescript
|
|
1717
|
-
public readonly memoryLimitMiB: number;
|
|
1718
|
-
```
|
|
1719
|
-
|
|
1720
|
-
- *Type:* number
|
|
1721
|
-
- *Default:* 512
|
|
1722
|
-
|
|
1723
|
-
The amount (in MiB) of memory used by the task.
|
|
1724
|
-
|
|
1725
|
-
This field is required and you must use one of the following values, which determines your range of valid values
|
|
1726
|
-
for the cpu parameter:
|
|
1727
|
-
|
|
1728
|
-
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
|
|
1729
|
-
|
|
1730
|
-
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
|
|
1731
|
-
|
|
1732
|
-
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
|
|
1733
|
-
|
|
1734
|
-
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
|
|
1735
|
-
|
|
1736
|
-
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
|
|
1737
|
-
|
|
1738
|
-
Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)
|
|
1739
|
-
|
|
1740
|
-
Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
|
|
1741
|
-
|
|
1742
|
-
This default is set in the underlying FargateTaskDefinition construct.
|
|
1743
|
-
|
|
1744
|
-
---
|
|
1745
|
-
|
|
1746
|
-
##### `platformVersion`<sup>Optional</sup> <a name="platformVersion" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.platformVersion"></a>
|
|
1747
|
-
|
|
1748
|
-
```typescript
|
|
1749
|
-
public readonly platformVersion: FargatePlatformVersion;
|
|
1750
|
-
```
|
|
1751
|
-
|
|
1752
|
-
- *Type:* aws-cdk-lib.aws_ecs.FargatePlatformVersion
|
|
1753
|
-
- *Default:* Latest
|
|
1754
|
-
|
|
1755
|
-
The platform version on which to run your service.
|
|
1756
|
-
|
|
1757
|
-
If one is not specified, the LATEST platform version is used by default. For more information, see
|
|
1758
|
-
[AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
|
|
1759
|
-
in the Amazon Elastic Container Service Developer Guide.
|
|
1760
|
-
|
|
1761
|
-
---
|
|
1762
|
-
|
|
1763
|
-
##### `runtimePlatform`<sup>Optional</sup> <a name="runtimePlatform" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.runtimePlatform"></a>
|
|
1764
|
-
|
|
1765
|
-
```typescript
|
|
1766
|
-
public readonly runtimePlatform: RuntimePlatform;
|
|
1767
|
-
```
|
|
1768
|
-
|
|
1769
|
-
- *Type:* aws-cdk-lib.aws_ecs.RuntimePlatform
|
|
1770
|
-
- *Default:* If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
|
|
1771
|
-
|
|
1772
|
-
The runtime platform of the task definition.
|
|
1773
|
-
|
|
1774
|
-
---
|
|
1775
|
-
|
|
1776
|
-
##### `taskDefinition`<sup>Optional</sup> <a name="taskDefinition" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.taskDefinition"></a>
|
|
1777
|
-
|
|
1778
|
-
```typescript
|
|
1779
|
-
public readonly taskDefinition: FargateTaskDefinition;
|
|
1780
|
-
```
|
|
1781
|
-
|
|
1782
|
-
- *Type:* aws-cdk-lib.aws_ecs.FargateTaskDefinition
|
|
1783
|
-
- *Default:* none
|
|
1784
|
-
|
|
1785
|
-
The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
|
|
1786
|
-
|
|
1787
|
-
[disable-awslint:ref-via-interface]
|
|
1788
|
-
|
|
1789
|
-
---
|
|
1790
|
-
|
|
1791
|
-
##### `assignPublicIp`<sup>Optional</sup> <a name="assignPublicIp" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.assignPublicIp"></a>
|
|
1792
|
-
|
|
1793
|
-
```typescript
|
|
1794
|
-
public readonly assignPublicIp: boolean;
|
|
1795
|
-
```
|
|
1796
|
-
|
|
1797
|
-
- *Type:* boolean
|
|
1798
|
-
- *Default:* false
|
|
1799
|
-
|
|
1800
|
-
Determines whether the service will be assigned a public IP address.
|
|
1801
|
-
|
|
1802
|
-
---
|
|
1803
|
-
|
|
1804
|
-
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.securityGroups"></a>
|
|
1805
|
-
|
|
1806
|
-
```typescript
|
|
1807
|
-
public readonly securityGroups: ISecurityGroup[];
|
|
1808
|
-
```
|
|
1809
|
-
|
|
1810
|
-
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
1811
|
-
- *Default:* A new security group is created.
|
|
1812
|
-
|
|
1813
|
-
The security groups to associate with the service.
|
|
1814
|
-
|
|
1815
|
-
If you do not specify a security group, a new security group is created.
|
|
1816
|
-
|
|
1817
|
-
---
|
|
1818
|
-
|
|
1819
|
-
##### `taskSubnets`<sup>Optional</sup> <a name="taskSubnets" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.taskSubnets"></a>
|
|
1820
|
-
|
|
1821
|
-
```typescript
|
|
1822
|
-
public readonly taskSubnets: SubnetSelection;
|
|
1823
|
-
```
|
|
1824
|
-
|
|
1825
|
-
- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection
|
|
1826
|
-
- *Default:* Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.
|
|
1827
|
-
|
|
1828
|
-
The subnets to associate with the service.
|
|
1829
|
-
|
|
1830
|
-
---
|
|
1831
|
-
|
|
1832
|
-
##### `accessLogBucket`<sup>Optional</sup> <a name="accessLogBucket" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.accessLogBucket"></a>
|
|
1833
|
-
|
|
1834
|
-
```typescript
|
|
1835
|
-
public readonly accessLogBucket: IBucket;
|
|
1836
|
-
```
|
|
1837
|
-
|
|
1838
|
-
- *Type:* aws-cdk-lib.aws_s3.IBucket
|
|
1839
|
-
- *Default:* a new S3 bucket will be created
|
|
1840
|
-
|
|
1841
|
-
The bucket to use for access logs from the Application Load Balancer.
|
|
1842
|
-
|
|
1843
|
-
---
|
|
1844
|
-
|
|
1845
|
-
##### `accessLogPrefix`<sup>Optional</sup> <a name="accessLogPrefix" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.accessLogPrefix"></a>
|
|
1846
|
-
|
|
1847
|
-
```typescript
|
|
1848
|
-
public readonly accessLogPrefix: string;
|
|
1849
|
-
```
|
|
1850
|
-
|
|
1851
|
-
- *Type:* string
|
|
1852
|
-
- *Default:* none
|
|
1853
|
-
|
|
1854
|
-
The prefix to use for access logs from the Application Load Balancer.
|
|
1855
|
-
|
|
1856
|
-
---
|
|
1857
|
-
|
|
1858
|
-
##### `apiCanarySchedule`<sup>Optional</sup> <a name="apiCanarySchedule" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.apiCanarySchedule"></a>
|
|
1859
|
-
|
|
1860
|
-
```typescript
|
|
1861
|
-
public readonly apiCanarySchedule: Duration;
|
|
1862
|
-
```
|
|
1863
|
-
|
|
1864
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1865
|
-
- *Default:* 5 minutes
|
|
1866
|
-
|
|
1867
|
-
The frequency for running the api canaries.
|
|
1868
|
-
|
|
1869
|
-
---
|
|
1870
|
-
|
|
1871
|
-
##### `apiCanaryThreadCount`<sup>Optional</sup> <a name="apiCanaryThreadCount" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.apiCanaryThreadCount"></a>
|
|
1872
|
-
|
|
1873
|
-
```typescript
|
|
1874
|
-
public readonly apiCanaryThreadCount: number;
|
|
1875
|
-
```
|
|
1876
|
-
|
|
1877
|
-
- *Type:* number
|
|
1878
|
-
- *Default:* 20
|
|
1879
|
-
|
|
1880
|
-
The number of threads to run concurrently for the synthetic test.
|
|
1881
|
-
|
|
1882
|
-
---
|
|
1883
|
-
|
|
1884
|
-
##### `apiCanaryTimeout`<sup>Optional</sup> <a name="apiCanaryTimeout" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.apiCanaryTimeout"></a>
|
|
1885
|
-
|
|
1886
|
-
```typescript
|
|
1887
|
-
public readonly apiCanaryTimeout: Duration;
|
|
1888
|
-
```
|
|
1889
|
-
|
|
1890
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1891
|
-
- *Default:* no alarm is created for test duration
|
|
1892
|
-
|
|
1893
|
-
The threshold for how long a api canary can take to run.
|
|
1894
|
-
|
|
1895
|
-
---
|
|
1896
|
-
|
|
1897
|
-
##### `apiTestSteps`<sup>Optional</sup> <a name="apiTestSteps" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.apiTestSteps"></a>
|
|
1898
|
-
|
|
1899
|
-
```typescript
|
|
1900
|
-
public readonly apiTestSteps: ApiTestStep[];
|
|
1901
|
-
```
|
|
1902
|
-
|
|
1903
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.ApiTestStep">ApiTestStep</a>[]
|
|
1904
|
-
- *Default:* no synthetic test will be created
|
|
1905
|
-
|
|
1906
|
-
The steps to run in the canary.
|
|
1907
|
-
|
|
1908
|
-
---
|
|
1909
|
-
|
|
1910
|
-
##### `deploymentConfig`<sup>Optional</sup> <a name="deploymentConfig" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.deploymentConfig"></a>
|
|
1911
|
-
|
|
1912
|
-
```typescript
|
|
1913
|
-
public readonly deploymentConfig: IEcsDeploymentConfig;
|
|
1914
|
-
```
|
|
1915
|
-
|
|
1916
|
-
- *Type:* aws-cdk-lib.aws_codedeploy.IEcsDeploymentConfig
|
|
1917
|
-
- *Default:* EcsDeploymentConfig.ALL_AT_ONCE
|
|
1918
|
-
|
|
1919
|
-
The deployment configuration to use for the deployment group.
|
|
1920
|
-
|
|
1921
|
-
---
|
|
1922
|
-
|
|
1923
|
-
##### `deploymentTimeout`<sup>Optional</sup> <a name="deploymentTimeout" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.deploymentTimeout"></a>
|
|
1924
|
-
|
|
1925
|
-
```typescript
|
|
1926
|
-
public readonly deploymentTimeout: Duration;
|
|
1927
|
-
```
|
|
1928
|
-
|
|
1929
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1930
|
-
- *Default:* 60 minutes
|
|
1931
|
-
|
|
1932
|
-
The timeout for a CodeDeploy deployment.
|
|
1933
|
-
|
|
1934
|
-
---
|
|
1935
|
-
|
|
1936
|
-
##### `deregistrationDelay`<sup>Optional</sup> <a name="deregistrationDelay" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.deregistrationDelay"></a>
|
|
1937
|
-
|
|
1938
|
-
```typescript
|
|
1939
|
-
public readonly deregistrationDelay: Duration;
|
|
1940
|
-
```
|
|
1941
|
-
|
|
1942
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1943
|
-
- *Default:* 300 seconds
|
|
1944
|
-
|
|
1945
|
-
The amount of time for ELB to wait before changing the state of a deregistering target from 'draining' to 'unused'.
|
|
1946
|
-
|
|
1947
|
-
---
|
|
1948
|
-
|
|
1949
|
-
##### `healthCheck`<sup>Optional</sup> <a name="healthCheck" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.healthCheck"></a>
|
|
1950
|
-
|
|
1951
|
-
```typescript
|
|
1952
|
-
public readonly healthCheck: HealthCheck;
|
|
1953
|
-
```
|
|
1954
|
-
|
|
1955
|
-
- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.HealthCheck
|
|
1956
|
-
- *Default:* no health check is configured
|
|
1957
|
-
|
|
1958
|
-
The healthcheck to configure on the Application Load Balancer target groups.
|
|
1959
|
-
|
|
1960
|
-
---
|
|
1961
|
-
|
|
1962
|
-
##### `responseTimeAlarmThreshold`<sup>Optional</sup> <a name="responseTimeAlarmThreshold" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.responseTimeAlarmThreshold"></a>
|
|
1963
|
-
|
|
1964
|
-
```typescript
|
|
1965
|
-
public readonly responseTimeAlarmThreshold: Duration;
|
|
1966
|
-
```
|
|
1967
|
-
|
|
1968
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1969
|
-
- *Default:* no alarm will be created
|
|
1970
|
-
|
|
1971
|
-
The threshold for response time alarm.
|
|
1972
|
-
|
|
1973
|
-
---
|
|
1974
|
-
|
|
1975
|
-
##### `terminationWaitTime`<sup>Optional</sup> <a name="terminationWaitTime" id="@cdklabs/cdk-ecs-codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.property.terminationWaitTime"></a>
|
|
1976
|
-
|
|
1977
|
-
```typescript
|
|
1978
|
-
public readonly terminationWaitTime: Duration;
|
|
1979
|
-
```
|
|
1980
|
-
|
|
1981
|
-
- *Type:* aws-cdk-lib.Duration
|
|
1982
|
-
- *Default:* 10 minutes
|
|
1983
|
-
|
|
1984
|
-
The time to wait before terminating the original (blue) task set.
|
|
1985
|
-
|
|
1986
|
-
---
|
|
1987
|
-
|
|
1988
|
-
### AwsvpcConfiguration <a name="AwsvpcConfiguration" id="@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration"></a>
|
|
1989
|
-
|
|
1990
|
-
Network configuration for ECS services that have a network type of `awsvpc`.
|
|
1991
|
-
|
|
1992
|
-
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.Initializer"></a>
|
|
1993
|
-
|
|
1994
|
-
```typescript
|
|
1995
|
-
import { AwsvpcConfiguration } from '@cdklabs/cdk-ecs-codedeploy'
|
|
1996
|
-
|
|
1997
|
-
const awsvpcConfiguration: AwsvpcConfiguration = { ... }
|
|
1998
|
-
```
|
|
1999
|
-
|
|
2000
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
2001
|
-
|
|
2002
|
-
| **Name** | **Type** | **Description** |
|
|
2003
|
-
| --- | --- | --- |
|
|
2004
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Assign a public IP address to the task. |
|
|
2005
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | The Security Groups to use for the task. |
|
|
2006
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC to use for the task. |
|
|
2007
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.property.vpcSubnets">vpcSubnets</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | The Subnets to use for the task. |
|
|
2008
|
-
|
|
2009
|
-
---
|
|
2010
|
-
|
|
2011
|
-
##### `assignPublicIp`<sup>Required</sup> <a name="assignPublicIp" id="@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.property.assignPublicIp"></a>
|
|
2012
|
-
|
|
2013
|
-
```typescript
|
|
2014
|
-
public readonly assignPublicIp: boolean;
|
|
2015
|
-
```
|
|
2016
|
-
|
|
2017
|
-
- *Type:* boolean
|
|
2018
|
-
|
|
2019
|
-
Assign a public IP address to the task.
|
|
2020
|
-
|
|
2021
|
-
---
|
|
2022
|
-
|
|
2023
|
-
##### `securityGroups`<sup>Required</sup> <a name="securityGroups" id="@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.property.securityGroups"></a>
|
|
2024
|
-
|
|
2025
|
-
```typescript
|
|
2026
|
-
public readonly securityGroups: ISecurityGroup[];
|
|
2027
|
-
```
|
|
2028
|
-
|
|
2029
|
-
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
2030
|
-
|
|
2031
|
-
The Security Groups to use for the task.
|
|
2032
|
-
|
|
2033
|
-
---
|
|
2034
|
-
|
|
2035
|
-
##### `vpc`<sup>Required</sup> <a name="vpc" id="@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.property.vpc"></a>
|
|
2036
|
-
|
|
2037
|
-
```typescript
|
|
2038
|
-
public readonly vpc: IVpc;
|
|
2039
|
-
```
|
|
2040
|
-
|
|
2041
|
-
- *Type:* aws-cdk-lib.aws_ec2.IVpc
|
|
2042
|
-
|
|
2043
|
-
The VPC to use for the task.
|
|
2044
|
-
|
|
2045
|
-
---
|
|
2046
|
-
|
|
2047
|
-
##### `vpcSubnets`<sup>Required</sup> <a name="vpcSubnets" id="@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration.property.vpcSubnets"></a>
|
|
2048
|
-
|
|
2049
|
-
```typescript
|
|
2050
|
-
public readonly vpcSubnets: SubnetSelection;
|
|
2051
|
-
```
|
|
2052
|
-
|
|
2053
|
-
- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection
|
|
2054
|
-
|
|
2055
|
-
The Subnets to use for the task.
|
|
2056
|
-
|
|
2057
|
-
---
|
|
2058
|
-
|
|
2059
|
-
### EcsDeploymentProps <a name="EcsDeploymentProps" id="@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps"></a>
|
|
2060
|
-
|
|
2061
|
-
Construction properties of EcsDeployment.
|
|
2062
|
-
|
|
2063
|
-
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.Initializer"></a>
|
|
2064
|
-
|
|
2065
|
-
```typescript
|
|
2066
|
-
import { EcsDeploymentProps } from '@cdklabs/cdk-ecs-codedeploy'
|
|
2067
|
-
|
|
2068
|
-
const ecsDeploymentProps: EcsDeploymentProps = { ... }
|
|
2069
|
-
```
|
|
2070
|
-
|
|
2071
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
2072
|
-
|
|
2073
|
-
| **Name** | **Type** | **Description** |
|
|
2074
|
-
| --- | --- | --- |
|
|
2075
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.deploymentGroup">deploymentGroup</a></code> | <code>aws-cdk-lib.aws_codedeploy.IEcsDeploymentGroup</code> | The deployment group to target for this deployment. |
|
|
2076
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.targetService">targetService</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.TargetService">TargetService</a></code> | The ECS service to target for the deployment. |
|
|
2077
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.autoRollback">autoRollback</a></code> | <code>aws-cdk-lib.aws_codedeploy.AutoRollbackConfig</code> | The configuration for rollback in the event that a deployment fails. |
|
|
2078
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.description">description</a></code> | <code>string</code> | The description for the deployment. |
|
|
2079
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.timeout">timeout</a></code> | <code>aws-cdk-lib.Duration</code> | The timeout for the deployment. |
|
|
2080
|
-
|
|
2081
|
-
---
|
|
2082
|
-
|
|
2083
|
-
##### `deploymentGroup`<sup>Required</sup> <a name="deploymentGroup" id="@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.deploymentGroup"></a>
|
|
2084
|
-
|
|
2085
|
-
```typescript
|
|
2086
|
-
public readonly deploymentGroup: IEcsDeploymentGroup;
|
|
2087
|
-
```
|
|
2088
|
-
|
|
2089
|
-
- *Type:* aws-cdk-lib.aws_codedeploy.IEcsDeploymentGroup
|
|
2090
|
-
|
|
2091
|
-
The deployment group to target for this deployment.
|
|
2092
|
-
|
|
2093
|
-
---
|
|
2094
|
-
|
|
2095
|
-
##### `targetService`<sup>Required</sup> <a name="targetService" id="@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.targetService"></a>
|
|
2096
|
-
|
|
2097
|
-
```typescript
|
|
2098
|
-
public readonly targetService: TargetService;
|
|
2099
|
-
```
|
|
2100
|
-
|
|
2101
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.TargetService">TargetService</a>
|
|
2102
|
-
|
|
2103
|
-
The ECS service to target for the deployment.
|
|
2104
|
-
|
|
2105
|
-
see: https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-resources.html#reference-appspec-file-structure-resources-ecs
|
|
2106
|
-
|
|
2107
|
-
---
|
|
2108
|
-
|
|
2109
|
-
##### `autoRollback`<sup>Optional</sup> <a name="autoRollback" id="@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.autoRollback"></a>
|
|
2110
|
-
|
|
2111
|
-
```typescript
|
|
2112
|
-
public readonly autoRollback: AutoRollbackConfig;
|
|
2113
|
-
```
|
|
2114
|
-
|
|
2115
|
-
- *Type:* aws-cdk-lib.aws_codedeploy.AutoRollbackConfig
|
|
2116
|
-
- *Default:* : no automatic rollback triggered
|
|
2117
|
-
|
|
2118
|
-
The configuration for rollback in the event that a deployment fails.
|
|
2119
|
-
|
|
2120
|
-
---
|
|
2121
|
-
|
|
2122
|
-
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.description"></a>
|
|
2123
|
-
|
|
2124
|
-
```typescript
|
|
2125
|
-
public readonly description: string;
|
|
2126
|
-
```
|
|
2127
|
-
|
|
2128
|
-
- *Type:* string
|
|
2129
|
-
- *Default:* no description
|
|
2130
|
-
|
|
2131
|
-
The description for the deployment.
|
|
2132
|
-
|
|
2133
|
-
---
|
|
2134
|
-
|
|
2135
|
-
##### `timeout`<sup>Optional</sup> <a name="timeout" id="@cdklabs/cdk-ecs-codedeploy.EcsDeploymentProps.property.timeout"></a>
|
|
2136
|
-
|
|
2137
|
-
```typescript
|
|
2138
|
-
public readonly timeout: Duration;
|
|
2139
|
-
```
|
|
2140
|
-
|
|
2141
|
-
- *Type:* aws-cdk-lib.Duration
|
|
2142
|
-
- *Default:* 30 minutes
|
|
2143
|
-
|
|
2144
|
-
The timeout for the deployment.
|
|
2145
|
-
|
|
2146
|
-
If the timeout is reached, it will trigger a rollback of the stack.
|
|
2147
|
-
|
|
2148
|
-
---
|
|
2149
|
-
|
|
2150
|
-
### TargetService <a name="TargetService" id="@cdklabs/cdk-ecs-codedeploy.TargetService"></a>
|
|
2151
|
-
|
|
2152
|
-
Describe the target for CodeDeploy to use when creating a deployment for an ecs.EcsDeploymentGroup.
|
|
2153
|
-
|
|
2154
|
-
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ecs-codedeploy.TargetService.Initializer"></a>
|
|
2155
|
-
|
|
2156
|
-
```typescript
|
|
2157
|
-
import { TargetService } from '@cdklabs/cdk-ecs-codedeploy'
|
|
2158
|
-
|
|
2159
|
-
const targetService: TargetService = { ... }
|
|
2160
|
-
```
|
|
2161
|
-
|
|
2162
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
2163
|
-
|
|
2164
|
-
| **Name** | **Type** | **Description** |
|
|
2165
|
-
| --- | --- | --- |
|
|
2166
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.TargetService.property.containerName">containerName</a></code> | <code>string</code> | The name of the Amazon ECS container that contains your Amazon ECS application. |
|
|
2167
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.TargetService.property.containerPort">containerPort</a></code> | <code>number</code> | The port on the container where traffic will be routed to. |
|
|
2168
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.TargetService.property.taskDefinition">taskDefinition</a></code> | <code>aws-cdk-lib.aws_ecs.ITaskDefinition</code> | The TaskDefintion to deploy to the target services. |
|
|
2169
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.TargetService.property.awsvpcConfiguration">awsvpcConfiguration</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration">AwsvpcConfiguration</a></code> | Network configuration for ECS services that have a network type of `awsvpc`. |
|
|
2170
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.TargetService.property.capacityProviderStrategy">capacityProviderStrategy</a></code> | <code>aws-cdk-lib.aws_ecs.CapacityProviderStrategy[]</code> | A list of Amazon ECS capacity providers to use for the deployment. |
|
|
2171
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.TargetService.property.platformVersion">platformVersion</a></code> | <code>aws-cdk-lib.aws_ecs.FargatePlatformVersion</code> | The platform version of the Fargate tasks in the deployed Amazon ECS service. |
|
|
2172
|
-
|
|
2173
|
-
---
|
|
2174
|
-
|
|
2175
|
-
##### `containerName`<sup>Required</sup> <a name="containerName" id="@cdklabs/cdk-ecs-codedeploy.TargetService.property.containerName"></a>
|
|
2176
|
-
|
|
2177
|
-
```typescript
|
|
2178
|
-
public readonly containerName: string;
|
|
2179
|
-
```
|
|
2180
|
-
|
|
2181
|
-
- *Type:* string
|
|
2182
|
-
|
|
2183
|
-
The name of the Amazon ECS container that contains your Amazon ECS application.
|
|
2184
|
-
|
|
2185
|
-
It must be a container specified in your Amazon ECS task definition.
|
|
2186
|
-
|
|
2187
|
-
---
|
|
2188
|
-
|
|
2189
|
-
##### `containerPort`<sup>Required</sup> <a name="containerPort" id="@cdklabs/cdk-ecs-codedeploy.TargetService.property.containerPort"></a>
|
|
2190
|
-
|
|
2191
|
-
```typescript
|
|
2192
|
-
public readonly containerPort: number;
|
|
2193
|
-
```
|
|
2194
|
-
|
|
2195
|
-
- *Type:* number
|
|
2196
|
-
|
|
2197
|
-
The port on the container where traffic will be routed to.
|
|
2198
|
-
|
|
2199
|
-
---
|
|
2200
|
-
|
|
2201
|
-
##### `taskDefinition`<sup>Required</sup> <a name="taskDefinition" id="@cdklabs/cdk-ecs-codedeploy.TargetService.property.taskDefinition"></a>
|
|
2202
|
-
|
|
2203
|
-
```typescript
|
|
2204
|
-
public readonly taskDefinition: ITaskDefinition;
|
|
2205
|
-
```
|
|
2206
|
-
|
|
2207
|
-
- *Type:* aws-cdk-lib.aws_ecs.ITaskDefinition
|
|
2208
|
-
|
|
2209
|
-
The TaskDefintion to deploy to the target services.
|
|
2210
|
-
|
|
2211
|
-
---
|
|
2212
|
-
|
|
2213
|
-
##### `awsvpcConfiguration`<sup>Optional</sup> <a name="awsvpcConfiguration" id="@cdklabs/cdk-ecs-codedeploy.TargetService.property.awsvpcConfiguration"></a>
|
|
2214
|
-
|
|
2215
|
-
```typescript
|
|
2216
|
-
public readonly awsvpcConfiguration: AwsvpcConfiguration;
|
|
2217
|
-
```
|
|
2218
|
-
|
|
2219
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.AwsvpcConfiguration">AwsvpcConfiguration</a>
|
|
2220
|
-
- *Default:* reuse current network settings for ECS service.
|
|
2221
|
-
|
|
2222
|
-
Network configuration for ECS services that have a network type of `awsvpc`.
|
|
2223
|
-
|
|
2224
|
-
---
|
|
2225
|
-
|
|
2226
|
-
##### `capacityProviderStrategy`<sup>Optional</sup> <a name="capacityProviderStrategy" id="@cdklabs/cdk-ecs-codedeploy.TargetService.property.capacityProviderStrategy"></a>
|
|
2227
|
-
|
|
2228
|
-
```typescript
|
|
2229
|
-
public readonly capacityProviderStrategy: CapacityProviderStrategy[];
|
|
2230
|
-
```
|
|
2231
|
-
|
|
2232
|
-
- *Type:* aws-cdk-lib.aws_ecs.CapacityProviderStrategy[]
|
|
2233
|
-
- *Default:* reuse current capcity provider strategy for ECS service.
|
|
2234
|
-
|
|
2235
|
-
A list of Amazon ECS capacity providers to use for the deployment.
|
|
2236
|
-
|
|
2237
|
-
---
|
|
2238
|
-
|
|
2239
|
-
##### `platformVersion`<sup>Optional</sup> <a name="platformVersion" id="@cdklabs/cdk-ecs-codedeploy.TargetService.property.platformVersion"></a>
|
|
2240
|
-
|
|
2241
|
-
```typescript
|
|
2242
|
-
public readonly platformVersion: FargatePlatformVersion;
|
|
2243
|
-
```
|
|
2244
|
-
|
|
2245
|
-
- *Type:* aws-cdk-lib.aws_ecs.FargatePlatformVersion
|
|
2246
|
-
- *Default:* LATEST
|
|
2247
|
-
|
|
2248
|
-
The platform version of the Fargate tasks in the deployed Amazon ECS service.
|
|
2249
|
-
|
|
2250
|
-
see: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
|
2251
|
-
|
|
2252
|
-
---
|
|
2253
|
-
|
|
2254
|
-
## Classes <a name="Classes" id="Classes"></a>
|
|
2255
|
-
|
|
2256
|
-
### EcsAppSpec <a name="EcsAppSpec" id="@cdklabs/cdk-ecs-codedeploy.EcsAppSpec"></a>
|
|
2257
|
-
|
|
2258
|
-
Represents an AppSpec to be used for ECS services.
|
|
2259
|
-
|
|
2260
|
-
see: https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-resources.html#reference-appspec-file-structure-resources-ecs
|
|
2261
|
-
|
|
2262
|
-
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ecs-codedeploy.EcsAppSpec.Initializer"></a>
|
|
2263
|
-
|
|
2264
|
-
```typescript
|
|
2265
|
-
import { EcsAppSpec } from '@cdklabs/cdk-ecs-codedeploy'
|
|
2266
|
-
|
|
2267
|
-
new EcsAppSpec(targetService: TargetService)
|
|
2268
|
-
```
|
|
2269
|
-
|
|
2270
|
-
| **Name** | **Type** | **Description** |
|
|
2271
|
-
| --- | --- | --- |
|
|
2272
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsAppSpec.Initializer.parameter.targetService">targetService</a></code> | <code><a href="#@cdklabs/cdk-ecs-codedeploy.TargetService">TargetService</a></code> | *No description.* |
|
|
2273
|
-
|
|
2274
|
-
---
|
|
2275
|
-
|
|
2276
|
-
##### `targetService`<sup>Required</sup> <a name="targetService" id="@cdklabs/cdk-ecs-codedeploy.EcsAppSpec.Initializer.parameter.targetService"></a>
|
|
2277
|
-
|
|
2278
|
-
- *Type:* <a href="#@cdklabs/cdk-ecs-codedeploy.TargetService">TargetService</a>
|
|
2279
|
-
|
|
2280
|
-
---
|
|
2281
|
-
|
|
2282
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
2283
|
-
|
|
2284
|
-
| **Name** | **Description** |
|
|
2285
|
-
| --- | --- |
|
|
2286
|
-
| <code><a href="#@cdklabs/cdk-ecs-codedeploy.EcsAppSpec.toString">toString</a></code> | Render JSON string for this AppSpec to be used. |
|
|
2287
|
-
|
|
2288
|
-
---
|
|
2289
|
-
|
|
2290
|
-
##### `toString` <a name="toString" id="@cdklabs/cdk-ecs-codedeploy.EcsAppSpec.toString"></a>
|
|
2291
|
-
|
|
2292
|
-
```typescript
|
|
2293
|
-
public toString(): string
|
|
2294
|
-
```
|
|
2295
|
-
|
|
2296
|
-
Render JSON string for this AppSpec to be used.
|