Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ComputeResource = ComputeResource' {
- allocationStrategy :: Maybe CRAllocationStrategy
- bidPercentage :: Maybe Int
- desiredvCpus :: Maybe Int
- ec2Configuration :: Maybe [Ec2Configuration]
- ec2KeyPair :: Maybe Text
- imageId :: Maybe Text
- instanceRole :: Maybe Text
- instanceTypes :: Maybe [Text]
- launchTemplate :: Maybe LaunchTemplateSpecification
- minvCpus :: Maybe Int
- placementGroup :: Maybe Text
- securityGroupIds :: Maybe [Text]
- spotIamFleetRole :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- type' :: CRType
- maxvCpus :: Int
- subnets :: [Text]
- newComputeResource :: CRType -> Int -> ComputeResource
- computeResource_allocationStrategy :: Lens' ComputeResource (Maybe CRAllocationStrategy)
- computeResource_bidPercentage :: Lens' ComputeResource (Maybe Int)
- computeResource_desiredvCpus :: Lens' ComputeResource (Maybe Int)
- computeResource_ec2Configuration :: Lens' ComputeResource (Maybe [Ec2Configuration])
- computeResource_ec2KeyPair :: Lens' ComputeResource (Maybe Text)
- computeResource_imageId :: Lens' ComputeResource (Maybe Text)
- computeResource_instanceRole :: Lens' ComputeResource (Maybe Text)
- computeResource_instanceTypes :: Lens' ComputeResource (Maybe [Text])
- computeResource_launchTemplate :: Lens' ComputeResource (Maybe LaunchTemplateSpecification)
- computeResource_minvCpus :: Lens' ComputeResource (Maybe Int)
- computeResource_placementGroup :: Lens' ComputeResource (Maybe Text)
- computeResource_securityGroupIds :: Lens' ComputeResource (Maybe [Text])
- computeResource_spotIamFleetRole :: Lens' ComputeResource (Maybe Text)
- computeResource_tags :: Lens' ComputeResource (Maybe (HashMap Text Text))
- computeResource_type :: Lens' ComputeResource CRType
- computeResource_maxvCpus :: Lens' ComputeResource Int
- computeResource_subnets :: Lens' ComputeResource [Text]
Documentation
data ComputeResource Source #
An object that represents an Batch compute resource. For more information, see Compute environments in the Batch User Guide.
See: newComputeResource
smart constructor.
ComputeResource' | |
|
Instances
Create a value of ComputeResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allocationStrategy:ComputeResource'
, computeResource_allocationStrategy
- The allocation strategy to use for the compute resource if not enough
instances of the best fitting instance type 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- BEST_FIT (default)
- Batch selects an instance type that best fits the needs of the jobs
with a preference for the lowest-cost instance type. If additional
instances of the selected instance type aren't available, Batch
waits for the additional instances to be available. If there aren't
enough instances available or the user is reaching
Amazon EC2 service limits,
additional jobs aren't run until the currently running jobs are
completed. This allocation strategy keeps costs lower but can limit
scaling. If you're using Spot Fleets with
BEST_FIT
, the Spot Fleet IAM Role must be specified. Compute resources that use aBEST_FIT
allocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide. - 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.
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.
$sel:bidPercentage:ComputeResource'
, computeResource_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%, then 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. If you leave this field empty, the
default value is 100% of the On-Demand price. For most use cases, we
recommend leaving this field empty.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:desiredvCpus:ComputeResource'
, computeResource_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.
$sel:ec2Configuration:ComputeResource'
, computeResource_ec2Configuration
- Provides information that's used to select Amazon Machine Images (AMIs)
for EC2 instances in the compute environment. If Ec2Configuration
isn't specified, the default is ECS_AL2
.
One or two values can be provided.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:ec2KeyPair:ComputeResource'
, computeResource_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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:imageId:ComputeResource'
, computeResource_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.
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.
$sel:instanceRole:ComputeResource'
, computeResource_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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:instanceTypes:ComputeResource'
, computeResource_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.
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.
$sel:launchTemplate:ComputeResource'
, computeResource_launchTemplate
- The launch template to use for your compute resources. Any other compute
resource parameters that you specify in a CreateComputeEnvironment API
operation override the same parameters in the launch template. 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:minvCpus:ComputeResource'
, computeResource_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.
$sel:placementGroup:ComputeResource'
, computeResource_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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:securityGroupIds:ComputeResource'
, computeResource_securityGroupIds
- The Amazon EC2 security groups that are associated with instances
launched in the compute environment. One or more security groups must be
specified, either in securityGroupIds
or using a launch template
referenced in launchTemplate
. This parameter is required for jobs that
are running on Fargate resources and must contain at least one security
group. Fargate doesn't support launch templates. If security groups are
specified using both securityGroupIds
and launchTemplate
, the values
in securityGroupIds
are used.
$sel:spotIamFleetRole:ComputeResource'
, computeResource_spotIamFleetRole
- The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role
applied to a SPOT
compute environment. This role is required if the
allocation strategy set to BEST_FIT
or if the allocation strategy
isn't specified. For more information, see
Amazon EC2 spot fleet role
in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.
$sel:tags:ComputeResource'
, computeResource_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. Updating
these tags requires an infrastructure update to the compute environment.
For more information, see
Updating compute environments
in the Batch User Guide. These tags aren't seen when using the Batch
ListTagsForResource
API operation.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
$sel:type':ComputeResource'
, computeResource_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.
$sel:maxvCpus:ComputeResource'
, computeResource_maxvCpus
- The maximum number of Amazon EC2 vCPUs that a compute 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. For example, no
more than a single instance from among those specified in your compute
environment is allocated.
$sel:subnets:ComputeResource'
, computeResource_subnets
- The VPC subnets where the compute resources are launched. These subnets
must be within the same VPC. Fargate compute resources can contain up to
16 subnets. For more information, see
VPCs and subnets
in the Amazon VPC 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.
computeResource_allocationStrategy :: Lens' ComputeResource (Maybe CRAllocationStrategy) Source #
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- BEST_FIT (default)
- Batch selects an instance type that best fits the needs of the jobs
with a preference for the lowest-cost instance type. If additional
instances of the selected instance type aren't available, Batch
waits for the additional instances to be available. If there aren't
enough instances available or the user is reaching
Amazon EC2 service limits,
additional jobs aren't run until the currently running jobs are
completed. This allocation strategy keeps costs lower but can limit
scaling. If you're using Spot Fleets with
BEST_FIT
, the Spot Fleet IAM Role must be specified. Compute resources that use aBEST_FIT
allocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide. - 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.
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.
computeResource_bidPercentage :: Lens' ComputeResource (Maybe Int) Source #
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%, then 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. If you leave this field empty, the default value is 100% of the On-Demand price. For most use cases, we recommend leaving this field empty.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
computeResource_desiredvCpus :: Lens' ComputeResource (Maybe Int) Source #
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.
computeResource_ec2Configuration :: Lens' ComputeResource (Maybe [Ec2Configuration]) Source #
Provides information that's used to select Amazon Machine Images (AMIs)
for EC2 instances in the compute environment. If Ec2Configuration
isn't specified, the default is ECS_AL2
.
One or two values can be provided.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
computeResource_ec2KeyPair :: Lens' ComputeResource (Maybe Text) Source #
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
computeResource_imageId :: Lens' ComputeResource (Maybe Text) Source #
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.
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.
computeResource_instanceRole :: Lens' ComputeResource (Maybe Text) Source #
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
computeResource_instanceTypes :: Lens' ComputeResource (Maybe [Text]) Source #
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.
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.
computeResource_launchTemplate :: Lens' ComputeResource (Maybe LaunchTemplateSpecification) Source #
The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
computeResource_minvCpus :: Lens' ComputeResource (Maybe Int) Source #
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.
computeResource_placementGroup :: Lens' ComputeResource (Maybe Text) Source #
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
computeResource_securityGroupIds :: Lens' ComputeResource (Maybe [Text]) Source #
The Amazon EC2 security groups that are associated with instances
launched in the compute environment. One or more security groups must be
specified, either in securityGroupIds
or using a launch template
referenced in launchTemplate
. This parameter is required for jobs that
are running on Fargate resources and must contain at least one security
group. Fargate doesn't support launch templates. If security groups are
specified using both securityGroupIds
and launchTemplate
, the values
in securityGroupIds
are used.
computeResource_spotIamFleetRole :: Lens' ComputeResource (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role
applied to a SPOT
compute environment. This role is required if the
allocation strategy set to BEST_FIT
or if the allocation strategy
isn't specified. For more information, see
Amazon EC2 spot fleet role
in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.
computeResource_tags :: Lens' ComputeResource (Maybe (HashMap Text Text)) Source #
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. Updating
these tags requires an infrastructure update to the compute environment.
For more information, see
Updating compute environments
in the Batch User Guide. These tags aren't seen when using the Batch
ListTagsForResource
API operation.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
computeResource_type :: Lens' ComputeResource CRType Source #
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.
computeResource_maxvCpus :: Lens' ComputeResource Int Source #
The maximum number of Amazon EC2 vCPUs that a compute 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. For example, no
more than a single instance from among those specified in your compute
environment is allocated.
computeResource_subnets :: Lens' ComputeResource [Text] Source #
The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC 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.