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_BidPercentage <Int32>
-ComputeEnvironmentName <String>
-ComputeResources_DesiredvCpu <Int32>
-ComputeResources_Ec2KeyPair <String>
-ComputeResources_ImageId <String>
-ComputeResources_InstanceRole <String>
-ComputeResources_InstanceType <String[]>
-LaunchTemplate_LaunchTemplateId <String>
-LaunchTemplate_LaunchTemplateName <String>
-ComputeResources_MaxvCpu <Int32>
-ComputeResources_MinvCpu <Int32>
-ComputeResources_PlacementGroup <String>
-ComputeResources_SecurityGroupId <String[]>
-ServiceRole <String>
-ComputeResources_SpotIamFleetRole <String>
-State <CEState>
-ComputeResources_Subnet <String[]>
-ComputeResources_Tag <Hashtable>
-ComputeResources_Type <CRType>
-Type <CEType>
-LaunchTemplate_Version <String>
-Select <String>
-Force <SwitchParameter>

Description

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. In a managed compute environment, AWS 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. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price. Multi-node parallel jobs are not supported on Spot Instances. In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually 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. AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs:
  1. Create a new compute environment with the new AMI.
  2. Add the compute environment to an existing job queue.
  3. Remove the old compute environment from your job queue.
  4. Delete the old compute environment.

Parameters

-ComputeEnvironmentName <String>
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_AllocationStrategy <CRAllocationStrategy>
The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits. If this is not specified, the default is BEST_FIT, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. BEST_FIT_PROGRESSIVE will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type with a lower cost. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type that is less likely to be interrupted.
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 below 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_DesiredvCpu <Int32>
The desired number of Amazon EC2 vCPUS in the compute environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_DesiredvCpus
-ComputeResources_Ec2KeyPair <String>
The Amazon EC2 key pair that is used for instances launched in the compute environment.
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.
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. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_InstanceType <String[]>
The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to pick instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_InstanceTypes
-ComputeResources_MaxvCpu <Int32>
The maximum number of Amazon EC2 vCPUs that an environment can reach.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_MaxvCpus
-ComputeResources_MinvCpu <Int32>
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_SecurityGroupId <String[]>
The Amazon EC2 security groups 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. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.
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. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_Subnet <String[]>
The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_Subnets
-ComputeResources_Tag <Hashtable>
Key-value pair tags to be applied to 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": "AWS Batch Instance - C4OnDemand" }.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_Tags
-ComputeResources_Type <CRType>
The type of compute environment: EC2 or SPOT.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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_Version <String>
The version number of the launch template.Default: The default version of the launch template.
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 AWS Batch to make calls to other AWS services on your behalf.If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-State <CEState>
The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <CEType>
The type of the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

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)
Aliases AK
-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 (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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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)
Aliases AWSProfilesLocation, 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)
Aliases AWSProfileName, StoredCredentials
-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 (ByPropertyName)
-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)
Aliases SecretAccessKey, SK
-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)
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases RegionToCall
-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)

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns an Amazon.Batch.Model.CreateComputeEnvironmentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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