AWS SDK Version 3 for .NET
API 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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to CreateComputeEnvironmentAsync.

Namespace: Amazon.Batch
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

C#
public abstract CreateComputeEnvironmentResponse CreateComputeEnvironment(
         CreateComputeEnvironmentRequest request
)
Parameters
request
Type: Amazon.Batch.Model.CreateComputeEnvironmentRequest

Container for the necessary parameters to execute the CreateComputeEnvironment service method.

Return Value
The response from the CreateComputeEnvironment service method, as returned by Batch.

Exceptions

ExceptionCondition
ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.
ServerException These errors are usually caused by a server issue.

Examples

This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.

To create a managed EC2 compute environment


var response = client.CreateComputeEnvironment(new CreateComputeEnvironmentRequest 
{
    Type = "MANAGED",
    ComputeEnvironmentName = "C4OnDemand",
    ComputeResources = new ComputeResource {
        Type = "EC2",
        DesiredvCpus = 48,
        Ec2KeyPair = "id_rsa",
        InstanceRole = "ecsInstanceRole",
        InstanceTypes = new List {
            "c4.large",
            "c4.xlarge",
            "c4.2xlarge",
            "c4.4xlarge",
            "c4.8xlarge"
        },
        MaxvCpus = 128,
        MinvCpus = 0,
        SecurityGroupIds = new List {
            "sg-cf5093b2"
        },
        Subnets = new List {
            "subnet-220c0e0a",
            "subnet-1a95556d",
            "subnet-978f6dce"
        },
        Tags = new Dictionary {
            { "Name", "Batch Instance - C4OnDemand" }
        }
    },
    ServiceRole = "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
    State = "ENABLED"
});

string computeEnvironmentArn = response.ComputeEnvironmentArn;
string computeEnvironmentName = response.ComputeEnvironmentName;

            

This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.

To create a managed EC2 Spot compute environment


var response = client.CreateComputeEnvironment(new CreateComputeEnvironmentRequest 
{
    Type = "MANAGED",
    ComputeEnvironmentName = "M4Spot",
    ComputeResources = new ComputeResource {
        Type = "SPOT",
        BidPercentage = 20,
        DesiredvCpus = 4,
        Ec2KeyPair = "id_rsa",
        InstanceRole = "ecsInstanceRole",
        InstanceTypes = new List {
            "m4"
        },
        MaxvCpus = 128,
        MinvCpus = 0,
        SecurityGroupIds = new List {
            "sg-cf5093b2"
        },
        SpotIamFleetRole = "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role",
        Subnets = new List {
            "subnet-220c0e0a",
            "subnet-1a95556d",
            "subnet-978f6dce"
        },
        Tags = new Dictionary {
            { "Name", "Batch Instance - M4Spot" }
        }
    },
    ServiceRole = "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
    State = "ENABLED"
});

string computeEnvironmentArn = response.ComputeEnvironmentArn;
string computeEnvironmentName = response.ComputeEnvironmentName;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also