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.

Container for the parameters to the CreateComputeEnvironment operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Batch.AmazonBatchRequest
      Amazon.Batch.Model.CreateComputeEnvironmentRequest

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

Syntax

C#
public class CreateComputeEnvironmentRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The CreateComputeEnvironmentRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ComputeEnvironmentName System.String

Gets and sets the property ComputeEnvironmentName.

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.

Public Property ComputeResources Amazon.Batch.Model.ComputeResource

Gets and sets the property ComputeResources.

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.

Public Property ServiceRole System.String

Gets and sets the property ServiceRole.

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.

Public Property State Amazon.Batch.CEState

Gets and sets the property State.

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.

Public Property Type Amazon.Batch.CEType

Gets and sets the property Type.

The type of the compute environment.

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 Standard:
Supported in: 1.3

.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