Class: AWSCDK::Batch::CfnComputeEnvironment::ComputeResourcesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
batch/cfn_compute_environment.rb

Overview

Details about the compute resources managed by the compute environment.

This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(maxv_cpus:, subnets:, type:, allocation_strategy: nil, bid_percentage: nil, desiredv_cpus: nil, ec2_configuration: nil, ec2_key_pair: nil, image_id: nil, instance_role: nil, instance_types: nil, launch_template: nil, minv_cpus: nil, placement_group: nil, scaling_policy: nil, security_group_ids: nil, spot_iam_fleet_role: nil, tags: nil, update_to_latest_image_version: nil) ⇒ ComputeResourcesProperty

Returns a new instance of ComputeResourcesProperty.

Parameters:

  • maxv_cpus (Numeric) —

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

  • subnets (Array<String>) —

    The VPC subnets where the compute resources are launched.

  • type (String) —

    The type of compute environment: EC2 , SPOT , FARGATE , or FARGATE_SPOT .

  • allocation_strategy (String, nil) (defaults to: nil) —

    The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated.

  • bid_percentage (Numeric, nil) (defaults to: nil) —

    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.

  • desiredv_cpus (Numeric, nil) (defaults to: nil) —

    The desired number of vCPUS in the compute environment.

  • ec2_configuration (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Batch::CfnComputeEnvironment::EC2ConfigurationObjectProperty>, nil) (defaults to: nil) —

    Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment.

  • ec2_key_pair (String, nil) (defaults to: nil) —

    The Amazon EC2 key pair that's used for instances launched in the compute environment.

  • image_id (String, nil) (defaults to: nil) —

    The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

  • instance_role (String, nil) (defaults to: nil) —

    The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.

  • instance_types (Array<String>, nil) (defaults to: nil) —

    The instances types that can be launched.

  • launch_template (AWSCDK::IResolvable, AWSCDK::Batch::CfnComputeEnvironment::LaunchTemplateSpecificationProperty, nil) (defaults to: nil) —

    The launch template to use for your compute resources.

  • minv_cpus (Numeric, nil) (defaults to: nil) —

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

  • placement_group (String, nil) (defaults to: nil) —

    The Amazon EC2 placement group to associate with your compute resources.

  • scaling_policy (AWSCDK::IResolvable, AWSCDK::Batch::CfnComputeEnvironment::ComputeScalingPolicyProperty, nil) (defaults to: nil)
  • security_group_ids (Array<String>, nil) (defaults to: nil) —

    The Amazon EC2 security groups that are associated with instances launched in the compute environment.

  • spot_iam_fleet_role (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute environment.

  • update_to_latest_image_version (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update.



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'batch/cfn_compute_environment.rb', line 699

def initialize(maxv_cpus:, subnets:, type:, allocation_strategy: nil, bid_percentage: nil, desiredv_cpus: nil, ec2_configuration: nil, ec2_key_pair: nil, image_id: nil, instance_role: nil, instance_types: nil, launch_template: nil, minv_cpus: nil, placement_group: nil, scaling_policy: nil, security_group_ids: nil, spot_iam_fleet_role: nil, tags: nil, update_to_latest_image_version: nil)
  @maxv_cpus = maxv_cpus
  Jsii::Type.check_type(@maxv_cpus, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxvCpus")
  @subnets = subnets
  Jsii::Type.check_type(@subnets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnets")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @allocation_strategy = allocation_strategy
  Jsii::Type.check_type(@allocation_strategy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "allocationStrategy") unless @allocation_strategy.nil?
  @bid_percentage = bid_percentage
  Jsii::Type.check_type(@bid_percentage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "bidPercentage") unless @bid_percentage.nil?
  @desiredv_cpus = desiredv_cpus
  Jsii::Type.check_type(@desiredv_cpus, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "desiredvCpus") unless @desiredv_cpus.nil?
  @ec2_configuration = ec2_configuration
  Jsii::Type.check_type(@ec2_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmF0Y2guQ2ZuQ29tcHV0ZUVudmlyb25tZW50LkVjMkNvbmZpZ3VyYXRpb25PYmplY3RQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "ec2Configuration") unless @ec2_configuration.nil?
  @ec2_key_pair = ec2_key_pair
  Jsii::Type.check_type(@ec2_key_pair, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ec2KeyPair") unless @ec2_key_pair.nil?
  @image_id = image_id
  Jsii::Type.check_type(@image_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageId") unless @image_id.nil?
  @instance_role = instance_role
  Jsii::Type.check_type(@instance_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceRole") unless @instance_role.nil?
  @instance_types = instance_types
  Jsii::Type.check_type(@instance_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "instanceTypes") unless @instance_types.nil?
  @launch_template = launch_template.is_a?(Hash) ? ::AWSCDK::Batch::CfnComputeEnvironment::LaunchTemplateSpecificationProperty.new(**launch_template.transform_keys(&:to_sym)) : launch_template
  Jsii::Type.check_type(@launch_template, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Db21wdXRlRW52aXJvbm1lbnQuTGF1bmNoVGVtcGxhdGVTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "launchTemplate") unless @launch_template.nil?
  @minv_cpus = minv_cpus
  Jsii::Type.check_type(@minv_cpus, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minvCpus") unless @minv_cpus.nil?
  @placement_group = placement_group
  Jsii::Type.check_type(@placement_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "placementGroup") unless @placement_group.nil?
  @scaling_policy = scaling_policy.is_a?(Hash) ? ::AWSCDK::Batch::CfnComputeEnvironment::ComputeScalingPolicyProperty.new(**scaling_policy.transform_keys(&:to_sym)) : scaling_policy
  Jsii::Type.check_type(@scaling_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iYXRjaC5DZm5Db21wdXRlRW52aXJvbm1lbnQuQ29tcHV0ZVNjYWxpbmdQb2xpY3lQcm9wZXJ0eSJ9XX19")), "scalingPolicy") unless @scaling_policy.nil?
  @security_group_ids = security_group_ids
  Jsii::Type.check_type(@security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless @security_group_ids.nil?
  @spot_iam_fleet_role = spot_iam_fleet_role
  Jsii::Type.check_type(@spot_iam_fleet_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "spotIamFleetRole") unless @spot_iam_fleet_role.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @update_to_latest_image_version = update_to_latest_image_version
  Jsii::Type.check_type(@update_to_latest_image_version, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "updateToLatestImageVersion") unless @update_to_latest_image_version.nil?
end

Instance Attribute Details

#allocation_strategy ⇒ String? (readonly)

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 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_FIT is 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_FIT then 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_OPTIMIZED rather than SPOT_CAPACITY_OPTIMIZED in most instances.

With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED , and SPOT_PRICE_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to go above maxv_cpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxv_cpus by more than a single instance.

Returns:

  • (String, nil)

See Also:



792
793
794
 
# File 'batch/cfn_compute_environment.rb', line 792

def allocation_strategy
  @allocation_strategy
end

#bid_percentage ⇒ Numeric? (readonly)

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.

For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. For most use cases, we recommend leaving this field empty.

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

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Returns:

  • (Numeric, nil)

See Also:



803
804
805
 
# File 'batch/cfn_compute_environment.rb', line 803

def bid_percentage
  @bid_percentage
end

#desiredv_cpus ⇒ Numeric? (readonly)

The 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 desiredv_cpus setting, the value must be between the minv_cpus and maxv_cpus values.

Additionally, the updated desiredv_cpus value must be greater than or equal to the current desiredv_cpus value. For more information, see Troubleshooting AWS Batch in the AWS Batch User Guide .

Returns:

  • (Numeric, nil)

See Also:



814
815
816
 
# File 'batch/cfn_compute_environment.rb', line 814

def desiredv_cpus
  @desiredv_cpus
end

#ec2_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment.

If Ec2Configuration isn't specified, the default is ECS_AL2 .

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide . To remove the Amazon EC2 configuration and any custom AMI ID specified in image_id_override , 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:

See Also:



827
828
829
 
# File 'batch/cfn_compute_environment.rb', line 827

def ec2_configuration
  @ec2_configuration
end

#ec2_key_pair ⇒ String? (readonly)

The Amazon EC2 key pair that's used for instances launched in the compute environment.

You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

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

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Returns:

  • (String, nil)

See Also:



838
839
840
 
# File 'batch/cfn_compute_environment.rb', line 838

def ec2_key_pair
  @ec2_key_pair
end

#image_id ⇒ String? (readonly)

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

This parameter is overridden by the image_id_override 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 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 .

Returns:

  • (String, nil)

See Also:



849
850
851
 
# File 'batch/cfn_compute_environment.rb', line 849

def image_id
  @image_id
end

#instance_role ⇒ String? (readonly)

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.

Required for Amazon EC2 instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, *ecsInstanceRole* or arn:aws:iam:: *<aws_account_id>* :instance-profile/ *ecsInstanceRole* . For more information, see Amazon ECS instance role in the 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.

Returns:

  • (String, nil)

See Also:



860
861
862
 
# File 'batch/cfn_compute_environment.rb', line 860

def instance_role
  @instance_role
end

#instance_types ⇒ Array<String>? (readonly)

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 ).

AWS Batch can select the instance type for you if you choose one of the following:

  • optimal to select instance types (from the c4 , m4 , r4 , c5 , m5 , and r5 instance families) that match the demand of your job queues.
  • default_x86_64 to choose x86 based instance types (from the m6i , c6i , r6i , and c7i instance families) that matches the resource demands of the job queue.
  • default_arm64 to choose x86 based instance types (from the m6g , c6g , r6g , and c7g instance families) that matches the resource demands of the job queue.

Starting on 11/01/2025 the behavior of optimal is going to be changed to match default_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_64 or default_arm64 instance 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.

Returns:

  • (Array<String>, nil)

See Also:



879
880
881
 
# File 'batch/cfn_compute_environment.rb', line 879

def instance_types
  @instance_types
end

#launch_template ⇒ AWSCDK::IResolvable, ... (readonly)

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 ** . 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 update_to_latest_image_version 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 ** .

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

Returns:

See Also:



890
891
892
 
# File 'batch/cfn_compute_environment.rb', line 890

def launch_template
  @launch_template
end

#maxv_cpus ⇒ Numeric (readonly)

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

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

Returns:

  • (Numeric)

See Also:



746
747
748
 
# File 'batch/cfn_compute_environment.rb', line 746

def maxv_cpus
  @maxv_cpus
end

#minv_cpus ⇒ Numeric? (readonly)

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

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Returns:

  • (Numeric, nil)

See Also:



897
898
899
 
# File 'batch/cfn_compute_environment.rb', line 897

def minv_cpus
  @minv_cpus
end

#placement_group ⇒ String? (readonly)

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 AWS Batch User Guide .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Returns:

  • (String, nil)

See Also:



908
909
910
 
# File 'batch/cfn_compute_environment.rb', line 908

def placement_group
  @placement_group
end

#scaling_policy ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



911
912
913
 
# File 'batch/cfn_compute_environment.rb', line 911

def scaling_policy
  @scaling_policy
end

#security_group_ids ⇒ Array<String>? (readonly)

The Amazon EC2 security groups that are associated with instances launched in the compute environment.

This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the security groups from the compute resource.

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

Returns:

  • (Array<String>, nil)

See Also:



920
921
922
 
# File 'batch/cfn_compute_environment.rb', line 920

def security_group_ids
  @security_group_ids
end

#spot_iam_fleet_role ⇒ String? (readonly)

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 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 .

Returns:

  • (String, nil)

See Also:



929
930
931
 
# File 'batch/cfn_compute_environment.rb', line 929

def spot_iam_fleet_role
  @spot_iam_fleet_role
end

#subnets ⇒ Array<String> (readonly)

The VPC subnets where the compute resources are launched.

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

When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the 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.

Returns:

  • (Array<String>)

See Also:



759
760
761
 
# File 'batch/cfn_compute_environment.rb', line 759

def subnets
  @subnets
end

#tags ⇒ Hash{String => String}? (readonly)

Key-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" , 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 AWS 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 AWS Batch User Guide .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Returns:

  • (Hash{String => String}, nil)

See Also:



940
941
942
 
# File 'batch/cfn_compute_environment.rb', line 940

def tags
  @tags
end

#type ⇒ String (readonly)

The type of compute environment: EC2 , SPOT , FARGATE , or FARGATE_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 the spot_iam_fleet_role parameter. 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 EC2 and SPOT or between FARGATE and FARGATE_SPOT will initiate an infrastructure update, but if you switch between EC2 and FARGATE , CloudFormation will create a new compute environment.

Returns:

  • (String)

See Also:



772
773
774
 
# File 'batch/cfn_compute_environment.rb', line 772

def type
  @type
end

#update_to_latest_image_version ⇒ Boolean, ... (readonly)

Note:

Default: - false

Specifies 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 image_id or image_id_override parameters or be determined by the launch template that's specified in the launch_template 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 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:

See Also:



952
953
954
 
# File 'batch/cfn_compute_environment.rb', line 952

def update_to_latest_image_version
  @update_to_latest_image_version
end

Class Method Details

.jsii_properties ⇒ Object 



954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'batch/cfn_compute_environment.rb', line 954

def self.jsii_properties
  {
    :maxv_cpus => "maxvCpus",
    :subnets => "subnets",
    :type => "type",
    :allocation_strategy => "allocationStrategy",
    :bid_percentage => "bidPercentage",
    :desiredv_cpus => "desiredvCpus",
    :ec2_configuration => "ec2Configuration",
    :ec2_key_pair => "ec2KeyPair",
    :image_id => "imageId",
    :instance_role => "instanceRole",
    :instance_types => "instanceTypes",
    :launch_template => "launchTemplate",
    :minv_cpus => "minvCpus",
    :placement_group => "placementGroup",
    :scaling_policy => "scalingPolicy",
    :security_group_ids => "securityGroupIds",
    :spot_iam_fleet_role => "spotIamFleetRole",
    :tags => "tags",
    :update_to_latest_image_version => "updateToLatestImageVersion",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'batch/cfn_compute_environment.rb', line 978

def to_jsii
  result = {}
  result.merge!({
    "maxvCpus" => @maxv_cpus,
    "subnets" => @subnets,
    "type" => @type,
    "allocationStrategy" => @allocation_strategy,
    "bidPercentage" => @bid_percentage,
    "desiredvCpus" => @desiredv_cpus,
    "ec2Configuration" => @ec2_configuration,
    "ec2KeyPair" => @ec2_key_pair,
    "imageId" => @image_id,
    "instanceRole" => @instance_role,
    "instanceTypes" => @instance_types,
    "launchTemplate" => @launch_template,
    "minvCpus" => @minv_cpus,
    "placementGroup" => @placement_group,
    "scalingPolicy" => @scaling_policy,
    "securityGroupIds" => @security_group_ids,
    "spotIamFleetRole" => @spot_iam_fleet_role,
    "tags" => @tags,
    "updateToLatestImageVersion" => @update_to_latest_image_version,
  })
  result.compact
end