AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Batch CreateComputeEnvironment API operation.

Syntax

New-BATComputeEnvironment
-ComputeResources_AllocationStrategy <CRAllocationStrategy>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AllowedInstanceType <String[]>
-ComputeResources_BidPercentage <Int32>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_CapacityOptionType <String>
-ComputeResources_CapacityTag <Hashtable>
-ComputeEnvironmentName <String>
-EcsSettings_ContainerInsight <ContainerInsights>
-Context <String>
-ComputeResources_DesiredvCpu <Int32>
-ComputeResources_Ec2Configuration <Ec2Configuration[]>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_Ec2InstanceProfileArn <String>
-ComputeResources_Ec2KeyPair <String>
-EksConfiguration_EksClusterArn <String>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_FipsEnabled <Boolean>
-ComputeResources_ManagedInstancesProvider_InfrastructureRoleArn <String>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_InstanceMetadataTagsPropagation <Boolean>
-ComputeResources_InstanceRole <String>
-ComputeResources_InstanceType <String[]>
-EksConfiguration_KubernetesNamespace <String>
-LaunchTemplate_LaunchTemplateId <String>
-LaunchTemplate_LaunchTemplateName <String>
-ComputeResources_MaxvCpu <Int32>
-ComputeResources_ScalingPolicy_MinScaleDownDelayMinute <Int32>
-ComputeResources_MinvCpu <Int32>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_Monitoring <String>
-LaunchTemplate_Override <LaunchTemplateSpecificationOverride[]>
-ComputeResources_PlacementGroup <String>
-ComputeResources_ManagedInstancesProvider_PropagateTag <String>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_CapacityReservations_ReservationGroupArn <String>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_CapacityReservations_ReservationPreference <String>
-ComputeResources_ManagedInstancesProvider_InfrastructureOptimization_ScaleInAfter <Int32>
-ComputeResources_SecurityGroupId <String[]>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_NetworkConfiguration_SecurityGroup <String[]>
-ServiceRole <String>
-ComputeResources_SpotIamFleetRole <String>
-State <CEState>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_StorageConfiguration_StorageSizeGiB <Int32>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_NetworkConfiguration_Subnet <String[]>
-ComputeResources_Subnet <String[]>
-ComputeResources_Tag <Hashtable>
-Tag <Hashtable>
-ComputeResources_Type <CRType>
-Type <CEType>
-UnmanagedvCpu <Int32>
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_LocalStorageConfiguration_UseLocalStorage <Boolean>
-LaunchTemplate_UserdataType <UserdataType>
-LaunchTemplate_Version <String>
-ComputeResources_ImageId <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBatchConfig>

Description

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources. In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price. In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide. Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For more information on how to update a compute environment's AMI, see Updating compute environments in the Batch User Guide.

Parameters

-ClientConfig <AmazonBatchConfig>
Amazon.PowerShell.Cmdlets.BAT.AmazonBatchClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeEnvironmentName <String>
The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_AllocationStrategy <CRAllocationStrategy>
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.This parameter is required for Amazon EKS compute environments. For Amazon ECS compute environments, if this parameter isn't specified, the BEST_FIT allocation strategy is used by default.
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 a BEST_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.
BEST_FIT_PROGRESSIVE_ORDERED
This is an advanced allocation strategy only for customers who want to control which instance types are preferred during scaling.Placing large instance types at the top of the list may result in over-provisioning for small jobs. Placing small instance types at the top may cause the compute environment to reach Amazon EC2 instance count limits before reaching maxvCpus.Batch selects instance types in the order they appear in the instanceTypes list. When an instance family is specified, sizes within that family are expanded using BEST_FIT_PROGRESSIVE logic—preferring sizes that best fit the jobs, with larger sizes as fallback. Instance types that cannot meet the resource requirements of the jobs are skipped. This strategy is only available for On-Demand Instance (EC2) compute resources.If an instance family and an explicit instance type from that family both appear in instanceTypes, the explicit type takes its listed position and is excluded from the family expansion. For example, in ["m7a.4xlarge", "m7a", "m6a"], m7a.4xlarge is always placed first and is excluded from the m7a family expansion.
SPOT_CAPACITY_OPTIMIZED
Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
SPOT_PRICE_CAPACITY_OPTIMIZED
The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.
SPOT_CAPACITY_OPTIMIZED_PRIORITIZED
This is an advanced allocation strategy for customers who want to influence instance type selection during scaling. This strategy optimizes for capacity first, and honors instance type priorities on a best-effort basis (priorities are honored when they do not significantly reduce available Spot capacity).Placing large instance types at the top of the list may result in over-provisioning for small jobs. Placing small instance types at the top may cause the compute environment to reach Amazon EC2 instance count limits before reaching maxvCpus.Batch selects instance types in the order they appear in the instanceTypes list, but optimizes for capacity first. The customer-defined priority is honored on a best-effort basis. When Spot Instance capacity pools are similarly available, priority order is respected. When capacity is constrained, Batch selects from the most available pools regardless of priority to minimize the likelihood of Spot Instance interruptions. This strategy is only available for Spot Instance compute resources.
With any allocation strategy except BEST_FIT using On-Demand (EC2) compute resources, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_BidPercentage <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_CapacityTag <Hashtable>
The tags to apply to the Amazon ECS capacity provider and Amazon EC2 instances launched by the compute environment. These tags are separate from the compute environment resource tags (the top-level tags parameter). Use capacityTags for cost allocation and organization of the underlying infrastructure resources.This parameter is only valid for ECS_MANAGED_INSTANCES compute environments. You must have the batch:SetCapacityTags permission on the compute environment resource to use this parameter. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_CapacityTags
-ComputeResources_DesiredvCpu <Int32>
The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_DesiredvCpus
-ComputeResources_Ec2Configuration <Ec2Configuration[]>
Provides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2023 for EC2 (ECS) compute environments and EKS_AL2023 for EKS compute environments.One or two values can be provided.This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_Ec2KeyPair <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ImageId <String>
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 2023 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2023 AMI in the Amazon Elastic Container Service Developer Guide.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_InstanceRole <String>
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required for Amazon EC2 instances types. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_InstanceType <String[]>
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).Batch can select the instance type for you if you choose one of the following:
  • 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 ARM based instance types (from the m6g, c6g, r6g, and c7g instance families) that matches the resource demands of the job queue.
  • optimal Semantically equivalent to default_x86_64, see Optimal instance type configuration to receive automatic instance family updates for details.
