Class CfnComputeEnvironment
A CloudFormation AWS::Batch::ComputeEnvironment
.
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.AWS.Batch.dll
Syntax (csharp)
public class CfnComputeEnvironment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnComputeEnvironment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Batch::ComputeEnvironment
resource defines your AWS Batch compute environment. 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>false</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(Construct, String, ICfnComputeEnvironmentProps) | Create a new |
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 |
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 | 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(Construct, String, ICfnComputeEnvironmentProps)
Create a new AWS::Batch::ComputeEnvironment
.
public CfnComputeEnvironment(Construct scope, string id, ICfnComputeEnvironmentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnComputeEnvironmentProps
- resource properties.
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
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
Remarks
It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
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
Remarks
This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
EksConfiguration
The details for the Amazon EKS cluster that supports the compute environment.
public virtual object EksConfiguration { get; set; }
Property Value
System.Object
Remarks
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
Remarks
The default value is true
. To enable more properties to be updated, set this property to false
. When changing the value of this property to false
, do not change any other properties at the same time. If other properties are changed at the same time, and the change needs to be rolled back but it can't, it's possible for the stack to go into the UPDATE_ROLLBACK_FAILED
state. You can't update a stack that is in the UPDATE_ROLLBACK_FAILED
state. However, if you can continue to roll it back, you can return the stack to its original settings and then try to update it again. For more information, see Continue rolling back an update in the AWS CloudFormation User Guide .
The properties that can't be changed without replacing the compute environment are in the ComputeResources
property type: AllocationStrategy
, BidPercentage
, Ec2Configuration
, Ec2KeyPair
, Ec2KeyPair
, ImageId
, InstanceRole
, InstanceTypes
, LaunchTemplate
, MaxvCpus
, MinvCpus
, PlacementGroup
, SecurityGroupIds
, Subnets
, Tags , Type
, and UpdateToLatestImageVersion
.
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
Remarks
For more information, see AWS Batch service IAM role in the AWS Batch User Guide .
If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.
If your specified role has a path other than /
, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar
has a path of /foo/
, specify /foo/bar
as the role name. For more information, see Friendly names and paths in the IAM User Guide .
Depending on how you created your AWS Batch service role, its ARN might contain the service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't 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.
State
The state of the compute environment.
public virtual string State { get; set; }
Property Value
System.String
Remarks
If the state is ENABLED
, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.
If the state is ENABLED
, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED
, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING
or RUNNING
state continue to progress normally. Managed compute environments in the DISABLED
state don't scale out.
Compute environments in a DISABLED
state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the AWS Batch User Guide .
When an instance is idle, the instance scales down to the minvCpus
value. However, the instance size doesn't change. For example, consider a c5.8xlarge
instance with a minvCpus
value of 4
and a desiredvCpus
value of 36
. This instance doesn't scale down to a c5.large
instance.
Tags
The tags applied to the compute environment.
public virtual TagManager Tags { get; }
Property Value
Remarks
Type
The type of the compute environment: MANAGED
or UNMANAGED
.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
For more information, see Compute Environments in the AWS Batch User Guide .
UnmanagedvCpus
The maximum number of vCPUs for an unmanaged compute environment.
public virtual Nullable<double> UnmanagedvCpus { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
This parameter is only supported when the type
parameter is set to UNMANAGED
.
UpdatePolicy
Specifies the infrastructure update policy for the compute environment.
public virtual object UpdatePolicy { get; set; }
Property Value
System.Object
Remarks
For more information about infrastructure updates, see Updating compute environments in the AWS Batch User Guide .
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>