Class ComputeResourceUpdate
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ComputeResourceUpdate.Builder,
ComputeResourceUpdate>
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe allocation strategy to use for the compute resource if there's not enough instances of the best fitting instance type that can be allocated.final 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.final 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.builder()
final Integer
The desired number of vCPUS in the compute environment.final List
<Ec2Configuration> Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment.final String
The Amazon EC2 key pair that's used for instances launched in the compute environment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Ec2Configuration property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceTypes property.final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final boolean
For responses, this returns true if the service returned a value for the Subnets property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
imageId()
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.final String
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.The instances types that can be launched.The updated launch template to use for your compute resources.final Integer
maxvCpus()
The maximum number of Amazon EC2 vCPUs that an environment can reach.final Integer
minvCpus()
The minimum number of vCPUs that an environment should maintain (even if the compute environment isDISABLED
).final String
The Amazon EC2 placement group to associate with your compute resources.The Amazon EC2 security groups that are associated with instances launched in the compute environment.static Class
<? extends ComputeResourceUpdate.Builder> subnets()
The VPC subnets where the compute resources are launched.tags()
Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute environment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final CRType
type()
The type of compute environment:EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
.final String
The type of compute environment:EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
.final 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
minvCpus
The minimum number of vCPUs that an environment should maintain (even if the compute environment is
DISABLED
).This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Returns:
- The minimum number of vCPUs that an environment should maintain (even if the compute environment is
DISABLED
).This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
-
maxvCpus
The maximum number of Amazon EC2 vCPUs that an environment can reach.
With
BEST_FIT_PROGRESSIVE
,SPOT_CAPACITY_OPTIMIZED
andSPOT_PRICE_CAPACITY_OPTIMIZED
(recommended) strategies using On-Demand or Spot Instances, and theBEST_FIT
strategy using Spot Instances, Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, Batch never exceedsmaxvCpus
by more than a single instance.- Returns:
- The maximum number of Amazon EC2 vCPUs that an environment can reach.
With
BEST_FIT_PROGRESSIVE
,SPOT_CAPACITY_OPTIMIZED
andSPOT_PRICE_CAPACITY_OPTIMIZED
(recommended) strategies using On-Demand or Spot Instances, and theBEST_FIT
strategy using Spot Instances, Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, Batch never exceedsmaxvCpus
by more than a single instance.
-
desiredvCpus
The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
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.
When you update the
desiredvCpus
setting, the value must be between theminvCpus
andmaxvCpus
values.Additionally, the updated
desiredvCpus
value must be greater than or equal to the currentdesiredvCpus
value. For more information, see Troubleshooting Batch in the Batch User Guide.- Returns:
- The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and
maximum values based on job queue demand.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
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.
When you update the
desiredvCpus
setting, the value must be between theminvCpus
andmaxvCpus
values.Additionally, the updated
desiredvCpus
value must be greater than or equal to the currentdesiredvCpus
value. For more information, see Troubleshooting Batch in the Batch User Guide.
-
hasSubnets
public final boolean hasSubnets()For responses, this returns true if the service returned a value for the Subnets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
subnets
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.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubnets()
method.- Returns:
- 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.
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.
-
hasSecurityGroupIds
public final boolean hasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
securityGroupIds
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecurityGroupIds()
method.- Returns:
- 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.
-
allocationStrategy
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.This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- 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
andSPOT_PRICE_CAPACITY_OPTIMIZED
(recommended) strategies using On-Demand or Spot Instances, and theBEST_FIT
strategy using Spot Instances, Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, Batch never exceedsmaxvCpus
by more than a single instance.If the service returns an enum value that is not available in the current SDK version,
allocationStrategy
will returnCRUpdateAllocationStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromallocationStrategyAsString()
.- Returns:
- 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.This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- 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
andSPOT_PRICE_CAPACITY_OPTIMIZED
(recommended) strategies using On-Demand or Spot Instances, and theBEST_FIT
strategy using Spot Instances, Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, Batch never exceedsmaxvCpus
by more than a single instance. - See Also:
-
allocationStrategyAsString
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.This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- 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
andSPOT_PRICE_CAPACITY_OPTIMIZED
(recommended) strategies using On-Demand or Spot Instances, and theBEST_FIT
strategy using Spot Instances, Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, Batch never exceedsmaxvCpus
by more than a single instance.If the service returns an enum value that is not available in the current SDK version,
allocationStrategy
will returnCRUpdateAllocationStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromallocationStrategyAsString()
.- Returns:
- 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.This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- 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
andSPOT_PRICE_CAPACITY_OPTIMIZED
(recommended) strategies using On-Demand or Spot Instances, and theBEST_FIT
strategy using Spot Instances, Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, Batch never exceedsmaxvCpus
by more than a single instance. - See Also:
-
hasInstanceTypes
public final boolean hasInstanceTypes()For responses, this returns true if the service returned a value for the InstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
instanceTypes
The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example,
c5
orp3
), or you can specify specific sizes within a family (such asc5.8xlarge
). You can also chooseoptimal
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
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.
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInstanceTypes()
method.- Returns:
- The instances types that can be launched. You can specify instance families to launch any instance type
within those families (for example,
c5
orp3
), or you can specify specific sizes within a family (such asc5.8xlarge
). You can also chooseoptimal
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
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.
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.
-
ec2KeyPair
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Returns:
- 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
-
instanceRole
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
orarn: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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Returns:
- 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
orarn: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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
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"
, whereString1
is the tag key andString2
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 BatchListTagsForResource
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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"
, whereString1
is the tag key andString2
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 BatchListTagsForResource
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
-
placementGroup
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Returns:
- 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
-
bidPercentage
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Returns:
- 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
-
launchTemplate
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
orlaunchTemplateName
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, theupdateToLatestImageVersion
parameter must be set totrue
.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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Returns:
- 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
orlaunchTemplateName
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, theupdateToLatestImageVersion
parameter must be set totrue
.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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
-
hasEc2Configuration
public final boolean hasEc2Configuration()For responses, this returns true if the service returned a value for the Ec2Configuration property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 isECS_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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEc2Configuration()
method.- Returns:
- Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute
environment. If
Ec2Configuration
isn't specified, the default isECS_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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
-
updateToLatestImageVersion
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
.An AMI ID can either be specified in the
imageId
orimageIdOverride
parameters or be determined by the launch template that's specified in thelaunchTemplate
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.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.
- Returns:
- 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
.An AMI ID can either be specified in the
imageId
orimageIdOverride
parameters or be determined by the launch template that's specified in thelaunchTemplate
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.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.
-
type
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_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 thespotIamFleetRole
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.
If the service returns an enum value that is not available in the current SDK version,
type
will returnCRType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_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 thespotIamFleetRole
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.
- See Also:
-
typeAsString
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_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 thespotIamFleetRole
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.
If the service returns an enum value that is not available in the current SDK version,
type
will returnCRType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_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 thespotIamFleetRole
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.
- See Also:
-
imageId
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the
imageIdOverride
member of theEc2Configuration
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
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.
- Returns:
- The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter
is overridden by the
imageIdOverride
member of theEc2Configuration
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ComputeResourceUpdate.Builder,
ComputeResourceUpdate> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-