Skip to content

Commit aea720f

Browse files
hupe1980hupe1980
committed
Add default configurations
1 parent e9aab02 commit aea720f

File tree

7 files changed

+231
-61
lines changed

7 files changed

+231
-61
lines changed

‎packages/cdk-blue-green-container-deployment/API.md

Lines changed: 119 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
Name|Description
66
----|-----------
77
[DummyTaskDefinition](#cloudcomponents-cdk-blue-green-container-deployment-dummytaskdefinition)|*No description*
8+
[EcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfig)|*No description*
89
[EcsDeploymentGroup](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentgroup)|*No description*
910
[EcsService](#cloudcomponents-cdk-blue-green-container-deployment-ecsservice)|*No description*
1011
[PushImageProject](#cloudcomponents-cdk-blue-green-container-deployment-pushimageproject)|*No description*
@@ -15,6 +16,7 @@ Name|Description
1516
Name|Description
1617
----|-----------
1718
[DummyTaskDefinitionProps](#cloudcomponents-cdk-blue-green-container-deployment-dummytaskdefinitionprops)|*No description*
19+
[EcsDeploymentConfigurationProps](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfigurationprops)|*No description*
1820
[EcsDeploymentGroupProps](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentgroupprops)|*No description*
1921
[EcsServiceProps](#cloudcomponents-cdk-blue-green-container-deployment-ecsserviceprops)|*No description*
2022
[PushImageProjectProps](#cloudcomponents-cdk-blue-green-container-deployment-pushimageprojectprops)|*No description*
@@ -26,6 +28,8 @@ Name|Description
2628
Name|Description
2729
----|-----------
2830
[IDummyTaskDefinition](#cloudcomponents-cdk-blue-green-container-deployment-idummytaskdefinition)|*No description*
31+
[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)|*No description*
32+
[IEcsDeploymentGroup](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentgroup)|Interface for an ECS deployment group.
2933
[IEcsService](#cloudcomponents-cdk-blue-green-container-deployment-iecsservice)|*No description*
3034

3135

@@ -93,11 +97,69 @@ addToExecutionRolePolicy(statement: PolicyStatement): void
9397

9498

9599

100+
## class EcsDeploymentConfig <a id="cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfig"></a>
101+
102+
103+
104+
__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IResource](#aws-cdk-core-iresource), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IConstruct](#aws-cdk-core-iconstruct), [IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)
105+
__Extends__: [Resource](#aws-cdk-core-resource)
106+
107+
### Initializer
108+
109+
110+
111+
112+
```ts
113+
new EcsDeploymentConfig(scope: Construct, id: string, props: EcsDeploymentConfigurationProps)
114+
```
115+
116+
* **scope** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
117+
* **id** (<code>string</code>) *No description*
118+
* **props** (<code>[EcsDeploymentConfigurationProps](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfigurationprops)</code>) *No description*
119+
* **deploymentConfigName** (<code>string</code>) `AWS::CodeDeploy::DeploymentConfig.DeploymentConfigName`. __*Optional*__
120+
* **minimumHealthyHosts** (<code>[CfnDeploymentConfig.MinimumHealthyHostsProperty](#aws-cdk-aws-codedeploy-cfndeploymentconfig-minimumhealthyhostsproperty) &#124; [IResolvable](#aws-cdk-core-iresolvable)</code>) `AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts`. __*Optional*__
121+
* **trafficRoutingConfig** (<code>[IResolvable](#aws-cdk-core-iresolvable) &#124; [CfnDeploymentConfig.TrafficRoutingConfigProperty](#aws-cdk-aws-codedeploy-cfndeploymentconfig-trafficroutingconfigproperty)</code>) `AWS::CodeDeploy::DeploymentConfig.TrafficRoutingConfig`. __*Optional*__
122+
123+
124+
125+
### Properties
126+
127+
128+
Name | Type | Description
129+
-----|------|-------------
130+
**deploymentConfigArn** | <code>string</code> | <span></span>
131+
**deploymentConfigName** | <code>string</code> | <span></span>
132+
*static* **ALL_AT_ONCE** | <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code> | <span></span>
133+
*static* **CANARY_10PERCENT_15MINUTES** | <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code> | <span></span>
134+
*static* **CANARY_10PERCENT_5MINUTES** | <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code> | <span></span>
135+
*static* **LINEAR_10PERCENT_EVERY_1MINUTE** | <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code> | <span></span>
136+
*static* **LINEAR_10PERCENT_EVERY_3MINUTES** | <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code> | <span></span>
137+
138+
### Methods
139+
140+
141+
#### *static* fromEcsDeploymentConfigName(_scope, _id, ecsDeploymentConfigName) <a id="cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfig-fromecsdeploymentconfigname"></a>
142+
143+
Import a custom Deployment Configuration for an ECS Deployment Group defined outside the CDK.
144+
145+
```ts
146+
static fromEcsDeploymentConfigName(_scope: Construct, _id: string, ecsDeploymentConfigName: string): IEcsDeploymentConfig
147+
```
148+
149+
* **_scope** (<code>[Construct](#aws-cdk-core-construct)</code>) the parent Construct for this new Construct.
150+
* **_id** (<code>string</code>) the logical ID of this new Construct.
151+
* **ecsDeploymentConfigName** (<code>string</code>) the name of the referenced custom Deployment Configuration.
152+
153+
__Returns__:
154+
* <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code>
155+
156+
157+
96158
## class EcsDeploymentGroup <a id="cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentgroup"></a>
97159

98160

99161

100-
__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IResource](#aws-cdk-core-iresource), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IConstruct](#aws-cdk-core-iconstruct), [IEcsDeploymentGroup](#aws-cdk-aws-codedeploy-iecsdeploymentgroup), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IConstruct](#aws-cdk-core-iconstruct), [IResource](#aws-cdk-core-iresource)
162+
__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IResource](#aws-cdk-core-iresource), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IConstruct](#aws-cdk-core-iconstruct), [IEcsDeploymentGroup](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentgroup), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IConstruct](#aws-cdk-core-iconstruct), [IResource](#aws-cdk-core-iresource)
101163
__Extends__: [Resource](#aws-cdk-core-resource)
102164

103165
### Initializer
@@ -119,7 +181,7 @@ new EcsDeploymentGroup(scope: Construct, id: string, props: EcsDeploymentGroupPr
119181
* **testTrafficListener** (<code>[TrafficListener](#cloudcomponents-cdk-blue-green-container-deployment-trafficlistener)</code>) *No description*
120182
* **applicationName** (<code>string</code>) *No description* __*Optional*__
121183
* **autoRollbackOnEvents** (<code>Array<[RollbackEvent](#cloudcomponents-cdk-blue-green-container-deployment-rollbackevent)></code>) The event type or types that trigger a rollback. __*Optional*__
122-
* **deploymentConfig** (<code>[IEcsDeploymentConfig](#aws-cdk-aws-codedeploy-iecsdeploymentconfig)</code>) *No description* __*Optional*__
184+
* **deploymentConfig** (<code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code>) *No description* __*Optional*__
123185
* **terminationWaitTimeInMinutes** (<code>number</code>) the number of minutes before deleting the original (blue) task set. __*Default*__: 60
124186

125187

@@ -130,7 +192,7 @@ new EcsDeploymentGroup(scope: Construct, id: string, props: EcsDeploymentGroupPr
130192
Name | Type | Description
131193
-----|------|-------------
132194
**application** | <code>[IEcsApplication](#aws-cdk-aws-codedeploy-iecsapplication)</code> | The reference to the CodeDeploy ECS Application that this Deployment Group belongs to.
133-
**deploymentConfig** | <code>[IEcsDeploymentConfig](#aws-cdk-aws-codedeploy-iecsdeploymentconfig)</code> | The Deployment Configuration this Group uses.
195+
**deploymentConfig** | <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code> | The Deployment Configuration this Group uses.
134196
**deploymentGroupArn** | <code>string</code> | The ARN of this Deployment Group.
135197
**deploymentGroupName** | <code>string</code> | The physical name of the CodeDeploy Deployment Group.
136198

@@ -228,6 +290,21 @@ Name | Type | Description
228290

229291

230292

293+
## struct EcsDeploymentConfigurationProps <a id="cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfigurationprops"></a>
294+
295+
296+
297+
298+
299+
300+
Name | Type | Description
301+
-----|------|-------------
302+
**deploymentConfigName**? | <code>string</code> | `AWS::CodeDeploy::DeploymentConfig.DeploymentConfigName`.<br/>__*Optional*__
303+
**minimumHealthyHosts**? | <code>[CfnDeploymentConfig.MinimumHealthyHostsProperty](#aws-cdk-aws-codedeploy-cfndeploymentconfig-minimumhealthyhostsproperty) &#124; [IResolvable](#aws-cdk-core-iresolvable)</code> | `AWS::CodeDeploy::DeploymentConfig.MinimumHealthyHosts`.<br/>__*Optional*__
304+
**trafficRoutingConfig**? | <code>[IResolvable](#aws-cdk-core-iresolvable) &#124; [CfnDeploymentConfig.TrafficRoutingConfigProperty](#aws-cdk-aws-codedeploy-cfndeploymentconfig-trafficroutingconfigproperty)</code> | `AWS::CodeDeploy::DeploymentConfig.TrafficRoutingConfig`.<br/>__*Optional*__
305+
306+
307+
231308
## struct EcsDeploymentGroupProps <a id="cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentgroupprops"></a>
232309

233310

@@ -244,7 +321,7 @@ Name | Type | Description
244321
**testTrafficListener** | <code>[TrafficListener](#cloudcomponents-cdk-blue-green-container-deployment-trafficlistener)</code> | <span></span>
245322
**applicationName**? | <code>string</code> | __*Optional*__
246323
**autoRollbackOnEvents**? | <code>Array<[RollbackEvent](#cloudcomponents-cdk-blue-green-container-deployment-rollbackevent)></code> | The event type or types that trigger a rollback.<br/>__*Optional*__
247-
**deploymentConfig**? | <code>[IEcsDeploymentConfig](#aws-cdk-aws-codedeploy-iecsdeploymentconfig)</code> | __*Optional*__
324+
**deploymentConfig**? | <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code> | __*Optional*__
248325
**terminationWaitTimeInMinutes**? | <code>number</code> | the number of minutes before deleting the original (blue) task set.<br/>__*Default*__: 60
249326

250327

@@ -293,6 +370,44 @@ Name | Type | Description
293370

294371

295372

373+
## interface IEcsDeploymentConfig <a id="cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig"></a>
374+
375+
__Implemented by__: [EcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfig)
376+
__Obtainable from__: [EcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfig).[fromEcsDeploymentConfigName](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfig#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentconfig-fromecsdeploymentconfigname)()
377+
378+
379+
380+
### Properties
381+
382+
383+
Name | Type | Description
384+
-----|------|-------------
385+
**deploymentConfigArn** | <code>string</code> | <span></span>
386+
**deploymentConfigName** | <code>string</code> | <span></span>
387+
388+
389+
390+
## interface IEcsDeploymentGroup <a id="cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentgroup"></a>
391+
392+
__Implemented by__: [EcsDeploymentGroup](#cloudcomponents-cdk-blue-green-container-deployment-ecsdeploymentgroup)
393+
394+
Interface for an ECS deployment group.
395+
396+
### Properties
397+
398+
399+
Name | Type | Description
400+
-----|------|-------------
401+
**application** | <code>[IEcsApplication](#aws-cdk-aws-codedeploy-iecsapplication)</code> | The reference to the CodeDeploy ECS Application that this Deployment Group belongs to.
402+
**deploymentConfig** | <code>[IEcsDeploymentConfig](#cloudcomponents-cdk-blue-green-container-deployment-iecsdeploymentconfig)</code> | The Deployment Configuration this Group uses.
403+
**deploymentGroupArn** | <code>string</code> | The ARN of this Deployment Group.
404+
**deploymentGroupName** | <code>string</code> | The physical name of the CodeDeploy Deployment Group.
405+
**env** | <code>[ResourceEnvironment](#aws-cdk-core-resourceenvironment)</code> | The environment this resource belongs to.
406+
**node** | <code>[ConstructNode](#aws-cdk-core-constructnode)</code> | The construct tree node for this construct.
407+
**stack** | <code>[Stack](#aws-cdk-core-stack)</code> | The stack in which this resource is defined.
408+
409+
410+
296411
## interface IEcsService <a id="cloudcomponents-cdk-blue-green-container-deployment-iecsservice"></a>
297412

298413
__Implemented by__: [EcsService](#cloudcomponents-cdk-blue-green-container-deployment-ecsservice)

‎packages/cdk-blue-green-container-deployment/lambda-file-sizes.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"timestamp":1627652613714,"files":[{"filename":"dummy-task-definition/index.js","previous":1726,"size":1728,"diff":2},{"filename":"ecs-deployment-group/index.js","previous":2123,"size":2123,"diff":0},{"filename":"ecs-service/index.js","previous":2081,"size":2152,"diff":71}]},{"timestamp":1609276390870,"files":[{"filename":"dummy-task-definition/index.js","previous":1712,"size":1726,"diff":14},{"filename":"ecs-deployment-group/index.js","previous":2123,"size":2123,"diff":0},{"filename":"ecs-service/index.js","previous":2081,"size":2081,"diff":0}]},{"timestamp":1606329521054,"files":[{"filename":"dummy-task-definition/index.js","previous":1706,"size":1712,"diff":6},{"filename":"ecs-deployment-group/index.js","previous":2116,"size":2123,"diff":7},{"filename":"ecs-service/index.js","previous":2073,"size":2081,"diff":8}]},{"timestamp":1596457247342,"files":[{"filename":"dummy-task-definition/index.js","previous":1756,"size":1706,"diff":-50},{"filename":"ecs-deployment-group/index.js","previous":2116,"size":2116,"diff":0},{"filename":"ecs-service/index.js","previous":2073,"size":2073,"diff":0}]},{"timestamp":1596454924871,"files":[{"filename":"dummy-task-definition/index.js","previous":4964,"size":1756,"diff":-3208},{"filename":"ecs-deployment-group/index.js","previous":6103,"size":2116,"diff":-3987},{"filename":"ecs-service/index.js","previous":6141,"size":2073,"diff":-4068}]},{"timestamp":1596407637937,"files":[{"filename":"blue-green-service/__entrypoint__.js","previous":6760,"size":0,"diff":-6760},{"filename":"blue-green-service/index.js","previous":3368,"size":0,"diff":-3368},{"filename":"dummy-task-definition/__entrypoint__.js","previous":6760,"size":0,"diff":-6760},{"filename":"dummy-task-definition/index.js","previous":1963,"size":4964,"diff":3001},{"filename":"ecs-deployment-group/__entrypoint__.js","previous":6760,"size":0,"diff":-6760},{"filename":"ecs-deployment-group/index.js","previous":2292,"size":6103,"diff":3811},{"filename":"ecs-service/__entrypoint__.js","previous":6760,"size":0,"diff":-6760},{"filename":"ecs-service/index.js","previous":2312,"size":6141,"diff":3829}]}]
1+
[{"timestamp":1629825530770,"files":[{"filename":"dummy-task-definition/index.js","previous":1728,"size":1728,"diff":0},{"filename":"ecs-deployment-group/index.js","previous":2171,"size":2182,"diff":11},{"filename":"ecs-service/index.js","previous":2152,"size":2152,"diff":0}]},{"timestamp":1629823812165,"files":[{"filename":"dummy-task-definition/index.js","previous":1728,"size":1728,"diff":0},{"filename":"ecs-deployment-group/index.js","previous":2123,"size":2171,"diff":48},{"filename":"ecs-service/index.js","previous":2152,"size":2152,"diff":0}]},{"timestamp":1627652613714,"files":[{"filename":"dummy-task-definition/index.js","previous":1726,"size":1728,"diff":2},{"filename":"ecs-deployment-group/index.js","previous":2123,"size":2123,"diff":0},{"filename":"ecs-service/index.js","previous":2081,"size":2152,"diff":71}]},{"timestamp":1609276390870,"files":[{"filename":"dummy-task-definition/index.js","previous":1712,"size":1726,"diff":14},{"filename":"ecs-deployment-group/index.js","previous":2123,"size":2123,"diff":0},{"filename":"ecs-service/index.js","previous":2081,"size":2081,"diff":0}]},{"timestamp":1606329521054,"files":[{"filename":"dummy-task-definition/index.js","previous":1706,"size":1712,"diff":6},{"filename":"ecs-deployment-group/index.js","previous":2116,"size":2123,"diff":7},{"filename":"ecs-service/index.js","previous":2073,"size":2081,"diff":8}]},{"timestamp":1596457247342,"files":[{"filename":"dummy-task-definition/index.js","previous":1756,"size":1706,"diff":-50},{"filename":"ecs-deployment-group/index.js","previous":2116,"size":2116,"diff":0},{"filename":"ecs-service/index.js","previous":2073,"size":2073,"diff":0}]},{"timestamp":1596454924871,"files":[{"filename":"dummy-task-definition/index.js","previous":4964,"size":1756,"diff":-3208},{"filename":"ecs-deployment-group/index.js","previous":6103,"size":2116,"diff":-3987},{"filename":"ecs-service/index.js","previous":6141,"size":2073,"diff":-4068}]},{"timestamp":1596407637937,"files":[{"filename":"blue-green-service/__entrypoint__.js","previous":6760,"size":0,"diff":-6760},{"filename":"blue-green-service/index.js","previous":3368,"size":0,"diff":-3368},{"filename":"dummy-task-definition/__entrypoint__.js","previous":6760,"size":0,"diff":-6760},{"filename":"dummy-task-definition/index.js","previous":1963,"size":4964,"diff":3001},{"filename":"ecs-deployment-group/__entrypoint__.js","previous":6760,"size":0,"diff":-6760},{"filename":"ecs-deployment-group/index.js","previous":2292,"size":6103,"diff":3811},{"filename":"ecs-service/__entrypoint__.js","previous":6760,"size":0,"diff":-6760},{"filename":"ecs-service/index.js","previous":2312,"size":6141,"diff":3829}]}]

0 commit comments

Comments
 (0)