Instance family availability varies by Amazon Web Services Region. For example, some Amazon Web Services Regions 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, Batch selects instance families based on a balance of cost-effectiveness and performance. While newer generation instances often provide better price-performance, 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 Amazon Web Services Region where both c6i and c7i instances are available, Batch might select c6i instances if they offer better cost-effectiveness for your specific job requirements. For more information on Batch instance types and Amazon Web Services Region availability, see Instance type compute table in the Batch User Guide.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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_InstanceTypes
-ComputeResources_ManagedInstancesProvider_InfrastructureOptimization_ScaleInAfter <Int32>
The number of seconds an instance can remain idle before it is terminated. Valid values are -1 or 0 to 3600. Use -1 as a special value to disable scale-in (instances are never terminated for being idle). If not specified, a default value applies.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InfrastructureRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that Amazon ECS assumes to manage Amazon EC2 instances on your behalf. This role must have a trust policy for ecs.amazonaws.com. You must have the iam:PassRole permission for this role with the condition iam:PassedToService: ecs.amazonaws.com.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_CapacityOptionType <String>
The capacity pricing model for the managed instances. Valid values:
  • ON_DEMAND (default) — On-Demand pricing.
  • SPOT — Spot Instances, which can provide significant cost savings for fault-tolerant workloads.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_CapacityReservations_ReservationGroupArn <String>
The Amazon Resource Name (ARN) of the capacity reservation group to target.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_CapacityReservations_ReservationPreference <String>
The capacity reservation preference. Valid values:
  • RESERVATIONS_ONLY — Use only capacity reservations.
  • RESERVATIONS_FIRST — Prefer capacity reservations but fall back to On-Demand if unavailable.
  • RESERVATIONS_EXCLUDED — Do not use capacity reservations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_Ec2InstanceProfileArn <String>
The Amazon Resource Name (ARN) of the Amazon EC2 instance profile for the managed instances. The instance profile must use the AmazonECSInstanceRolePolicyForManagedInstances managed policy with a trust policy for ec2.amazonaws.com.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_FipsEnabled <Boolean>
Specifies whether FIPS 140-2 validated cryptographic modules are enabled on the managed instances. Not available in all Regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_InstanceMetadataTagsPropagation <Boolean>
Specifies whether instance tags are accessible from the instance metadata service (IMDS). If not specified, instance tags are not accessible from IMDS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AllowedInstanceType <String[]>
A list of specific instance types or instance families that Amazon ECS can launch (for example, m5.large or g5). When specified, only these instance types are used. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_InstanceRequirements_AllowedInstanceTypes
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_LocalStorageConfiguration_UseLocalStorage <Boolean>
Specifies whether instance store volumes (local NVMe SSDs) are available to containers. When enabled, containers can use the instance store for high-performance temporary storage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_Monitoring <String>
The level of CloudWatch monitoring for the managed instances. Valid values are BASIC and DETAILED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_NetworkConfiguration_SecurityGroup <String[]>
The VPC security groups to associate with the managed instances. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_NetworkConfiguration_SecurityGroups
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_NetworkConfiguration_Subnet <String[]>
The VPC subnets where managed instances are launched. If your subnets don't provide public IP addresses, they must have a NAT gateway for outbound internet access. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_NetworkConfiguration_Subnets
-ComputeResources_ManagedInstancesProvider_InstanceLaunchTemplate_StorageConfiguration_StorageSizeGiB <Int32>
The size of the root EBS volume in GiB for the managed instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ManagedInstancesProvider_PropagateTag <String>
Specifies whether tags on the capacity provider are propagated to the Amazon EC2 instances it launches. Valid values:
  • CAPACITY_PROVIDER — Propagates tags to instances.
  • NONE (default) — Does not propagate tags to instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_ManagedInstancesProvider_PropagateTags
