@awboost/cfn-resource-types 0.1.390 → 0.1.392

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.
@@ -300,7 +300,7 @@ export type Ebs = {
300
300
  */
301
301
  export type ElasticGpuSpecification = {
302
302
  /**
303
- * The type of Elastic Graphics accelerator.
303
+ * The type of Elastic Graphics accelerator. Amazon Elastic Graphics is no longer available.
304
304
  */
305
305
  Type: string;
306
306
  };
@@ -310,12 +310,12 @@ export type ElasticGpuSpecification = {
310
310
  */
311
311
  export type ElasticInferenceAccelerator = {
312
312
  /**
313
- * The number of elastic inference accelerators to attach to the instance.
313
+ * The number of elastic inference accelerators to attach to the instance. Amazon Elastic Inference is no longer available.
314
314
  * @min `0`
315
315
  */
316
316
  Count?: number;
317
317
  /**
318
- * The type of elastic inference accelerator.
318
+ * The type of elastic inference accelerator. Amazon Elastic Inference is no longer available.
319
319
  */
320
320
  Type: string;
321
321
  };
@@ -51,7 +51,7 @@ export type ECSServiceProperties = {
51
51
  */
52
52
  DeploymentConfiguration?: DeploymentConfiguration;
53
53
  /**
54
- * The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used.
54
+ * The deployment controller to use for the service.
55
55
  */
56
56
  DeploymentController?: DeploymentController;
57
57
  /**
@@ -62,7 +62,7 @@ export type ECSServiceProperties = {
62
62
  DesiredCount?: number;
63
63
  /**
64
64
  * Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.
65
- When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.
65
+ When you use Amazon ECS managed tags, you must set the ``propagateTags`` request parameter.
66
66
  */
67
67
  EnableECSManagedTags?: boolean;
68
68
  /**
@@ -175,12 +175,25 @@ export type ECSServiceAttributes = {
175
175
  };
176
176
  /**
177
177
  * Type definition for `AWS::ECS::Service.AdvancedConfiguration`.
178
+ * The advanced settings for a load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments. For more information, see [Required resources for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-deployment-implementation.html) in the *Amazon Elastic Container Service Developer Guide*.
178
179
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-advancedconfiguration.html}
179
180
  */
180
181
  export type AdvancedConfiguration = {
182
+ /**
183
+ * The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments.
184
+ */
181
185
  AlternateTargetGroupArn: string;
186
+ /**
187
+ * The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic.
188
+ */
182
189
  ProductionListenerRule?: string;
190
+ /**
191
+ * The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you.
192
+ */
183
193
  RoleArn?: string;
194
+ /**
195
+ * The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic.
196
+ */
184
197
  TestListenerRule?: string;
185
198
  };
186
199
  /**
@@ -235,7 +248,7 @@ export type CapacityProviderStrategyItem = {
235
248
  * Type definition for `AWS::ECS::Service.DeploymentAlarms`.
236
249
  * One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.
237
250
  When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.
238
- You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update).
251
+ You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS``.
239
252
  For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.
240
253
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html}
241
254
  */
@@ -281,15 +294,23 @@ export type DeploymentConfiguration = {
281
294
  */
282
295
  Alarms?: DeploymentAlarms;
283
296
  /**
284
- * @min `0`
285
- * @max `1440`
286
- */
297
+ * The duration when both blue and green service revisions are running simultaneously after the production traffic has shifted.
298
+ The following rules apply when you don't specify a value:
299
+ + For rolling deployments, the value is set to 3 hours (180 minutes).
300
+ + When you use an external deployment controller (``EXTERNAL``), or the ACD blue/green deployment controller (``CODE_DEPLOY``), the value is set to 3 hours (180 minutes).
301
+ + For all other cases, the value is set to 36 hours (2160 minutes).
302
+ * @min `0`
303
+ * @max `1440`
304
+ */
287
305
  BakeTimeInMinutes?: number;
288
306
  /**
289
307
  * The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.
290
308
  The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*
291
309
  */
292
310
  DeploymentCircuitBreaker?: DeploymentCircuitBreaker;
311
+ /**
312
+ * An array of deployment lifecycle hook objects to run custom logic at specific stages of the deployment lifecycle.
313
+ */
293
314
  LifecycleHooks?: DeploymentLifecycleHook[];
294
315
  /**
295
316
  * If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%.
@@ -318,6 +339,11 @@ export type DeploymentConfiguration = {
318
339
  If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
319
340
  */
320
341
  MinimumHealthyPercent?: number;
342
+ /**
343
+ * The deployment strategy for the service. Choose from these valid values:
344
+ + ``ROLLING`` - When you create a service which uses the rolling update (``ROLLING``) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration.
345
+ + ``BLUE_GREEN`` - A blue/green deployment strategy (``BLUE_GREEN``) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed.
346
+ */
321
347
  Strategy?: "ROLLING" | "BLUE_GREEN";
322
348
  };
323
349
  /**
@@ -327,21 +353,87 @@ export type DeploymentConfiguration = {
327
353
  */
328
354
  export type DeploymentController = {
329
355
  /**
330
- * The deployment controller type to use. There are three deployment controller types available:
331
- + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
356
+ * The deployment controller type to use.
357
+ The deployment controller is the mechanism that determines how tasks are deployed for your service. The valid options are:
358
+ + ECS
359
+ When you create a service which uses the ``ECS`` deployment controller, you can choose between the following deployment strategies:
360
+ + ``ROLLING``: When you create a service which uses the *rolling update* (``ROLLING``) deployment strategy, the ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration.
361
+ Rolling update deployments are best suited for the following scenarios:
362
+ + Gradual service updates: You need to update your service incrementally without taking the entire service offline at once.
363
+ + Limited resource requirements: You want to avoid the additional resource costs of running two complete environments simultaneously (as required by blue/green deployments).
364
+ + Acceptable deployment time: Your application can tolerate a longer deployment process, as rolling updates replace tasks one by one.
365
+ + No need for instant roll back: Your service can tolerate a rollback process that takes minutes rather than seconds.
366
+ + Simple deployment process: You prefer a straightforward deployment approach without the complexity of managing multiple environments, target groups, and listeners.
367
+ + No load balancer requirement: Your service doesn't use or require a load balancer, ALB, NLB, or Service Connect (which are required for blue/green deployments).
368
+ + Stateful applications: Your application maintains state that makes it difficult to run two parallel environments.
369
+ + Cost sensitivity: You want to minimize deployment costs by not running duplicate environments during deployment.
370
+
371
+ Rolling updates are the default deployment strategy for services and provide a balance between deployment safety and resource efficiency for many common application scenarios.
372
+ + ``BLUE_GREEN``: A *blue/green* deployment strategy (``BLUE_GREEN``) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed.
373
+ ECS blue/green deployments are best suited for the following scenarios:
374
+ + Service validation: When you need to validate new service revisions before directing production traffic to them
375
+ + Zero downtime: When your service requires zero-downtime deployments
376
+ + Instant roll back: When you need the ability to quickly roll back if issues are detected
377
+ + Load balancer requirement: When your service uses ALB, NLB, or Service Connect
378
+
379
+
380
+ + External
381
+ Use a third-party deployment controller.
382
+ + Blue/green deployment (powered by ACD)
383
+ ACD installs an updated version of the application as a new replacement task set and reroutes production traffic from the original application task set to the replacement task set. The original task set is terminated after a successful deployment. Use this deployment controller to verify a new deployment of a service before sending production traffic to it.
384
+
385
+ When updating the deployment controller for a service, consider the following depending on the type of migration you're performing.
386
+ + If you have a template that contains the ``EXTERNAL`` deployment controller information as well as ``TaskSet`` and ``PrimaryTaskSet`` resources, and you remove the task set resources from the template when updating from ``EXTERNAL`` to ``ECS``, the ``DescribeTaskSet`` and ``DeleteTaskSet`` API calls will return a 400 error after the deployment controller is updated to ``ECS``. This results in a delete failure on the task set resources, even though the stack transitions to ``UPDATE_COMPLETE`` status. For more information, see [Resource removed from stack but not deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-resource-removed-not-deleted) in the CFNlong User Guide. To fix this issue, delete the task sets directly using the ECS``DeleteTaskSet`` API. For more information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the ECSlong API Reference.
387
+ + If you're migrating from ``CODE_DEPLOY`` to ``ECS`` with a new task definition and CFN performs a rollback operation, the ECS``UpdateService`` request fails with the following error:
388
+ Resource handler returned message: "Invalid request provided: Unable to update task definition on services with a CODE_DEPLOY deployment controller.
389
+ + After a successful migration from ``ECS`` to ``EXTERNAL`` deployment controller, you need to manually remove the ``ACTIVE`` task set, because ECS no longer manages the deployment. For information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the ECSlong API Reference.
332
390
  */
333
391
  Type?: "CODE_DEPLOY" | "ECS" | "EXTERNAL";
334
392
  };
335
393
  /**
336
394
  * Type definition for `AWS::ECS::Service.DeploymentLifecycleHook`.
395
+ * A deployment lifecycle hook runs custom logic at specific stages of the deployment process. Currently, you can use Lambda functions as hook targets.
396
+ For more information, see [Lifecycle hooks for Amazon ECS service deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-lifecycle-hooks.html) in the *Amazon Elastic Container Service Developer Guide*.
337
397
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html}
338
398
  */
339
399
  export type DeploymentLifecycleHook = {
400
+ /**
401
+ * The Amazon Resource Name (ARN) of the hook target. Currently, only Lambda function ARNs are supported.
402
+ You must provide this parameter when configuring a deployment lifecycle hook.
403
+ */
340
404
  HookTargetArn: string;
341
405
  /**
342
- * @minLength `1`
343
- */
406
+ * The lifecycle stages at which to run the hook. Choose from these valid values:
407
+ + RECONCILE_SERVICE
408
+ The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.
409
+ You can use a lifecycle hook for this stage.
410
+ + PRE_SCALE_UP
411
+ The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.
412
+ You can use a lifecycle hook for this stage.
413
+ + POST_SCALE_UP
414
+ The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.
415
+ You can use a lifecycle hook for this stage.
416
+ + TEST_TRAFFIC_SHIFT
417
+ The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.
418
+ You can use a lifecycle hook for this stage.
419
+ + POST_TEST_TRAFFIC_SHIFT
420
+ The test traffic shift is complete. The green service revision handles 100% of the test traffic.
421
+ You can use a lifecycle hook for this stage.
422
+ + PRODUCTION_TRAFFIC_SHIFT
423
+ Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.
424
+ You can use a lifecycle hook for this stage.
425
+ + POST_PRODUCTION_TRAFFIC_SHIFT
426
+ The production traffic shift is complete.
427
+ You can use a lifecycle hook for this stage.
428
+
429
+ You must provide this parameter when configuring a deployment lifecycle hook.
430
+ * @minLength `1`
431
+ */
344
432
  LifecycleStages: ("RECONCILE_SERVICE" | "PRE_SCALE_UP" | "POST_SCALE_UP" | "TEST_TRAFFIC_SHIFT" | "POST_TEST_TRAFFIC_SHIFT" | "PRODUCTION_TRAFFIC_SHIFT" | "POST_PRODUCTION_TRAFFIC_SHIFT")[];
433
+ /**
434
+ * The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.
435
+ For more information, see [Permissions required for Lambda functions in Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-permissions.html) in the *Amazon Elastic Container Service Developer Guide*.
436
+ */
345
437
  RoleArn: string;
346
438
  };
347
439
  /**
@@ -374,6 +466,9 @@ export type EBSTagSpecification = {
374
466
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html}
375
467
  */
376
468
  export type LoadBalancer = {
469
+ /**
470
+ * The advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments.
471
+ */
377
472
  AdvancedConfiguration?: AdvancedConfiguration;
378
473
  /**
379
474
  * The name of the container (as it appears in a container definition) to associate with the load balancer.
@@ -524,6 +619,9 @@ export type ServiceConnectClientAlias = {
524
619
  To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
525
620
  */
526
621
  Port: number;
622
+ /**
623
+ * The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic.
624
+ */
527
625
  TestTrafficRules?: ServiceConnectTestTrafficRules;
528
626
  };
529
627
  /**
@@ -599,9 +697,14 @@ export type ServiceConnectService = {
599
697
  };
600
698
  /**
601
699
  * Type definition for `AWS::ECS::Service.ServiceConnectTestTrafficRules`.
700
+ * The test traffic routing configuration for Amazon ECS blue/green deployments. This configuration allows you to define rules for routing specific traffic to the new service revision during the deployment process, allowing for safe testing before full production traffic shift.
701
+ For more information, see [Service Connect for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-blue-green.html) in the *Amazon Elastic Container Service Developer Guide*.
602
702
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnecttesttrafficrules.html}
603
703
  */
604
704
  export type ServiceConnectTestTrafficRules = {
705
+ /**
706
+ * The HTTP header-based routing rules that determine which requests should be routed to the new service version during blue/green deployment testing. These rules provide fine-grained control over test traffic routing based on request headers.
707
+ */
605
708
  Header: ServiceConnectTestTrafficRulesHeader;
606
709
  };
607
710
  /**
@@ -403,6 +403,10 @@ export type DrmSystem = "CLEAR_KEY_AES_128" | "FAIRPLAY" | "PLAYREADY" | "WIDEVI
403
403
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackagev2-originendpoint-encryption.html}
404
404
  */
405
405
  export type Encryption = {
406
+ /**
407
+ * <p>Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.</p> <p>When set to <code>true</code>, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.</p> <p>Important considerations:</p> <ul> <li> <p>This setting only affects CMAF container formats</p> </li> <li> <p>Key rotation can still be handled through media playlist signaling</p> </li> <li> <p>PSSH and TENC boxes remain unaffected</p> </li> <li> <p>Default behavior is preserved when this setting is disabled</p> </li> </ul> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default: <code>false</code> </p>
408
+ */
409
+ CmafExcludeSegmentDrmMetadata?: boolean;
406
410
  /**
407
411
  * <p>A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).</p>
408
412
  * @minLength `32`
@@ -150,6 +150,7 @@ export type StatefulRuleGroupOverride = {
150
150
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html}
151
151
  */
152
152
  export type StatefulRuleGroupReference = {
153
+ DeepThreatInspection?: boolean;
153
154
  Override?: StatefulRuleGroupOverride;
154
155
  /**
155
156
  * @min `1`
@@ -19,6 +19,9 @@ export type NetworkFirewallRuleGroupProperties = {
19
19
  * @pattern `^[a-zA-Z0-9-]+$`
20
20
  */
21
21
  RuleGroupName: string;
22
+ SummaryConfiguration?: {
23
+ RuleOptions?: SummaryRuleOption[];
24
+ };
22
25
  Tags?: Tag[];
23
26
  Type: "STATELESS" | "STATEFUL";
24
27
  };
@@ -294,6 +297,11 @@ export type StatelessRulesAndCustomActions = {
294
297
  CustomActions?: CustomAction[];
295
298
  StatelessRules: StatelessRule[];
296
299
  };
300
+ /**
301
+ * Type definition for `AWS::NetworkFirewall::RuleGroup.SummaryRuleOption`.
302
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-summaryruleoption.html}
303
+ */
304
+ export type SummaryRuleOption = "SID" | "MSG" | "METADATA";
297
305
  /**
298
306
  * Type definition for `AWS::NetworkFirewall::RuleGroup.Tag`.
299
307
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tag.html}
@@ -465,6 +465,7 @@ export type RDSDBClusterProperties = {
465
465
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
466
466
  */
467
467
  SourceDBClusterIdentifier?: string;
468
+ SourceDbClusterResourceId?: string;
468
469
  /**
469
470
  * The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1``.
470
471
  Valid for: Aurora DB clusters only
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.390",
3
+ "version": "0.1.392",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },