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

Invokes the CreateComputeEnvironment operation against AWS Batch.

Syntax

New-BATComputeEnvironment
-ComputeResources_BidPercentage <Int32>
-ComputeEnvironmentName <String>
-ComputeResources_DesiredvCpu <Int32>
-ComputeResources_Ec2KeyPair <String>
-ComputeResources_ImageId <String>
-ComputeResources_InstanceRole <String>
-ComputeResources_InstanceType <String[]>
-ComputeResources_MaxvCpu <Int32>
-ComputeResources_MinvCpu <Int32>
-ComputeResources_SecurityGroupId <String[]>
-ServiceRole <String>
-ComputeResources_SpotIamFleetRole <String>
-State <CEState>
-ComputeResources_Subnet <String[]>
-ComputeResources_Tag <Hashtable>
-ComputeResources_Type <CRType>
-Type <CEType>
-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 compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price. 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 EC2 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 and then manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon EC2 Container Service Developer Guide.

Parameters

-ComputeEnvironmentName <String>
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_BidPercentage <Int32>
The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_DesiredvCpu <Int32>
The desired number of EC2 vCPUS in the compute environment.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_Ec2KeyPair <String>
The EC2 key pair that is used for instances launched in the compute environment.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_ImageId <String>
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-ComputeResources_InstanceType <String[]>
The instances types that may launched.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_MaxvCpu <Int32>
The maximum number of EC2 vCPUs that an environment can reach.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_MinvCpu <Int32>
The minimum number of EC2 vCPUs that an environment should maintain.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_SecurityGroupId <String[]>
The EC2 security group that is associated with instances launched in the compute environment.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_SpotIamFleetRole <String>
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_Subnet <String[]>
The VPC subnets into which the compute resources are launched.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_Tag <Hashtable>
Key-value pair tags to be applied to resources that are launched in the compute environment.
Required?False
Position?Named
Accept pipeline input?False
-ComputeResources_Type <CRType>
The type of compute environment.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-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?False
Position?Named
Accept pipeline input?False
-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?False
-Type <CEType>
The type of the compute environment.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-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? False
-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? False

Inputs

This cmdlet does not accept pipeline input.

Outputs

This cmdlet returns a 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