| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Batch.CreateComputeEnvironment
Description
Creates an Batch compute environment. You can create MANAGED or
UNMANAGED compute environments. MANAGED compute environments can use
Amazon EC2 or Fargate resources. UNMANAGED compute environments can
only use EC2 resources.
In a managed compute environment, 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. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can 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 less than a specified percentage of the On-Demand price.
Multi-node parallel jobs aren't 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 AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, 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.
Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, 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.
Synopsis
- data CreateComputeEnvironment = CreateComputeEnvironment' {}
- newCreateComputeEnvironment :: Text -> CEType -> CreateComputeEnvironment
- createComputeEnvironment_state :: Lens' CreateComputeEnvironment (Maybe CEState)
- createComputeEnvironment_computeResources :: Lens' CreateComputeEnvironment (Maybe ComputeResource)
- createComputeEnvironment_serviceRole :: Lens' CreateComputeEnvironment (Maybe Text)
- createComputeEnvironment_tags :: Lens' CreateComputeEnvironment (Maybe (HashMap Text Text))
- createComputeEnvironment_computeEnvironmentName :: Lens' CreateComputeEnvironment Text
- createComputeEnvironment_type :: Lens' CreateComputeEnvironment CEType
- data CreateComputeEnvironmentResponse = CreateComputeEnvironmentResponse' {}
- newCreateComputeEnvironmentResponse :: Int -> CreateComputeEnvironmentResponse
- createComputeEnvironmentResponse_computeEnvironmentName :: Lens' CreateComputeEnvironmentResponse (Maybe Text)
- createComputeEnvironmentResponse_computeEnvironmentArn :: Lens' CreateComputeEnvironmentResponse (Maybe Text)
- createComputeEnvironmentResponse_httpStatus :: Lens' CreateComputeEnvironmentResponse Int
Creating a Request
data CreateComputeEnvironment Source #
Contains the parameters for CreateComputeEnvironment.
See: newCreateComputeEnvironment smart constructor.
Constructors
| CreateComputeEnvironment' | |
Fields
| |
Instances
newCreateComputeEnvironment Source #
Arguments
| :: Text | |
| -> CEType | |
| -> CreateComputeEnvironment |
Create a value of CreateComputeEnvironment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:CreateComputeEnvironment', createComputeEnvironment_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.
If the state is ENABLED, then the 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 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. However, they scale in to minvCpus
value after instances become idle.
$sel:computeResources:CreateComputeEnvironment', createComputeEnvironment_computeResources - Details about the compute resources managed by the compute environment.
This parameter is required for managed compute environments. For more
information, see
Compute Environments
in the Batch User Guide.
$sel:serviceRole:CreateComputeEnvironment', createComputeEnvironment_serviceRole - The full Amazon Resource Name (ARN) of the IAM role that allows Batch to
make calls to other Amazon Web Services services on your behalf. For
more information, see
Batch service IAM role
in the Batch User Guide.
If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the 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/
then you would 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 Batch service role, its ARN might
contain the service-role path prefix. When you only specify the name
of the service role, 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.
$sel:tags:CreateComputeEnvironment', createComputeEnvironment_tags - The tags that you apply to the compute environment to help you
categorize and organize your resources. Each tag consists of a key and
an optional value. For more information, see
Tagging Amazon Web Services Resources
in Amazon Web Services General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
$sel:computeEnvironmentName:CreateComputeEnvironment', createComputeEnvironment_computeEnvironmentName - The name for your compute environment. Up to 128 letters (uppercase and
lowercase), numbers, hyphens, and underscores are allowed.
$sel:type':CreateComputeEnvironment', createComputeEnvironment_type - The type of the compute environment: MANAGED or UNMANAGED. For more
information, see
Compute Environments
in the Batch User Guide.
Request Lenses
createComputeEnvironment_state :: Lens' CreateComputeEnvironment (Maybe CEState) Source #
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.
If the state is ENABLED, then the 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 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. However, they scale in to minvCpus
value after instances become idle.
createComputeEnvironment_computeResources :: Lens' CreateComputeEnvironment (Maybe ComputeResource) Source #
Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the Batch User Guide.
createComputeEnvironment_serviceRole :: Lens' CreateComputeEnvironment (Maybe Text) Source #
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the 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/
then you would 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 Batch service role, its ARN might
contain the service-role path prefix. When you only specify the name
of the service role, 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.
createComputeEnvironment_tags :: Lens' CreateComputeEnvironment (Maybe (HashMap Text Text)) Source #
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
createComputeEnvironment_computeEnvironmentName :: Lens' CreateComputeEnvironment Text Source #
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
createComputeEnvironment_type :: Lens' CreateComputeEnvironment CEType Source #
The type of the compute environment: MANAGED or UNMANAGED. For more
information, see
Compute Environments
in the Batch User Guide.
Destructuring the Response
data CreateComputeEnvironmentResponse Source #
See: newCreateComputeEnvironmentResponse smart constructor.
Constructors
| CreateComputeEnvironmentResponse' | |
Fields
| |
Instances
newCreateComputeEnvironmentResponse Source #
Create a value of CreateComputeEnvironmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computeEnvironmentName:CreateComputeEnvironment', createComputeEnvironmentResponse_computeEnvironmentName - The name of the compute environment. Up to 128 letters (uppercase and
lowercase), numbers, hyphens, and underscores are allowed.
$sel:computeEnvironmentArn:CreateComputeEnvironmentResponse', createComputeEnvironmentResponse_computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.
$sel:httpStatus:CreateComputeEnvironmentResponse', createComputeEnvironmentResponse_httpStatus - The response's http status code.
Response Lenses
createComputeEnvironmentResponse_computeEnvironmentName :: Lens' CreateComputeEnvironmentResponse (Maybe Text) Source #
The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
createComputeEnvironmentResponse_computeEnvironmentArn :: Lens' CreateComputeEnvironmentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the compute environment.
createComputeEnvironmentResponse_httpStatus :: Lens' CreateComputeEnvironmentResponse Int Source #
The response's http status code.