Class: Aws::Batch::Types::CreateComputeEnvironmentRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-batch/types.rb

Overview

Contains the parameters for ‘CreateComputeEnvironment`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environment_name ⇒ String

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 (_).

Returns:

  • (String) 


2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#compute_resources ⇒ Types::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*.

[1]: docs.aws.amazon.com/batch/latest/userguide/compute_environments.html

Returns:



2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#context ⇒ String

Reserved.

Returns:

  • (String) 


2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#eks_configuration ⇒ Types::EksConfiguration

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

Returns:



2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

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

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names

Returns:

  • (String) 


2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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.

<note markdown=“1”> 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 *Batch User Guide*.

</note>

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.

[1]: docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state

Returns:

  • (String) 


2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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][3

API operations. These tags don’t propagate to

the underlying compute resources.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html [2]: docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html [3]: docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html

Returns:

  • (Hash<String,String>) 


2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the compute environment: ‘MANAGED` or `UNMANAGED`. For more information, see [Compute Environments] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/compute_environments.html

Returns:

  • (String) 


2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#unmanagedv_cpus ⇒ Integer

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.

<note markdown=“1”> This parameter is only supported when the ‘type` parameter is set to `UNMANAGED`.

</note>

Returns:

  • (Integer) 


2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/aws-sdk-batch/types.rb', line 2228

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :tags,
  :eks_configuration,
  :context)
  SENSITIVE = []
  include Aws::Structure
end