Class: Aws::Batch::Types::ContainerOverrides

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 ContainerOverrides data as a hash:

{
  vcpus: 1,
  memory: 1,
  command: ["String"],
  instance_type: "String",
  environment: [
    {
      name: "String",
      value: "String",
    },
  ],
  resource_requirements: [
    {
      value: "String", # required
      type: "GPU", # required, accepts GPU, VCPU, MEMORY
    },
  ],
}

The overrides that should be sent to a container.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#commandArray<String>

The command to send to the container that overrides the default command from the Docker image or the job definition.

Returns:

  • (Array<String>)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1207

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

#environmentArray<Types::KeyValuePair>

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

Returns:



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1207

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

Returns:

  • (String)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1207

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

#memoryInteger

This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

Returns:

  • (Integer)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1207

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

#resource_requirementsArray<Types::ResourceRequirement>

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

Returns:



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1207

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

#vcpusInteger

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

Returns:

  • (Integer)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1207

class ContainerOverrides < Struct.new(
  :vcpus,
  :memory,
  :command,
  :instance_type,
  :environment,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end