public static interface ComputeResourceUpdate.Builder extends SdkPojo, CopyableBuilder<ComputeResourceUpdate.Builder,ComputeResourceUpdate>
Modifier and Type | Method and Description |
---|---|
ComputeResourceUpdate.Builder |
allocationStrategy(CRUpdateAllocationStrategy 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.
|
ComputeResourceUpdate.Builder |
allocationStrategy(String 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.
|
ComputeResourceUpdate.Builder |
bidPercentage(Integer 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.
|
ComputeResourceUpdate.Builder |
desiredvCpus(Integer desiredvCpus)
The desired number of Amazon EC2 vCPUS in the compute environment.
|
ComputeResourceUpdate.Builder |
ec2Configuration(Collection<Ec2Configuration> ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
environment.
|
ComputeResourceUpdate.Builder |
ec2Configuration(Consumer<Ec2Configuration.Builder>... ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
environment.
|
ComputeResourceUpdate.Builder |
ec2Configuration(Ec2Configuration... ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
environment.
|
ComputeResourceUpdate.Builder |
ec2KeyPair(String ec2KeyPair)
The Amazon EC2 key pair that's used for instances launched in the compute environment.
|
ComputeResourceUpdate.Builder |
imageId(String imageId)
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
|
ComputeResourceUpdate.Builder |
instanceRole(String instanceRole)
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
|
ComputeResourceUpdate.Builder |
instanceTypes(Collection<String> instanceTypes)
The instances types that can be launched.
|
ComputeResourceUpdate.Builder |
instanceTypes(String... instanceTypes)
The instances types that can be launched.
|
default ComputeResourceUpdate.Builder |
launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)
The updated launch template to use for your compute resources.
|
ComputeResourceUpdate.Builder |
launchTemplate(LaunchTemplateSpecification launchTemplate)
The updated launch template to use for your compute resources.
|
ComputeResourceUpdate.Builder |
maxvCpus(Integer maxvCpus)
The maximum number of Amazon EC2 vCPUs that an environment can reach.
|
ComputeResourceUpdate.Builder |
minvCpus(Integer minvCpus)
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment
is
DISABLED ). |
ComputeResourceUpdate.Builder |
placementGroup(String placementGroup)
The Amazon EC2 placement group to associate with your compute resources.
|
ComputeResourceUpdate.Builder |
securityGroupIds(Collection<String> securityGroupIds)
The Amazon EC2 security groups that are associated with instances launched in the compute environment.
|
ComputeResourceUpdate.Builder |
securityGroupIds(String... securityGroupIds)
The Amazon EC2 security groups that are associated with instances launched in the compute environment.
|
ComputeResourceUpdate.Builder |
subnets(Collection<String> subnets)
The VPC subnets where the compute resources are launched.
|
ComputeResourceUpdate.Builder |
subnets(String... subnets)
The VPC subnets where the compute resources are launched.
|
ComputeResourceUpdate.Builder |
tags(Map<String,String> tags)
Key-value pair tags to be applied to EC2 resources that are launched in the compute environment.
|
ComputeResourceUpdate.Builder |
type(CRType type)
The type of compute environment:
EC2 , SPOT , FARGATE , or
FARGATE_SPOT . |
ComputeResourceUpdate.Builder |
type(String type)
The type of compute environment:
EC2 , SPOT , FARGATE , or
FARGATE_SPOT . |
ComputeResourceUpdate.Builder |
updateToLatestImageVersion(Boolean 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.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
ComputeResourceUpdate.Builder minvCpus(Integer minvCpus)
The minimum number of Amazon EC2 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.
minvCpus
- The minimum number of Amazon EC2 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.
ComputeResourceUpdate.Builder maxvCpus(Integer maxvCpus)
The maximum number of Amazon EC2 vCPUs that an environment can reach.
With both BEST_FIT_PROGRESSIVE
and SPOT_CAPACITY_OPTIMIZED
allocation 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. That is, no more than a single instance from among
those specified in your compute environment.
maxvCpus
- The maximum number of Amazon EC2 vCPUs that an environment can reach.
With both BEST_FIT_PROGRESSIVE
and SPOT_CAPACITY_OPTIMIZED
allocation
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. That is, no more
than a single instance from among those specified in your compute environment.
ComputeResourceUpdate.Builder desiredvCpus(Integer desiredvCpus)
The desired number of Amazon EC2 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.
desiredvCpus
- The desired number of Amazon EC2 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.
ComputeResourceUpdate.Builder subnets(Collection<String> 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 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.
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 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.
ComputeResourceUpdate.Builder subnets(String... 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 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.
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 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.
ComputeResourceUpdate.Builder securityGroupIds(Collection<String> 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 EC2 compute resources, providing an empty list removes the security groups from the compute resource.
When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
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 EC2 compute resources, providing an empty list removes the
security groups from the compute resource.
When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
ComputeResourceUpdate.Builder securityGroupIds(String... 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 EC2 compute resources, providing an empty list removes the security groups from the compute resource.
When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
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 EC2 compute resources, providing an empty list removes the
security groups from the compute resource.
When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
ComputeResourceUpdate.Builder allocationStrategy(String 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.
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.
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.
With both BEST_FIT_PROGRESSIVE
and SPOT_CAPACITY_OPTIMIZED
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.
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.
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.
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.
With both BEST_FIT_PROGRESSIVE
and SPOT_CAPACITY_OPTIMIZED
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.
CRUpdateAllocationStrategy
,
CRUpdateAllocationStrategy
ComputeResourceUpdate.Builder allocationStrategy(CRUpdateAllocationStrategy 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.
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.
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.
With both BEST_FIT_PROGRESSIVE
and SPOT_CAPACITY_OPTIMIZED
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.
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.
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.
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.
With both BEST_FIT_PROGRESSIVE
and SPOT_CAPACITY_OPTIMIZED
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.
CRUpdateAllocationStrategy
,
CRUpdateAllocationStrategy
ComputeResourceUpdate.Builder instanceTypes(Collection<String> instanceTypes)
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.
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.
instanceTypes
- 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.
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.
ComputeResourceUpdate.Builder instanceTypes(String... instanceTypes)
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.
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.
instanceTypes
- 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.
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.
ComputeResourceUpdate.Builder ec2KeyPair(String 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 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.
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 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.
ComputeResourceUpdate.Builder instanceRole(String instanceRole)
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. 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.
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. 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
ComputeResourceUpdate.Builder tags(Map<String,String> tags)
Key-value pair tags to be applied to 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
tags
- Key-value pair tags to be applied to 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
ComputeResourceUpdate.Builder placementGroup(String 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.
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.
ComputeResourceUpdate.Builder bidPercentage(Integer 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.
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.
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.
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.
ComputeResourceUpdate.Builder launchTemplate(LaunchTemplateSpecification 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
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.
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
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
default ComputeResourceUpdate.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> 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
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
LaunchTemplateSpecification.Builder
avoiding the need to create one manually via
LaunchTemplateSpecification.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to launchTemplate(LaunchTemplateSpecification)
.
launchTemplate
- a consumer that will call methods on LaunchTemplateSpecification.Builder
launchTemplate(LaunchTemplateSpecification)
ComputeResourceUpdate.Builder ec2Configuration(Collection<Ec2Configuration> ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for 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 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.
ec2Configuration
- Provides information used to select Amazon Machine Images (AMIs) for 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 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.
ComputeResourceUpdate.Builder ec2Configuration(Ec2Configuration... ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for 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 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.
ec2Configuration
- Provides information used to select Amazon Machine Images (AMIs) for 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 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.
ComputeResourceUpdate.Builder ec2Configuration(Consumer<Ec2Configuration.Builder>... ec2Configuration)
Provides information used to select Amazon Machine Images (AMIs) for 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 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.
Ec2Configuration.Builder
avoiding the need to create one
manually via Ec2Configuration.builder()
.
When the Consumer
completes,
SdkBuilder.build()
is called immediately
and its result is passed to #ec2Configuration(List
.
ec2Configuration
- a consumer that will call methods on
Ec2Configuration.Builder
#ec2Configuration(java.util.Collection)
ComputeResourceUpdate.Builder updateToLatestImageVersion(Boolean 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
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.
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.
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
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.
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.
ComputeResourceUpdate.Builder type(String type)
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.
type
- 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.
CRType
,
CRType
ComputeResourceUpdate.Builder type(CRType type)
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.
type
- 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.
CRType
,
CRType
ComputeResourceUpdate.Builder imageId(String imageId)
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.
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.
imageId
- 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.
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.
Copyright © 2022. All rights reserved.