@aws-sdk/client-batch 3.686.0 → 3.688.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -163,6 +163,16 @@ declare const CreateComputeEnvironmentCommand_base: {
163
163
  * launchTemplateId: "STRING_VALUE",
164
164
  * launchTemplateName: "STRING_VALUE",
165
165
  * version: "STRING_VALUE",
166
+ * overrides: [ // LaunchTemplateSpecificationOverrideList
167
+ * { // LaunchTemplateSpecificationOverride
168
+ * launchTemplateId: "STRING_VALUE",
169
+ * launchTemplateName: "STRING_VALUE",
170
+ * version: "STRING_VALUE",
171
+ * targetInstanceTypes: [
172
+ * "STRING_VALUE",
173
+ * ],
174
+ * },
175
+ * ],
166
176
  * },
167
177
  * ec2Configuration: [ // Ec2ConfigurationList
168
178
  * { // Ec2Configuration
@@ -88,6 +88,16 @@ declare const DescribeComputeEnvironmentsCommand_base: {
88
88
  * // launchTemplateId: "STRING_VALUE",
89
89
  * // launchTemplateName: "STRING_VALUE",
90
90
  * // version: "STRING_VALUE",
91
+ * // overrides: [ // LaunchTemplateSpecificationOverrideList
92
+ * // { // LaunchTemplateSpecificationOverride
93
+ * // launchTemplateId: "STRING_VALUE",
94
+ * // launchTemplateName: "STRING_VALUE",
95
+ * // version: "STRING_VALUE",
96
+ * // targetInstanceTypes: [
97
+ * // "STRING_VALUE",
98
+ * // ],
99
+ * // },
100
+ * // ],
91
101
  * // },
92
102
  * // ec2Configuration: [ // Ec2ConfigurationList
93
103
  * // { // Ec2Configuration
@@ -63,6 +63,16 @@ declare const UpdateComputeEnvironmentCommand_base: {
63
63
  * launchTemplateId: "STRING_VALUE",
64
64
  * launchTemplateName: "STRING_VALUE",
65
65
  * version: "STRING_VALUE",
66
+ * overrides: [ // LaunchTemplateSpecificationOverrideList
67
+ * { // LaunchTemplateSpecificationOverride
68
+ * launchTemplateId: "STRING_VALUE",
69
+ * launchTemplateName: "STRING_VALUE",
70
+ * version: "STRING_VALUE",
71
+ * targetInstanceTypes: [
72
+ * "STRING_VALUE",
73
+ * ],
74
+ * },
75
+ * ],
66
76
  * },
67
77
  * ec2Configuration: [ // Ec2ConfigurationList
68
78
  * { // Ec2Configuration
@@ -392,6 +392,86 @@ export interface Ec2Configuration {
392
392
  */
393
393
  imageKubernetesVersion?: string;
394
394
  }
395
+ /**
396
+ * <p>An object that represents a launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not
397
+ * both.</p>
398
+ * <p>If security groups are specified using both the <code>securityGroupIds</code> parameter of
399
+ * <code>CreateComputeEnvironment</code> and the launch template, the values in the
400
+ * <code>securityGroupIds</code> parameter of <code>CreateComputeEnvironment</code> will be
401
+ * used.</p>
402
+ * <p>You can define up to ten (10) overrides for each compute environment.</p>
403
+ * <note>
404
+ * <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
405
+ * </note>
406
+ * <note>
407
+ * <p>To unset all override templates for a compute environment, you can pass an empty array to the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html">UpdateComputeEnvironment.overrides</a> parameter, or not include the <code>overrides</code> parameter when submitting the <code>UpdateComputeEnvironment</code> API operation.</p>
408
+ * </note>
409
+ * @public
410
+ */
411
+ export interface LaunchTemplateSpecificationOverride {
412
+ /**
413
+ * <p>The ID of the launch template.</p>
414
+ * <p>
415
+ * <b>Note:</b> If you specify the <code>launchTemplateId</code> you can't specify the <code>launchTemplateName</code> as well.</p>
416
+ * @public
417
+ */
418
+ launchTemplateId?: string;
419
+ /**
420
+ * <p>The name of the launch template.</p>
421
+ * <p>
422
+ * <b>Note:</b> If you specify the <code>launchTemplateName</code> you can't specify the <code>launchTemplateId</code> as well.</p>
423
+ * @public
424
+ */
425
+ launchTemplateName?: string;
426
+ /**
427
+ * <p>The version number of the launch template,
428
+ * <code>$Default</code>, or <code>$Latest</code>.</p>
429
+ * <p>If the value is <code>$Default</code>, the default version of the launch template is used. If the value is <code>$Latest</code>, the latest version of the launch template is used. </p>
430
+ * <important>
431
+ * <p>If the AMI ID that's used in a compute environment is from the launch template, the AMI
432
+ * isn't changed when the compute environment is updated. It's only changed if the
433
+ * <code>updateToLatestImageVersion</code> parameter for the compute environment is set to
434
+ * <code>true</code>. During an infrastructure update, if either <code>$Default</code> or <code>$Latest</code> is specified, Batch re-evaluates the launch template version, and it
435
+ * might use a different version of the launch template. This is the case even if the launch
436
+ * template isn't specified in the update. When updating a compute environment, changing the launch
437
+ * template requires an infrastructure update of the compute environment. For more information, see
438
+ * <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute
439
+ * environments</a> in the <i>Batch User Guide</i>.</p>
440
+ * </important>
441
+ * <p>Default: <code>$Default</code>
442
+ * </p>
443
+ * <p>Latest: <code>$Latest</code>
444
+ * </p>
445
+ * @public
446
+ */
447
+ version?: string;
448
+ /**
449
+ * <p>The instance type or family that this this override launch template should be applied to.</p>
450
+ * <p>This parameter is required when defining a launch template override.</p>
451
+ * <p>Information included in this parameter must meet the following requirements:</p>
452
+ * <ul>
453
+ * <li>
454
+ * <p>Must be a valid Amazon EC2 instance type or family.</p>
455
+ * </li>
456
+ * <li>
457
+ * <p>
458
+ * <code>optimal</code> isn't allowed.</p>
459
+ * </li>
460
+ * <li>
461
+ * <p>
462
+ * <code>targetInstanceTypes</code> can target only instance types and families that are included within the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes">
463
+ * <code>ComputeResource.instanceTypes</code>
464
+ * </a> set. <code>targetInstanceTypes</code> doesn't need to include all of the instances from the <code>instanceType</code> set, but at least a subset. For example, if <code>ComputeResource.instanceTypes</code> includes <code>[m5, g5]</code>, <code>targetInstanceTypes</code> can include <code>[m5.2xlarge]</code> and <code>[m5.large]</code> but not <code>[c5.large]</code>.</p>
465
+ * </li>
466
+ * <li>
467
+ * <p>
468
+ * <code>targetInstanceTypes</code> included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.</p>
469
+ * </li>
470
+ * </ul>
471
+ * @public
472
+ */
473
+ targetInstanceTypes?: string[];
474
+ }
395
475
  /**
396
476
  * <p>An object that represents a launch template that's associated with a compute resource. You
397
477
  * must specify either the launch template ID or launch template name in the request, but not
@@ -417,26 +497,37 @@ export interface LaunchTemplateSpecification {
417
497
  */
418
498
  launchTemplateName?: string;
419
499
  /**
420
- * <p>The version number of the launch template, <code>$Latest</code>, or
421
- * <code>$Default</code>.</p>
422
- * <p>If the value is <code>$Latest</code>, the latest version of the launch template is used. If
423
- * the value is <code>$Default</code>, the default version of the launch template is used.</p>
500
+ * <p>The version number of the launch template,
501
+ * <code>$Default</code>, or <code>$Latest</code>.</p>
502
+ * <p>If the value is <code>$Default</code>, the default version of the launch template is used. If the value is <code>$Latest</code>, the latest version of the launch template is used. </p>
424
503
  * <important>
425
504
  * <p>If the AMI ID that's used in a compute environment is from the launch template, the AMI
426
505
  * isn't changed when the compute environment is updated. It's only changed if the
427
506
  * <code>updateToLatestImageVersion</code> parameter for the compute environment is set to
428
- * <code>true</code>. During an infrastructure update, if either <code>$Latest</code> or
429
- * <code>$Default</code> is specified, Batch re-evaluates the launch template version, and it
507
+ * <code>true</code>. During an infrastructure update, if either <code>$Default</code> or
508
+ * <code>$Latest</code> is specified, Batch re-evaluates the launch template version, and it
430
509
  * might use a different version of the launch template. This is the case even if the launch
431
510
  * template isn't specified in the update. When updating a compute environment, changing the launch
432
511
  * template requires an infrastructure update of the compute environment. For more information, see
433
512
  * <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute
434
513
  * environments</a> in the <i>Batch User Guide</i>.</p>
435
514
  * </important>
436
- * <p>Default: <code>$Default</code>.</p>
515
+ * <p>Default: <code>$Default</code>
516
+ * </p>
517
+ * <p>Latest: <code>$Latest</code>
518
+ * </p>
437
519
  * @public
438
520
  */
439
521
  version?: string;
522
+ /**
523
+ * <p>A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.</p>
524
+ * <p>You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.</p>
525
+ * <note>
526
+ * <p>To unset all override templates for a compute environment, you can pass an empty array to the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html">UpdateComputeEnvironment.overrides</a> parameter, or not include the <code>overrides</code> parameter when submitting the <code>UpdateComputeEnvironment</code> API operation.</p>
527
+ * </note>
528
+ * @public
529
+ */
530
+ overrides?: LaunchTemplateSpecificationOverride[];
440
531
  }
441
532
  /**
442
533
  * @public
@@ -84,10 +84,17 @@ export interface Ec2Configuration {
84
84
  imageIdOverride?: string;
85
85
  imageKubernetesVersion?: string;
86
86
  }
87
+ export interface LaunchTemplateSpecificationOverride {
88
+ launchTemplateId?: string;
89
+ launchTemplateName?: string;
90
+ version?: string;
91
+ targetInstanceTypes?: string[];
92
+ }
87
93
  export interface LaunchTemplateSpecification {
88
94
  launchTemplateId?: string;
89
95
  launchTemplateName?: string;
90
96
  version?: string;
97
+ overrides?: LaunchTemplateSpecificationOverride[];
91
98
  }
92
99
  export declare const CRType: {
93
100
  readonly EC2: "EC2";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-batch",
3
3
  "description": "AWS SDK for JavaScript Batch Client for Node.js, Browser and React Native",
4
- "version": "3.686.0",
4
+ "version": "3.688.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-batch",
@@ -20,19 +20,19 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.686.0",
24
- "@aws-sdk/client-sts": "3.686.0",
23
+ "@aws-sdk/client-sso-oidc": "3.687.0",
24
+ "@aws-sdk/client-sts": "3.687.0",
25
25
  "@aws-sdk/core": "3.686.0",
26
- "@aws-sdk/credential-provider-node": "3.686.0",
26
+ "@aws-sdk/credential-provider-node": "3.687.0",
27
27
  "@aws-sdk/middleware-host-header": "3.686.0",
28
28
  "@aws-sdk/middleware-logger": "3.686.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.686.0",
30
- "@aws-sdk/middleware-user-agent": "3.686.0",
30
+ "@aws-sdk/middleware-user-agent": "3.687.0",
31
31
  "@aws-sdk/region-config-resolver": "3.686.0",
32
32
  "@aws-sdk/types": "3.686.0",
33
33
  "@aws-sdk/util-endpoints": "3.686.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.686.0",
35
- "@aws-sdk/util-user-agent-node": "3.686.0",
35
+ "@aws-sdk/util-user-agent-node": "3.687.0",
36
36
  "@smithy/config-resolver": "^3.0.10",
37
37
  "@smithy/core": "^2.5.1",
38
38
  "@smithy/fetch-http-handler": "^4.0.0",