-ComputeResources_MaxvCpu <Int32>
The maximum number of vCPUs that a compute environment can support.With any allocation strategy except BEST_FIT using On-Demand (EC2) compute resources, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_MaxvCpus
-ComputeResources_MinvCpu <Int32>
The minimum number of vCPUs that a compute 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_MinvCpus
-ComputeResources_PlacementGroup <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ScalingPolicy_MinScaleDownDelayMinute <Int32>
The minimum time (in minutes) that Batch keeps instances running in the compute environment after their jobs complete. For each instance, the delay period begins when the last job finishes. If no new jobs are placed on the instance during this delay, Batch terminates the instance once the delay expires.Valid Range: Minimum value of 20. Maximum value of 10080. Use 0 to unset and disable the scale down delay.Idle instances retained during the scale-down delay period are billable at standard EC2 pricing.The scale down delay does not apply to:
  • Instances being replaced during infrastructure updates
  • Newly launched instances that have not yet run any jobs
  • Spot instances reclaimed due to interruption
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_ScalingPolicy_MinScaleDownDelayMinutes
-ComputeResources_SecurityGroupId <String[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_SecurityGroupIds
-ComputeResources_SpotIamFleetRole <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_Subnet <String[]>
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. This parameter is required for compute environments using EC2, SPOT, FARGATE, or FARGATE_SPOT compute resources.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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_Subnets
-ComputeResources_Tag <Hashtable>
Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", 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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_Tags
-ComputeResources_Type <CRType>
The type of compute environment: EC2, SPOT, FARGATE, FARGATE_SPOT, or ECS_MANAGED_INSTANCES. 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.If you choose ECS_MANAGED_INSTANCES, you must also specify a managedInstancesProvider configuration. To use Spot capacity, set capacityOptionType to SPOT in the managedInstancesProvider.instanceLaunchTemplate configuration. For more information, see Amazon ECS Managed Instances compute environments in the Batch User Guide.Multi-node parallel jobs aren't supported on Spot Instances or Amazon ECS Managed Instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context <String>
Reserved.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EcsSettings_ContainerInsight <ContainerInsights>
Specifies the CloudWatch Container Insights mode for the compute environment. Valid values are:
ENABLED
Turns on standard Container Insights, which collects CPU, memory, disk, and network utilization metrics for the compute environment.
ENHANCED
Turns on enhanced Container Insights, which collects the standard metrics along with additional per-task observability metrics.
DISABLED
Turns off Container Insights for the compute environment.
If you don't specify a value, the default is DISABLED. For more information, see Container Insights in the Batch User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEcsSettings_ContainerInsights
-EksConfiguration_EksClusterArn <String>
The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EksConfiguration_KubernetesNamespace <String>
The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or null. It must be fewer than 64 characters long, can't be set to default, can't start with "kube-," and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchTemplate_LaunchTemplateId <String>
The ID of the launch template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_LaunchTemplate_LaunchTemplateId
-LaunchTemplate_LaunchTemplateName <String>
The name of the launch template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_LaunchTemplate_LaunchTemplateName
-LaunchTemplate_Override <LaunchTemplateSpecificationOverride[]>
A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_LaunchTemplate_Overrides
-LaunchTemplate_UserdataType <UserdataType>
The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is EKS_BOOTSTRAP_SH. If imageType is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose EKS_NODEADM.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_LaunchTemplate_UserdataType
-LaunchTemplate_Version <String>
The version number of the launch template, $Default, or $Latest.If the value is $Default, the default version of the launch template is used. If the value is $Latest, the latest version of the launch template is used.If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true. During an infrastructure update, if either $Default or $Latest is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. 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.Default: $DefaultLatest: $Latest
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_LaunchTemplate_Version
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Batch.Model.CreateComputeEnvironmentResponse). Specifying the name of a property of type Amazon.Batch.Model.CreateComputeEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceRole <String>
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the Batch service-linked role in your account.This automatic service-linked role creation only applies to MANAGED compute environments. For UNMANAGED compute environments, you must explicitly specify a serviceRole.If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/, specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-State <CEState>
The state of the compute environment. A compute environment must be created in the ENABLED state.If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. Compute environments in a DISABLED state may continue to incur billing charges, for example, if they have running instances due to jobs that are still executing or a non-zero minvCpus setting. To prevent additional charges, disable and delete the compute environment.When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Type <CEType>
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-UnmanagedvCpu <Int32>
The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.This parameter is only supported when the type parameter is set to UNMANAGED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUnmanagedvCpus

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Batch.Model.CreateComputeEnvironmentResponse
This cmdlet returns an Amazon.Batch.Model.CreateComputeEnvironmentResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z