@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:29.074Z") public class CfnComputeEnvironment extends CfnResource implements IInspectable
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:
- Create a new compute environment with the new AMI.
- Add the compute environment to an existing job queue.
- Remove the earlier compute environment from your job queue.
- Delete the earlier compute environment.
In April 2022, AWS Batch added enhanced support for updating compute environments. 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:
- Either do not set the ServiceRole property or set it to the AWSServiceRoleForBatch service-linked role.
- Set the AllocationStrategy property to
BEST_FIT_PROGRESSIVE
orSPOT_CAPACITY_OPTIMIZED
.- Set the ReplaceComputeEnvironment property to
false
.- Set the UpdateToLatestImageVersion property to
true
.- Either do not specify an image ID in ImageId or ImageIdOverride properties, or in the launch template identified by the Launch Template property. In that case AWS Batch will select the latest Amazon ECS optimized AMI supported by AWS Batch at the time the infrastructure update is initiated. Alternatively you can specify the AMI ID in the
ImageId
orImageIdOverride
properties, or the launch template identified by theLaunchTemplate
properties. Changing any of these properties will trigger an infrastructure update.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 theLaunchTemplateSpecification
was not updated.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.batch.*; CfnComputeEnvironment cfnComputeEnvironment = CfnComputeEnvironment.Builder.create(this, "MyCfnComputeEnvironment") .type("type") // the properties below are optional .computeEnvironmentName("computeEnvironmentName") .computeResources(ComputeResourcesProperty.builder() .maxvCpus(123) .subnets(List.of("subnets")) .type("type") // the properties below are optional .allocationStrategy("allocationStrategy") .bidPercentage(123) .desiredvCpus(123) .ec2Configuration(List.of(Ec2ConfigurationObjectProperty.builder() .imageType("imageType") // the properties below are optional .imageIdOverride("imageIdOverride") .imageKubernetesVersion("imageKubernetesVersion") .build())) .ec2KeyPair("ec2KeyPair") .imageId("imageId") .instanceRole("instanceRole") .instanceTypes(List.of("instanceTypes")) .launchTemplate(LaunchTemplateSpecificationProperty.builder() .launchTemplateId("launchTemplateId") .launchTemplateName("launchTemplateName") .version("version") .build()) .minvCpus(123) .placementGroup("placementGroup") .securityGroupIds(List.of("securityGroupIds")) .spotIamFleetRole("spotIamFleetRole") .tags(Map.of( "tagsKey", "tags")) .updateToLatestImageVersion(false) .build()) .eksConfiguration(EksConfigurationProperty.builder() .eksClusterArn("eksClusterArn") .kubernetesNamespace("kubernetesNamespace") .build()) .replaceComputeEnvironment(false) .serviceRole("serviceRole") .state("state") .tags(Map.of( "tagsKey", "tags")) .unmanagedvCpus(123) .updatePolicy(UpdatePolicyProperty.builder() .jobExecutionTimeoutMinutes(123) .terminateJobsOnUpdate(false) .build()) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnComputeEnvironment.Builder
A fluent builder for
CfnComputeEnvironment . |
static interface |
CfnComputeEnvironment.ComputeResourcesProperty
Details about the compute resources managed by the compute environment.
|
static interface |
CfnComputeEnvironment.Ec2ConfigurationObjectProperty
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment.
|
static interface |
CfnComputeEnvironment.EksConfigurationProperty
Configuration for the Amazon EKS cluster that supports the AWS Batch compute environment.
|
static interface |
CfnComputeEnvironment.LaunchTemplateSpecificationProperty
An object that represents a launch template that's associated with a compute resource.
|
static interface |
CfnComputeEnvironment.UpdatePolicyProperty
Specifies the infrastructure update policy for the compute environment.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnComputeEnvironment(Construct scope,
java.lang.String id,
CfnComputeEnvironmentProps props)
Create a new `AWS::Batch::ComputeEnvironment`.
|
protected |
CfnComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrComputeEnvironmentArn()
Returns the compute environment ARN, such as `batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getComputeEnvironmentName()
The name for your compute environment.
|
java.lang.Object |
getComputeResources()
The ComputeResources property type specifies details of the compute resources managed by the compute environment.
|
java.lang.Object |
getEksConfiguration()
The details for the Amazon EKS cluster that supports the compute environment.
|
java.lang.Object |
getReplaceComputeEnvironment()
Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.
|
java.lang.String |
getServiceRole()
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
|
java.lang.String |
getState()
The state of the compute environment.
|
TagManager |
getTags()
The tags applied to the compute environment.
|
java.lang.String |
getType()
The type of the compute environment: `MANAGED` or `UNMANAGED` .
|
java.lang.Number |
getUnmanagedvCpus()
The maximum number of vCPUs for an unmanaged compute environment.
|
java.lang.Object |
getUpdatePolicy()
Specifies the infrastructure update policy for the compute environment.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setComputeEnvironmentName(java.lang.String value)
The name for your compute environment.
|
void |
setComputeResources(CfnComputeEnvironment.ComputeResourcesProperty value)
The ComputeResources property type specifies details of the compute resources managed by the compute environment.
|
void |
setComputeResources(IResolvable value)
The ComputeResources property type specifies details of the compute resources managed by the compute environment.
|
void |
setEksConfiguration(CfnComputeEnvironment.EksConfigurationProperty value)
The details for the Amazon EKS cluster that supports the compute environment.
|
void |
setEksConfiguration(IResolvable value)
The details for the Amazon EKS cluster that supports the compute environment.
|
void |
setReplaceComputeEnvironment(java.lang.Boolean value)
Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.
|
void |
setReplaceComputeEnvironment(IResolvable value)
Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.
|
void |
setServiceRole(java.lang.String value)
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
|
void |
setState(java.lang.String value)
The state of the compute environment.
|
void |
setType(java.lang.String value)
The type of the compute environment: `MANAGED` or `UNMANAGED` .
|
void |
setUnmanagedvCpus(java.lang.Number value)
The maximum number of vCPUs for an unmanaged compute environment.
|
void |
setUpdatePolicy(CfnComputeEnvironment.UpdatePolicyProperty value)
Specifies the infrastructure update policy for the compute environment.
|
void |
setUpdatePolicy(IResolvable value)
Specifies the infrastructure update policy for the compute environment.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnComputeEnvironment(Construct scope, java.lang.String id, CfnComputeEnvironmentProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrComputeEnvironmentArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getType()
For more information, see Compute Environments in the AWS Batch User Guide .
public void setType(java.lang.String value)
For more information, see Compute Environments in the AWS Batch User Guide .
public java.lang.String getComputeEnvironmentName()
It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
public void setComputeEnvironmentName(java.lang.String value)
It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
public java.lang.Object getComputeResources()
This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
public void setComputeResources(CfnComputeEnvironment.ComputeResourcesProperty value)
This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
public void setComputeResources(IResolvable value)
This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
public java.lang.Object getEksConfiguration()
public void setEksConfiguration(IResolvable value)
public void setEksConfiguration(CfnComputeEnvironment.EksConfigurationProperty value)
public java.lang.Object getReplaceComputeEnvironment()
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
.
public void setReplaceComputeEnvironment(java.lang.Boolean value)
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
.
public void setReplaceComputeEnvironment(IResolvable value)
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
.
public java.lang.String getServiceRole()
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 theservice-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
public void setServiceRole(java.lang.String value)
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 theservice-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
public java.lang.String getState()
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.
public void setState(java.lang.String value)
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.
public java.lang.Number getUnmanagedvCpus()
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 toUNMANAGED
.
public void setUnmanagedvCpus(java.lang.Number value)
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 toUNMANAGED
.
public java.lang.Object getUpdatePolicy()
For more information about infrastructure updates, see Updating compute environments in the AWS Batch User Guide .
public void setUpdatePolicy(IResolvable value)
For more information about infrastructure updates, see Updating compute environments in the AWS Batch User Guide .
public void setUpdatePolicy(CfnComputeEnvironment.UpdatePolicyProperty value)
For more information about infrastructure updates, see Updating compute environments in the AWS Batch User Guide .