Class CfnComputeEnvironment.ComputeResourcesProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnComputeEnvironment.ComputeResourcesProperty,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnComputeEnvironment.ComputeResourcesProperty
CfnComputeEnvironment.ComputeResourcesProperty-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.CfnComputeEnvironment.ComputeResourcesProperty
CfnComputeEnvironment.ComputeResourcesProperty.Builder, CfnComputeEnvironment.ComputeResourcesProperty.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnComputeEnvironment.ComputeResourcesProperty.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal StringThe allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated.final NumberThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.final NumberThe desired number of vCPUS in the compute environment.final ObjectProvides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment.final StringThe Amazon EC2 key pair that's used for instances launched in the compute environment.final StringThe Amazon Machine Image (AMI) ID used for instances launched in the compute environment.final StringThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.The instances types that can be launched.final ObjectThe launch template to use for your compute resources.final NumberThe maximum number of Amazon EC2 vCPUs that an environment can reach.final NumberThe minimum number of vCPUs that an environment should maintain (even if the compute environment isDISABLED).final StringThe 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.final StringThe Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to aSPOTcompute environment.The VPC subnets where the compute resources are launched.getTags()Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute environment.final StringgetType()The type of compute environment:EC2,SPOT,FARGATE, orFARGATE_SPOT.final ObjectSpecifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnComputeEnvironment.ComputeResourcesProperty.Builder.
-
-
Method Details
-
getMaxvCpus
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe maximum number of Amazon EC2 vCPUs that an environment can reach.With
BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZEDandSPOT_PRICE_CAPACITY_OPTIMIZED(recommended) strategies using On-Demand or Spot Instances, and theBEST_FITstrategy using Spot Instances, AWS Batch might need to exceedmaxvCpusto meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpusby more than a single instance.- Specified by:
getMaxvCpusin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getSubnets
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe 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 AWS Batch User Guide .
AWS Batch on Amazon EC2 and AWS 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 AWS Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and AWS Outposts in the Amazon ECS Developer Guide .
AWS Batch on Fargate doesn't currently support Local Zones.
- Specified by:
getSubnetsin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getType
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe type of compute environment:EC2,SPOT,FARGATE, orFARGATE_SPOT.For more information, see Compute environments in the AWS Batch User Guide .
If you choose
SPOT, you must also specify an Amazon EC2 Spot Fleet role with thespotIamFleetRoleparameter. For more information, see Amazon EC2 spot fleet role in the AWS Batch User Guide .When updating 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 AWS Batch User Guide .
When updating the type of a compute environment, changing between
EC2andSPOTor betweenFARGATEandFARGATE_SPOTwill initiate an infrastructure update, but if you switch betweenEC2andFARGATE, AWS CloudFormation will create a new compute environment.- Specified by:
getTypein interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getAllocationStrategy
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe 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 AWS 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 AWS Batch User Guide .
BEST_FITis not supported when updating a compute environment.This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
- BEST_FIT (default) - AWS 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, AWS Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching Amazon EC2 service limits then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with
BEST_FITthen the Spot Fleet IAM role must be specified. - BEST_FIT_PROGRESSIVE - AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED - AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference 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.
We recommend that you use
SPOT_PRICE_CAPACITY_OPTIMIZEDrather thanSPOT_CAPACITY_OPTIMIZEDin most instances.With
BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED, andSPOT_PRICE_CAPACITY_OPTIMIZEDallocation strategies using On-Demand or Spot Instances, and theBEST_FITstrategy using Spot Instances, AWS Batch might need to go abovemaxvCpusto meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpusby more than a single instance.- Specified by:
getAllocationStrategyin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
- BEST_FIT (default) - AWS 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, AWS Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching Amazon EC2 service limits then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with
-
getBidPercentage
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Specified by:
getBidPercentagein interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getDesiredvCpus
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe desired number of vCPUS in the compute environment.AWS 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. > AWS 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
desiredvCpussetting, the value must be between theminvCpusandmaxvCpusvalues.Additionally, the updated
desiredvCpusvalue must be greater than or equal to the currentdesiredvCpusvalue. For more information, see Troubleshooting AWS Batch in the AWS Batch User Guide .- Specified by:
getDesiredvCpusin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getEc2Configuration
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyProvides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment.If
Ec2Configurationisn'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 AWS 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.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnComputeEnvironment.Ec2ConfigurationObjectProperty>- Specified by:
getEc2Configurationin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getEc2KeyPair
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Specified by:
getEc2KeyPairin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getImageId
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe Amazon Machine Image (AMI) ID used for instances launched in the compute environment.This parameter is overridden by the
imageIdOverridemember of theEc2Configurationstructure. 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 AWS 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 .
- Specified by:
getImageIdin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getInstanceRole
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe 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 AWS 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Specified by:
getInstanceRolein interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getInstanceTypes
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe instances types that can be launched.You can specify instance families to launch any instance type within those families (for example,
c5orp3), or you can specify specific sizes within a family (such asc5.8xlarge).AWS Batch can select the instance type for you if you choose one of the following:
optimalto select instance types (from thec4,m4,r4,c5,m5, andr5instance families) that match the demand of your job queues.default_x86_64to choose x86 based instance types (from them6i,c6i,r6i, andc7iinstance families) that matches the resource demands of the job queue.default_arm64to choose x86 based instance types (from them6g,c6g,r6g, andc7ginstance families) that matches the resource demands of the job queue.
Starting on 11/01/2025 the behavior of
optimalis going to be changed to matchdefault_x86_64. During the change your instance families could be updated to a newer generation. You do not need to perform any actions for the upgrade to happen. For more information about change, see Optimal instance type configuration to receive automatic instance family updates . > Instance family availability varies by AWS Region . For example, some AWS Region s may not have any fourth generation instance families but have fifth and sixth generation instance families.When using
default_x86_64ordefault_arm64instance bundles, AWS Batch selects instance families based on a balance of cost-effectiveness and performance. While newer generation instances often provide better price-performance, AWS Batch may choose an earlier generation instance family if it provides the optimal combination of availability, cost, and performance for your workload. For example, in an AWS Region where both c6i and c7i instances are available, AWS Batch might select c6i instances if they offer better cost-effectiveness for your specific job requirements. For more information on AWS Batch instance types and AWS Region availability, see Instance type compute table in the AWS Batch User Guide .AWS Batch periodically updates your instances in default bundles to newer, more cost-effective options. Updates happen automatically without requiring any action from you. Your workloads continue running during updates with no interruption > 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.
- Specified by:
getInstanceTypesin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getLaunchTemplate
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe 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 ** . 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
updateToLatestImageVersionparameter 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 ** .
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Returns union: either
IResolvableorCfnComputeEnvironment.LaunchTemplateSpecificationProperty- Specified by:
getLaunchTemplatein interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getMinvCpus
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe minimum number of vCPUs that an environment should maintain (even if the compute environment isDISABLED).This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Specified by:
getMinvCpusin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getPlacementGroup
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Specified by:
getPlacementGroupin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getSecurityGroupIds
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe 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 AWS Batch User Guide .
- Specified by:
getSecurityGroupIdsin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getSpotIamFleetRole
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyThe Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to aSPOTcompute environment.This role is required if the allocation strategy set to
BEST_FITor if the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the AWS 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 AWS Batch User Guide .
- Specified by:
getSpotIamFleetRolein interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getTags
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertyKey-value pair tags to be applied to Amazon EC2 resources that are launched in the compute environment.For AWS Batch , these take the form of
"String1": "String2", whereString1is the tag key andString2is 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 AWS BatchListTagsForResourceAPI 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Specified by:
getTagsin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
getUpdateToLatestImageVersion
Description copied from interface:CfnComputeEnvironment.ComputeResourcesPropertySpecifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update.The default value is
false.An AMI ID can either be specified in the
imageIdorimageIdOverrideparameters or be determined by the launch template that's specified in thelaunchTemplateparameter. 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 AWS 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 AWS Batch User Guide .
Returns union: either
BooleanorIResolvableDefault: - false
- Specified by:
getUpdateToLatestImageVersionin interfaceCfnComputeEnvironment.ComputeResourcesProperty- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-