Class: Aws::Batch::Types::ComputeResourceUpdate

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-batch/types.rb

Overview

An object that represents the attributes of a compute environment that can be updated. For more information, see [Updating compute environments] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_strategy ⇒ String

The allocation strategy to use for the compute resource if there’s not enough instances of the best fitting instance type that can be allocated. This might be because of availability of the instance type in the Region or [Amazon EC2 service limits]. For more information, see [Allocation strategies] in the *Batch User Guide*.

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*. ‘BEST_FIT` isn’t supported when updating a compute environment.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

BEST_FIT_PROGRESSIVE

: Batch selects additional instance types that are large enough to

meet the requirements of the jobs in the queue. Its preference is
for instance types with lower cost vCPUs. If additional instances
of the previously selected instance types aren't available, Batch
selects new instance types.

SPOT_CAPACITY_OPTIMIZED

: Batch selects one or more instance types that are large enough to

meet the requirements of the jobs in the queue. Its preference is
for instance types that are less likely to be interrupted. This
allocation strategy is only available for Spot Instance compute
resources.

SPOT_PRICE_CAPACITY_OPTIMIZED

: The price and capacity optimized allocation strategy looks at both

price and capacity to select the Spot Instance pools that are the
least likely to be interrupted and have the lowest possible price.
This allocation strategy is only available for Spot Instance
compute resources.

With ‘BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot Instances, Batch might need to exceed `maxvCpus` to meet your capacity requirements. In this event, Batch never exceeds `maxvCpus` by more than a single instance.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html [2]: docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html [3]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#bid_percentage ⇒ Integer

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. For most use cases, we recommend leaving this field empty.

When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (Integer) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#desiredv_cpus ⇒ Integer

The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

<note markdown=“1”> Batch doesn’t support changing the desired number of vCPUs of an existing compute environment. Don’t specify this parameter for compute environments using Amazon EKS clusters.

</note>

<note markdown=“1”> When you update the ‘desiredvCpus` setting, the value must be between the `minvCpus` and `maxvCpus` values.

Additionally, the updated `desiredvCpus` value must be greater than

or equal to the current ‘desiredvCpus` value. For more information, see [Troubleshooting Batch] in the *Batch User Guide*.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update

Returns:

  • (Integer) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_configuration ⇒ Array<Types::Ec2Configuration>

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If ‘Ec2Configuration` isn’t specified, the default is ‘ECS_AL2`.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*. To remove the Amazon EC2 configuration and any custom AMI ID specified in ‘imageIdOverride`, set this value to an empty string.

One or two values can be provided.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_key_pair ⇒ String

The Amazon EC2 key pair that’s used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

When updating a compute environment, changing the Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ String

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the ‘imageIdOverride` member of the `Ec2Configuration` structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

<note markdown=“1”> The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see [Amazon ECS-optimized Amazon Linux 2 AMI] in the *Amazon Elastic Container Service Developer Guide*.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_role ⇒ String

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. Required for Amazon EC2 instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ‘ ecsInstanceRole ` or `arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole `. For more information, see [Amazon ECS instance role] in the *Batch User Guide*.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html [2]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_types ⇒ Array<String>

The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, ‘c5` or `p3`), or you can specify specific sizes within a family (such as `c5.8xlarge`). You can also choose `optimal` to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

<note markdown=“1”> When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can’t mix x86 and ARM instances in the same compute environment.

</note>

<note markdown=“1”> Currently, ‘optimal` uses instance types from the C4, M4, and R4 instance families. In Regions that don’t have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (Array<String>) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#launch_template ⇒ Types::LaunchTemplateSpecification

The updated launch template to use for your compute resources. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see [Launch template support] in the *Batch User Guide*. To remove the custom launch template and use the default launch template, set ‘launchTemplateId` or `launchTemplateName` member of the launch template specification to an empty string. Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the `updateToLatestImageVersion` parameter must be set to `true`.

When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/launch-templates.html [2]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#maxv_cpus ⇒ Integer

The maximum number of Amazon EC2 vCPUs that an environment can reach.

<note markdown=“1”> With ‘BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot Instances, Batch might need to exceed `maxvCpus` to meet your capacity requirements. In this event, Batch never exceeds `maxvCpus` by more than a single instance.

</note>

Returns:

  • (Integer) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#minv_cpus ⇒ Integer

The minimum number of vCPUs that an environment should maintain (even if the compute environment is ‘DISABLED`).

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

Returns:

  • (Integer) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#placement_group ⇒ String

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see [Placement groups] in the *Amazon EC2 User Guide for Linux Instances*.

When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html [2]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

The Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn’t specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the security groups from the compute resource.

When updating a compute environment, changing the Amazon EC2 security groups requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (Array<String>) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#subnets ⇒ Array<String>

The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn’t specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see [VPCs and subnets] in the *Amazon VPC User Guide*.

When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see [ Local Zones] in the *Amazon EC2 User Guide for Linux Instances*, [Amazon EKS and Amazon Web Services Local Zones] in the *Amazon EKS User Guide* and [ Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts] in the *Amazon ECS Developer Guide*.

Batch on Fargate doesn't currently support Local Zones.

</note>

[1]: docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html [2]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones [4]: docs.aws.amazon.com/eks/latest/userguide/local-zones.html [5]: docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones

Returns:

  • (Array<String>) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (Hash<String,String>) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of compute environment: ‘EC2`, `SPOT`, `FARGATE`, or `FARGATE_SPOT`. For more information, see [Compute environments] in the *Batch User Guide*.

If you choose ‘SPOT`, you must also specify an Amazon EC2 Spot Fleet role with the `spotIamFleetRole` parameter. For more information, see [Amazon EC2 spot fleet role] in the *Batch User Guide*.

When updating a compute environment, changing the type of a compute environment requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/compute_environments.html [2]: docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html [3]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#update_to_latest_image_version ⇒ Boolean

Specifies whether the AMI ID is updated to the latest one that’s supported by Batch when the compute environment has an infrastructure update. The default value is ‘false`.

<note markdown=“1”> An AMI ID can either be specified in the ‘imageId` or `imageIdOverride` parameters or be determined by the launch template that’s specified in the ‘launchTemplate` parameter. If an AMI ID is specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an infrastructure update, see [Updating the AMI ID] in the *Batch User Guide*.

</note>

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami [2]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (Boolean) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/aws-sdk-batch/types.rb', line 1301

class ComputeResourceUpdate < Struct.new(
  :minv_cpus,
  :maxv_cpus,
  :desiredv_cpus,
  :subnets,
  :security_group_ids,
  :allocation_strategy,
  :instance_types,
  :ec2_key_pair,
  :instance_role,
  :tags,
  :placement_group,
  :bid_percentage,
  :launch_template,
  :ec2_configuration,
  :update_to_latest_image_version,
  :type,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end