Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Batch.CreateComputeEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 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.

To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster.

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your 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, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:

Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.
Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE or SPOT_CAPACITY_OPTIMIZED.
Set the update to latest image version (updateToLatestImageVersion) parameter to true.
Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest).

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.

Synopsis

Creating a Request

data CreateComputeEnvironment Source #

Contains the parameters for CreateComputeEnvironment.

See: newCreateComputeEnvironment smart constructor.

Constructors

CreateComputeEnvironment'

Fields

computeResources :: Maybe ComputeResource
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.
eksConfiguration :: Maybe EksConfiguration
The details for the Amazon EKS cluster that supports the compute environment.
serviceRole :: Maybe Text
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/, 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.
state :: Maybe CEState
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.
tags :: Maybe (HashMap Text Text)
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.
unmanagedvCpus :: Maybe Int
The maximum number of vCPUs for an unmanaged compute environment. 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.
computeEnvironmentName :: Text
The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
type' :: CEType
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.

Instances

Instances details

ToJSON CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods toJSON :: CreateComputeEnvironment -> Value # toEncoding :: CreateComputeEnvironment -> Encoding # toJSONList :: [CreateComputeEnvironment] -> Value # toEncodingList :: [CreateComputeEnvironment] -> Encoding #
ToHeaders CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods toHeaders :: CreateComputeEnvironment -> [Header] #
ToPath CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods toPath :: CreateComputeEnvironment -> ByteString #
ToQuery CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods toQuery :: CreateComputeEnvironment -> QueryString #
AWSRequest CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Associated Types type AWSResponse CreateComputeEnvironment # Methods request :: (Service -> Service) -> CreateComputeEnvironment -> Request CreateComputeEnvironment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateComputeEnvironment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateComputeEnvironment))) #
Generic CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Associated Types type Rep CreateComputeEnvironment :: Type -> Type # Methods from :: CreateComputeEnvironment -> Rep CreateComputeEnvironment x # to :: Rep CreateComputeEnvironment x -> CreateComputeEnvironment #
Read CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods readsPrec :: Int -> ReadS CreateComputeEnvironment # readList :: ReadS [CreateComputeEnvironment] # readPrec :: ReadPrec CreateComputeEnvironment # readListPrec :: ReadPrec [CreateComputeEnvironment] #
Show CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods showsPrec :: Int -> CreateComputeEnvironment -> ShowS # show :: CreateComputeEnvironment -> String # showList :: [CreateComputeEnvironment] -> ShowS #
NFData CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods rnf :: CreateComputeEnvironment -> () #
Eq CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods (==) :: CreateComputeEnvironment -> CreateComputeEnvironment -> Bool # (/=) :: CreateComputeEnvironment -> CreateComputeEnvironment -> Bool #
Hashable CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods hashWithSalt :: Int -> CreateComputeEnvironment -> Int # hash :: CreateComputeEnvironment -> Int #
type AWSResponse CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment type AWSResponse CreateComputeEnvironment = CreateComputeEnvironmentResponse
type Rep CreateComputeEnvironment Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment type Rep CreateComputeEnvironment = D1 ('MetaData "CreateComputeEnvironment" "Amazonka.Batch.CreateComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CreateComputeEnvironment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "computeResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeResource)) :: S1 ('MetaSel ('Just "eksConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksConfiguration))) :: (S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CEState)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "unmanagedvCpus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "computeEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CEType)))))

newCreateComputeEnvironment Source #

Arguments

:: Text	`CreateComputeEnvironment`
-> CEType	`CreateComputeEnvironment`
-> 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:

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.

CreateComputeEnvironment, createComputeEnvironment_eksConfiguration - The details for the Amazon EKS cluster that supports the compute environment.

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/, 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, 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.

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.

CreateComputeEnvironment, createComputeEnvironment_unmanagedvCpus - The maximum number of vCPUs for an unmanaged compute environment. 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.

CreateComputeEnvironment, createComputeEnvironment_computeEnvironmentName - The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

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_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_eksConfiguration :: Lens' CreateComputeEnvironment (Maybe EksConfiguration) Source #

The details for the Amazon EKS cluster that supports the compute environment.

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/, 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_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_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_unmanagedvCpus :: Lens' CreateComputeEnvironment (Maybe Int) Source #

The maximum number of vCPUs for an unmanaged compute environment. 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.

createComputeEnvironment_computeEnvironmentName :: Lens' CreateComputeEnvironment Text Source #

The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

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 computeEnvironmentArn :: Maybe Text The Amazon Resource Name (ARN) of the compute environment. computeEnvironmentName :: Maybe Text The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateComputeEnvironmentResponse Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Associated Types type Rep CreateComputeEnvironmentResponse :: Type -> Type # Methods from :: CreateComputeEnvironmentResponse -> Rep CreateComputeEnvironmentResponse x # to :: Rep CreateComputeEnvironmentResponse x -> CreateComputeEnvironmentResponse #
Read CreateComputeEnvironmentResponse Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods readsPrec :: Int -> ReadS CreateComputeEnvironmentResponse # readList :: ReadS [CreateComputeEnvironmentResponse] # readPrec :: ReadPrec CreateComputeEnvironmentResponse # readListPrec :: ReadPrec [CreateComputeEnvironmentResponse] #
Show CreateComputeEnvironmentResponse Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods showsPrec :: Int -> CreateComputeEnvironmentResponse -> ShowS # show :: CreateComputeEnvironmentResponse -> String # showList :: [CreateComputeEnvironmentResponse] -> ShowS #
NFData CreateComputeEnvironmentResponse Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods rnf :: CreateComputeEnvironmentResponse -> () #
Eq CreateComputeEnvironmentResponse Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment Methods (==) :: CreateComputeEnvironmentResponse -> CreateComputeEnvironmentResponse -> Bool # (/=) :: CreateComputeEnvironmentResponse -> CreateComputeEnvironmentResponse -> Bool #
type Rep CreateComputeEnvironmentResponse Source #
Instance details Defined in Amazonka.Batch.CreateComputeEnvironment type Rep CreateComputeEnvironmentResponse = D1 ('MetaData "CreateComputeEnvironmentResponse" "Amazonka.Batch.CreateComputeEnvironment" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CreateComputeEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "computeEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateComputeEnvironmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateComputeEnvironmentResponse'`
-> CreateComputeEnvironmentResponse

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:

CreateComputeEnvironmentResponse, createComputeEnvironmentResponse_computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.

CreateComputeEnvironment, createComputeEnvironmentResponse_computeEnvironmentName - The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

$sel:httpStatus:CreateComputeEnvironmentResponse', createComputeEnvironmentResponse_httpStatus - The response's http status code.

Response Lenses

createComputeEnvironmentResponse_computeEnvironmentArn :: Lens' CreateComputeEnvironmentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the compute environment.

createComputeEnvironmentResponse_computeEnvironmentName :: Lens' CreateComputeEnvironmentResponse (Maybe Text) Source #

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

createComputeEnvironmentResponse_httpStatus :: Lens' CreateComputeEnvironmentResponse Int Source #

The response's http status code.