Class CfnComputeEnvironment
The AWS::Batch::ComputeEnvironment
resource defines your AWS Batch compute environment.
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnComputeEnvironment : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnComputeEnvironment
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
You can define MANAGED
or UNMANAGED
compute environments. MANAGED
compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED
compute environments can only use EC2 resources. For more information, see Compute Environments in the ** .
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 either to use EC2 On-Demand Instances and EC2 Spot Instances, or to 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 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 EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify 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 .
To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster
. > AWS Batch doesn't upgrade the AMIs in a compute environment after it's created except under specific conditions. For example, it doesn't automatically update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're 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. There are two ways to use a new AMI for your AWS Batch jobs. The original method is to complete these steps:
In April 2022, AWS Batch added enhanced support for updating compute environments. For example, the UpdateComputeEnvironent
API lets you use the ReplaceComputeEnvironment
property to dynamically update compute environment parameters such as the launch template or instance type without replacement. For more information, see Updating compute environments in the AWS Batch User Guide .
To use the enhanced updating of compute environments to update AMIs, follow these rules:
Set the <code>ReplaceComputeEnvironment</code> property to <code>true</code> if the compute environment uses the <code>BEST_FIT</code> allocation strategy. > If the <code>ReplaceComputeEnvironment</code> property is set to <code>false</code> , you might receive an error message when you update the CFN template for a compute environment. This issue occurs if the updated <code>desiredvcpus</code> value is less than the current <code>desiredvcpus</code> value. As a workaround, delete the <code>desiredvcpus</code> value from the updated template or use the <code>minvcpus</code> property to manage the number of vCPUs. For information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update">Error message when you update the <code>DesiredvCpus</code> setting</a> .
If these rules are followed, any update that triggers an infrastructure update will cause the AMI ID to be re-selected. If the Version property of the LaunchTemplateSpecification is set to $Latest
or $Default
, the latest or default version of the launch template will be evaluated up at the time of the infrastructure update, even if the LaunchTemplateSpecification
was not updated.
CloudformationResource: AWS::Batch::ComputeEnvironment
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Batch;
var cfnComputeEnvironment = new CfnComputeEnvironment(this, "MyCfnComputeEnvironment", new CfnComputeEnvironmentProps {
Type = "type",
// the properties below are optional
ComputeEnvironmentName = "computeEnvironmentName",
ComputeResources = new ComputeResourcesProperty {
MaxvCpus = 123,
Subnets = new [] { "subnets" },
Type = "type",
// the properties below are optional
AllocationStrategy = "allocationStrategy",
BidPercentage = 123,
DesiredvCpus = 123,
Ec2Configuration = new [] { new Ec2ConfigurationObjectProperty {
ImageType = "imageType",
// the properties below are optional
ImageIdOverride = "imageIdOverride",
ImageKubernetesVersion = "imageKubernetesVersion"
} },
Ec2KeyPair = "ec2KeyPair",
ImageId = "imageId",
InstanceRole = "instanceRole",
InstanceTypes = new [] { "instanceTypes" },
LaunchTemplate = new LaunchTemplateSpecificationProperty {
LaunchTemplateId = "launchTemplateId",
LaunchTemplateName = "launchTemplateName",
Version = "version"
},
MinvCpus = 123,
PlacementGroup = "placementGroup",
SecurityGroupIds = new [] { "securityGroupIds" },
SpotIamFleetRole = "spotIamFleetRole",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
UpdateToLatestImageVersion = false
},
EksConfiguration = new EksConfigurationProperty {
EksClusterArn = "eksClusterArn",
KubernetesNamespace = "kubernetesNamespace"
},
ReplaceComputeEnvironment = false,
ServiceRole = "serviceRole",
State = "state",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
UnmanagedvCpus = 123,
UpdatePolicy = new UpdatePolicyProperty {
JobExecutionTimeoutMinutes = 123,
TerminateJobsOnUpdate = false
}
});
Synopsis
Constructors
CfnComputeEnvironment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnComputeEnvironment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnComputeEnvironment(Construct, String, ICfnComputeEnvironmentProps) |
Properties
AttrComputeEnvironmentArn | Returns the compute environment ARN, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ComputeEnvironmentName | The name for your compute environment. |
ComputeResources | The ComputeResources property type specifies details of the compute resources managed by the compute environment. |
EksConfiguration | The details for the Amazon EKS cluster that supports the compute environment. |
ReplaceComputeEnvironment | Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment. |
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. |
State | The state of the compute environment. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags applied to the compute environment. |
Type | The type of the compute environment: |
UnmanagedvCpus | The maximum number of vCPUs for an unmanaged compute environment. |
UpdatePolicy | Specifies the infrastructure update policy for the compute environment. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnComputeEnvironment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnComputeEnvironment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnComputeEnvironment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnComputeEnvironment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnComputeEnvironment(Construct, String, ICfnComputeEnvironmentProps)
public CfnComputeEnvironment(Construct scope, string id, ICfnComputeEnvironmentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnComputeEnvironmentProps
Resource properties.
Properties
AttrComputeEnvironmentArn
Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
.
public virtual string AttrComputeEnvironmentArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ComputeEnvironmentArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ComputeEnvironmentName
The name for your compute environment.
public virtual string ComputeEnvironmentName { get; set; }
Property Value
System.String
ComputeResources
The ComputeResources property type specifies details of the compute resources managed by the compute environment.
public virtual object ComputeResources { get; set; }
Property Value
System.Object
EksConfiguration
The details for the Amazon EKS cluster that supports the compute environment.
public virtual object EksConfiguration { get; set; }
Property Value
System.Object
ReplaceComputeEnvironment
Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.
public virtual object ReplaceComputeEnvironment { get; set; }
Property Value
System.Object
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.
public virtual string ServiceRole { get; set; }
Property Value
System.String
State
The state of the compute environment.
public virtual string State { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags applied to the compute environment.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Type
The type of the compute environment: MANAGED
or UNMANAGED
.
public virtual string Type { get; set; }
Property Value
System.String
UnmanagedvCpus
The maximum number of vCPUs for an unmanaged compute environment.
public virtual Nullable<double> UnmanagedvCpus { get; set; }
Property Value
System.Nullable<System.Double>
UpdatePolicy
Specifies the infrastructure update policy for the compute environment.
public virtual object UpdatePolicy { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>