You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateComputeEnvironmentRequest data as a hash:

{
  compute_environment_name: "String", # required
  type: "MANAGED", # required, accepts MANAGED, UNMANAGED
  state: "ENABLED", # accepts ENABLED, DISABLED
  compute_resources: {
    type: "EC2", # required, accepts EC2, SPOT
    minv_cpus: 1, # required
    maxv_cpus: 1, # required
    desiredv_cpus: 1,
    instance_types: ["String"], # required
    image_id: "String",
    subnets: ["String"], # required
    security_group_ids: ["String"],
    ec2_key_pair: "String",
    instance_role: "String", # required
    tags: {
      "String" => "String",
    },
    placement_group: "String",
    bid_percentage: 1,
    spot_iam_fleet_role: "String",
    launch_template: {
      launch_template_id: "String",
      launch_template_name: "String",
      version: "String",
    },
  },
  service_role: "String", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environment_nameString

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

  • (String)


1093
1094
1095
1096
1097
1098
1099
1100
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1093

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#compute_resourcesTypes::ComputeResource

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.



1093
1094
1095
1096
1097
1098
1099
1100
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1093

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#service_roleString

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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.

Returns:

  • (String)


1093
1094
1095
1096
1097
1098
1099
1100
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1093

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#stateString

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.

Returns:

  • (String)


1093
1094
1095
1096
1097
1098
1099
1100
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1093

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#typeString

The type of the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Returns:

  • (String)


1093
1094
1095
1096
1097
1098
1099
1100
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1093

class CreateComputeEnvironmentRequest < Struct.new(
  :compute_environment_name,
  :type,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end