aws-sdk-batch 1.103.0 → 1.105.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a49e29e82e8c1c140648a871af3a4eadc5a3ffe4869a0557521c41e433c1a996
-  data.tar.gz: '09477a4ef0619fed6dbfe16f55d31751e1587553e38d5f66a367bc3138eb165b'
+  metadata.gz: 0d8335f038a725dd0cb8a14fb5e05ec020df31f4efdb3b8758d123952f05d7a2
+  data.tar.gz: 8d3914d19a2ff35392b2a9c57a9db7ebf0cb52b94978c6d644cd3ed1a93c61c6
 SHA512:
-  metadata.gz: 162f96beb7e6eb3e801c3de9e5582ccae382ca67dba8dbe6aaed9a9bbf8536820ac9c2224f8c89084f1efd196a765d0073139303c7946aef77b8ae5a350a5fd5
-  data.tar.gz: c47b9b65699eb3419e17f868c7c18eff430a0e59bb9102dbc967d42cb2a4ecf9f8ce02308c23a06a6c0d1ee44e732510dfe133e0a4aa0d41a5a4432f736f3e24
+  metadata.gz: eaf8cccfdc0fe084493e82e8244b4635dfbc55c44295db0761caa60092a6fd117be5f2a4a4067e29222b74be091e5967883fc8b9b02561c79c68fbf3a0417ade
+  data.tar.gz: 6535d1de5fc18233731aa52307ac5e3f4b5ebc80e85e97a781a2b973068b62c702490cbb84966e32ee88568bcd0e16391416d219b64c1569bdc2ea497379e969

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.105.0 (2024-11-08)
+------------------
+
+* Feature - This feature allows override LaunchTemplates to be specified in an AWS Batch Compute Environment.
+
+1.104.0 (2024-11-06)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.103.0 (2024-10-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.103.0
+1.105.0

data/lib/aws-sdk-batch/client.rb

@@ -859,6 +859,14 @@ module Aws::Batch
     #         launch_template_id: "String",
     #         launch_template_name: "String",
     #         version: "String",
+    #         overrides: [
+    #           {
+    #             launch_template_id: "String",
+    #             launch_template_name: "String",
+    #             version: "String",
+    #             target_instance_types: ["String"],
+    #           },
+    #         ],
     #       },
     #       ec2_configuration: [
     #         {
@@ -1413,6 +1421,12 @@ module Aws::Batch
     #   resp.compute_environments[0].compute_resources.launch_template.launch_template_id #=> String
     #   resp.compute_environments[0].compute_resources.launch_template.launch_template_name #=> String
     #   resp.compute_environments[0].compute_resources.launch_template.version #=> String
+    #   resp.compute_environments[0].compute_resources.launch_template.overrides #=> Array
+    #   resp.compute_environments[0].compute_resources.launch_template.overrides[0].launch_template_id #=> String
+    #   resp.compute_environments[0].compute_resources.launch_template.overrides[0].launch_template_name #=> String
+    #   resp.compute_environments[0].compute_resources.launch_template.overrides[0].version #=> String
+    #   resp.compute_environments[0].compute_resources.launch_template.overrides[0].target_instance_types #=> Array
+    #   resp.compute_environments[0].compute_resources.launch_template.overrides[0].target_instance_types[0] #=> String
     #   resp.compute_environments[0].compute_resources.ec2_configuration #=> Array
     #   resp.compute_environments[0].compute_resources.ec2_configuration[0].image_type #=> String
     #   resp.compute_environments[0].compute_resources.ec2_configuration[0].image_id_override #=> String
@@ -1442,10 +1456,9 @@ module Aws::Batch
     # @option params [Array<String>] :job_definitions
     #   A list of up to 100 job definitions. Each entry in the list can either
     #   be an ARN in the format
-    #   `arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`
-    #   or a short version using the form
-    #   `$\{JobDefinitionName\}:$\{Revision\}`. This parameter can't be used
-    #   with other parameters.
+    #   `arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}`
+    #   or a short version using the form `${JobDefinitionName}:${Revision}`.
+    #   This parameter can't be used with other parameters.
     #
     # @option params [Integer] :max_results
     #   The maximum number of results returned by `DescribeJobDefinitions` in
@@ -2827,7 +2840,7 @@ module Aws::Batch
     #     the job definition that's used doesn't affect the sort order. When
     #     the `JOB_DEFINITION` filter is used and the ARN is used (which is in
     #     the form
-    #     `arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`),
+    #     `arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}`),
     #     the results include jobs that used the specified revision of the job
     #     definition. Asterisk (*) isn't supported when the ARN is used.
     #
@@ -4723,6 +4736,14 @@ module Aws::Batch
     #         launch_template_id: "String",
     #         launch_template_name: "String",
     #         version: "String",
+    #         overrides: [
+    #           {
+    #             launch_template_id: "String",
+    #             launch_template_name: "String",
+    #             version: "String",
+    #             target_instance_types: ["String"],
+    #           },
+    #         ],
     #       },
     #       ec2_configuration: [
     #         {
@@ -4920,7 +4941,7 @@ module Aws::Batch
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-batch'
-      context[:gem_version] = '1.103.0'
+      context[:gem_version] = '1.105.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-batch/client_api.rb

@@ -158,6 +158,8 @@ module Aws::Batch
     KeyValuesPair = Shapes::StructureShape.new(name: 'KeyValuesPair')
     KubernetesVersion = Shapes::StringShape.new(name: 'KubernetesVersion')
     LaunchTemplateSpecification = Shapes::StructureShape.new(name: 'LaunchTemplateSpecification')
+    LaunchTemplateSpecificationOverride = Shapes::StructureShape.new(name: 'LaunchTemplateSpecificationOverride')
+    LaunchTemplateSpecificationOverrideList = Shapes::ListShape.new(name: 'LaunchTemplateSpecificationOverrideList')
     LinuxParameters = Shapes::StructureShape.new(name: 'LinuxParameters')
     ListAttemptEcsTaskDetails = Shapes::ListShape.new(name: 'ListAttemptEcsTaskDetails')
     ListAttemptTaskContainerDetails = Shapes::ListShape.new(name: 'ListAttemptTaskContainerDetails')
@@ -908,8 +910,17 @@ module Aws::Batch
     LaunchTemplateSpecification.add_member(:launch_template_id, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateId"))
     LaunchTemplateSpecification.add_member(:launch_template_name, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateName"))
     LaunchTemplateSpecification.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
+    LaunchTemplateSpecification.add_member(:overrides, Shapes::ShapeRef.new(shape: LaunchTemplateSpecificationOverrideList, location_name: "overrides"))
     LaunchTemplateSpecification.struct_class = Types::LaunchTemplateSpecification
 
+    LaunchTemplateSpecificationOverride.add_member(:launch_template_id, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateId"))
+    LaunchTemplateSpecificationOverride.add_member(:launch_template_name, Shapes::ShapeRef.new(shape: String, location_name: "launchTemplateName"))
+    LaunchTemplateSpecificationOverride.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
+    LaunchTemplateSpecificationOverride.add_member(:target_instance_types, Shapes::ShapeRef.new(shape: StringList, location_name: "targetInstanceTypes"))
+    LaunchTemplateSpecificationOverride.struct_class = Types::LaunchTemplateSpecificationOverride
+
+    LaunchTemplateSpecificationOverrideList.member = Shapes::ShapeRef.new(shape: LaunchTemplateSpecificationOverride)
+
     LinuxParameters.add_member(:devices, Shapes::ShapeRef.new(shape: DevicesList, location_name: "devices"))
     LinuxParameters.add_member(:init_process_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "initProcessEnabled"))
     LinuxParameters.add_member(:shared_memory_size, Shapes::ShapeRef.new(shape: Integer, location_name: "sharedMemorySize"))

data/lib/aws-sdk-batch/types.rb

@@ -704,9 +704,9 @@ module Aws::Batch
     #   Key-value pair tags to be applied to Amazon EC2 resources that are
     #   launched in the compute environment. For Batch, these take the form
     #   of `"String1": "String2"`, where `String1` is the tag key and
-    #   `String2` is the tag value-for example, `\{ "Name": "Batch Instance
-    #   - C4OnDemand" \}`. This is helpful for recognizing your Batch
-    #   instances in the Amazon EC2 console. Updating these tags requires an
+    #   `String2` is the tag value-for example, `{ "Name": "Batch Instance -
+    #   C4OnDemand" }`. This is helpful for recognizing your Batch instances
+    #   in the Amazon EC2 console. Updating these tags requires an
     #   infrastructure update to the compute environment. For more
     #   information, see [Updating compute environments][1] in the *Batch
     #   User Guide*. These tags aren't seen when using the Batch
@@ -1100,10 +1100,10 @@ module Aws::Batch
     #   Key-value pair tags to be applied to Amazon EC2 resources that are
     #   launched in the compute environment. For Batch, these take the form
     #   of `"String1": "String2"`, where `String1` is the tag key and
-    #   `String2` is the tag value-for example, `\{ "Name": "Batch Instance
-    #   - C4OnDemand" \}`. This is helpful for recognizing your Batch
-    #   instances in the Amazon EC2 console. These tags aren't seen when
-    #   using the Batch `ListTagsForResource` API operation.
+    #   `String2` is the tag value-for example, `{ "Name": "Batch Instance -
+    #   C4OnDemand" }`. This is helpful for recognizing your Batch instances
+    #   in the Amazon EC2 console. These tags aren't seen when using the
+    #   Batch `ListTagsForResource` API operation.
     #
     #   When updating a compute environment, changing this setting requires
     #   an infrastructure update of the compute environment. For more
@@ -2574,10 +2574,10 @@ module Aws::Batch
     # @!attribute [rw] job_definitions
     #   A list of up to 100 job definitions. Each entry in the list can
     #   either be an ARN in the format
-    #   `arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`
+    #   `arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}`
     #   or a short version using the form
-    #   `$\{JobDefinitionName\}:$\{Revision\}`. This parameter can't be
-    #   used with other parameters.
+    #   `${JobDefinitionName}:${Revision}`. This parameter can't be used
+    #   with other parameters.
     #   @return [Array<String>]
     #
     # @!attribute [rw] max_results
@@ -5442,17 +5442,17 @@ module Aws::Batch
     #   @return [String]
     #
     # @!attribute [rw] version
-    #   The version number of the launch template, `$Latest`, or `$Default`.
+    #   The version number of the launch template, `$Default`, or `$Latest`.
     #
-    #   If the value is `$Latest`, the latest version of the launch template
-    #   is used. If the value is `$Default`, the default version of the
-    #   launch template is used.
+    #   If the value is `$Default`, the default version of the launch
+    #   template is used. If the value is `$Latest`, the latest version of
+    #   the launch template is used.
     #
     #   If the AMI ID that's used in a compute environment is from the
     #   launch template, the AMI isn't changed when the compute environment
     #   is updated. It's only changed if the `updateToLatestImageVersion`
     #   parameter for the compute environment is set to `true`. During an
-    #   infrastructure update, if either `$Latest` or `$Default` is
+    #   infrastructure update, if either `$Default` or `$Latest` is
     #   specified, Batch re-evaluates the launch template version, and it
     #   might use a different version of the launch template. This is the
     #   case even if the launch template isn't specified in the update.
@@ -5461,19 +5461,156 @@ module Aws::Batch
     #   more information, see [Updating compute environments][1] in the
     #   *Batch User Guide*.
     #
-    #   Default: `$Default`.
+    #   Default: `$Default`
+    #
+    #   Latest: `$Latest`
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
     #   @return [String]
     #
+    # @!attribute [rw] overrides
+    #   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.
+    #
+    #   You can specify up to ten (10) launch template overrides that are
+    #   associated to unique instance types or families for each compute
+    #   environment.
+    #
+    #   <note markdown="1"> To unset all override templates for a compute environment, you can
+    #   pass an empty array to the [UpdateComputeEnvironment.overrides][1]
+    #   parameter, or not include the `overrides` parameter when submitting
+    #   the `UpdateComputeEnvironment` API operation.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html
+    #   @return [Array<Types::LaunchTemplateSpecificationOverride>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/LaunchTemplateSpecification AWS API Documentation
     #
     class LaunchTemplateSpecification < Struct.new(
       :launch_template_id,
       :launch_template_name,
-      :version)
+      :version,
+      :overrides)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # 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 both.
+    #
+    # If security groups are specified using both the `securityGroupIds`
+    # parameter of `CreateComputeEnvironment` and the launch template, the
+    # values in the `securityGroupIds` parameter of
+    # `CreateComputeEnvironment` will be used.
+    #
+    # You can define up to ten (10) overrides for each compute environment.
+    #
+    # <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
+    # resources.
+    #
+    #  </note>
+    #
+    # <note markdown="1"> To unset all override templates for a compute environment, you can
+    # pass an empty array to the [UpdateComputeEnvironment.overrides][1]
+    # parameter, or not include the `overrides` parameter when submitting
+    # the `UpdateComputeEnvironment` API operation.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html
+    #
+    # @!attribute [rw] launch_template_id
+    #   The ID of the launch template.
+    #
+    #   **Note:** If you specify the `launchTemplateId` you can't specify
+    #   the `launchTemplateName` as well.
+    #   @return [String]
+    #
+    # @!attribute [rw] launch_template_name
+    #   The name of the launch template.
+    #
+    #   **Note:** If you specify the `launchTemplateName` you can't specify
+    #   the `launchTemplateId` as well.
+    #   @return [String]
+    #
+    # @!attribute [rw] version
+    #   The version number of the launch template, `$Default`, or `$Latest`.
+    #
+    #   If the value is `$Default`, the default version of the launch
+    #   template is used. If the value is `$Latest`, the latest version of
+    #   the launch template is used.
+    #
+    #   If the AMI ID that's used in a compute environment is from the
+    #   launch template, the AMI isn't changed when the compute environment
+    #   is updated. It's only changed if the `updateToLatestImageVersion`
+    #   parameter for the compute environment is set to `true`. During an
+    #   infrastructure update, if either `$Default` or `$Latest` is
+    #   specified, Batch re-evaluates the launch template version, and it
+    #   might use a different version of the launch template. This is the
+    #   case even if the launch template isn't specified in the update.
+    #   When updating a compute environment, changing the launch template
+    #   requires an infrastructure update of the compute environment. For
+    #   more information, see [Updating compute environments][1] in the
+    #   *Batch User Guide*.
+    #
+    #   Default: `$Default`
+    #
+    #   Latest: `$Latest`
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
+    #   @return [String]
+    #
+    # @!attribute [rw] target_instance_types
+    #   The instance type or family that this this override launch template
+    #   should be applied to.
+    #
+    #   This parameter is required when defining a launch template override.
+    #
+    #   Information included in this parameter must meet the following
+    #   requirements:
+    #
+    #   * Must be a valid Amazon EC2 instance type or family.
+    #
+    #   * `optimal` isn't allowed.
+    #
+    #   * `targetInstanceTypes` can target only instance types and families
+    #     that are included within the [ `ComputeResource.instanceTypes`
+    #     ][1] set. `targetInstanceTypes` doesn't need to include all of
+    #     the instances from the `instanceType` set, but at least a subset.
+    #     For example, if `ComputeResource.instanceTypes` includes `[m5,
+    #     g5]`, `targetInstanceTypes` can include `[m5.2xlarge]` and
+    #     `[m5.large]` but not `[c5.large]`.
+    #
+    #   * `targetInstanceTypes` 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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/LaunchTemplateSpecificationOverride AWS API Documentation
+    #
+    class LaunchTemplateSpecificationOverride < Struct.new(
+      :launch_template_id,
+      :launch_template_name,
+      :version,
+      :target_instance_types)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -5716,7 +5853,7 @@ module Aws::Batch
     #     version of the job definition that's used doesn't affect the
     #     sort order. When the `JOB_DEFINITION` filter is used and the ARN
     #     is used (which is in the form
-    #     `arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`),
+    #     `arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}`),
     #     the results include jobs that used the specified revision of the
     #     job definition. Asterisk (*) isn't supported when the ARN is
     #     used.
@@ -7290,7 +7427,7 @@ module Aws::Batch
     #   greater on your container instance. To check the Docker Remote API
     #   version on your container instance, log in to your container
     #   instance and run the following command: sudo docker version
-    #   `--format '\{\{.Server.APIVersion\}\}'`
+    #   `--format '{{.Server.APIVersion}}'`
     #
     #   <note markdown="1"> The Amazon ECS container agent running on a container instance must
     #   register the logging drivers available on that instance with the
@@ -7406,7 +7543,7 @@ module Aws::Batch
     #   greater on your container instance. To check the Docker Remote API
     #   version on your container instance, log in to your container
     #   instance and run the following command: sudo docker version
-    #   `--format '\{\{.Server.APIVersion\}\}'`
+    #   `--format '{{.Server.APIVersion}}'`
     #
     #   <note markdown="1"> This parameter is not supported for Windows containers.
     #
@@ -7670,7 +7807,7 @@ module Aws::Batch
     #   greater on your container instance. To check the Docker Remote API
     #   version on your container instance, log in to your container
     #   instance and run the following command: sudo docker version
-    #   `--format '\{\{.Server.APIVersion\}\}'`
+    #   `--format '{{.Server.APIVersion}}'`
     #
     #   <note markdown="1"> The Amazon ECS container agent running on a container instance must
     #   register the logging drivers available on that instance with the
@@ -7787,7 +7924,7 @@ module Aws::Batch
     #   greater on your container instance. To check the Docker Remote API
     #   version on your container instance, log in to your container
     #   instance and run the following command: sudo docker version
-    #   `--format '\{\{.Server.APIVersion\}\}'`
+    #   `--format '{{.Server.APIVersion}}'`
     #
     #   <note markdown="1"> This parameter is not supported for Windows containers.
     #

data/lib/aws-sdk-batch.rb

@@ -54,7 +54,7 @@ module Aws::Batch
   autoload :EndpointProvider, 'aws-sdk-batch/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-batch/endpoints'
 
-  GEM_VERSION = '1.103.0'
+  GEM_VERSION = '1.105.0'
 
 end
 

data/sig/client.rbs

@@ -115,7 +115,15 @@ module Aws
                                           launch_template: {
                                             launch_template_id: ::String?,
                                             launch_template_name: ::String?,
-                                            version: ::String?
+                                            version: ::String?,
+                                            overrides: Array[
+                                              {
+                                                launch_template_id: ::String?,
+                                                launch_template_name: ::String?,
+                                                version: ::String?,
+                                                target_instance_types: Array[::String]?
+                                              },
+                                            ]?
                                           }?,
                                           ec2_configuration: Array[
                                             {
@@ -1314,7 +1322,15 @@ module Aws
                                           launch_template: {
                                             launch_template_id: ::String?,
                                             launch_template_name: ::String?,
-                                            version: ::String?
+                                            version: ::String?,
+                                            overrides: Array[
+                                              {
+                                                launch_template_id: ::String?,
+                                                launch_template_name: ::String?,
+                                                version: ::String?,
+                                                target_instance_types: Array[::String]?
+                                              },
+                                            ]?
                                           }?,
                                           ec2_configuration: Array[
                                             {

data/sig/types.rbs

@@ -785,6 +785,15 @@ module Aws::Batch
       attr_accessor launch_template_id: ::String
       attr_accessor launch_template_name: ::String
       attr_accessor version: ::String
+      attr_accessor overrides: ::Array[Types::LaunchTemplateSpecificationOverride]
+      SENSITIVE: []
+    end
+
+    class LaunchTemplateSpecificationOverride
+      attr_accessor launch_template_id: ::String
+      attr_accessor launch_template_name: ::String
+      attr_accessor version: ::String
+      attr_accessor target_instance_types: ::Array[::String]
       SENSITIVE: []
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-batch
 version: !ruby/object:Gem::Version
-  version: 1.103.0
+  version: 1.105.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core