Interface ContainerOverrides.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ContainerOverrides.Builder,
,ContainerOverrides> SdkBuilder<ContainerOverrides.Builder,
,ContainerOverrides> SdkPojo
- Enclosing class:
ContainerOverrides
-
Method Summary
Modifier and TypeMethodDescriptionThe command to send to the container that overrides the default command from the Docker image or the job definition.command
(Collection<String> command) The command to send to the container that overrides the default command from the Docker image or the job definition.environment
(Collection<KeyValuePair> environment) The environment variables to send to the container.environment
(Consumer<KeyValuePair.Builder>... environment) The environment variables to send to the container.environment
(KeyValuePair... environment) The environment variables to send to the container.instanceType
(String instanceType) The instance type to use for a multi-node parallel job.Deprecated.This field is deprecated, use resourceRequirements instead.resourceRequirements
(Collection<ResourceRequirement> resourceRequirements) The type and amount of resources to assign to a container.resourceRequirements
(Consumer<ResourceRequirement.Builder>... resourceRequirements) The type and amount of resources to assign to a container.resourceRequirements
(ResourceRequirement... resourceRequirements) The type and amount of resources to assign to a container.Deprecated.This field is deprecated, use resourceRequirements instead.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
vcpus
Deprecated.This field is deprecated, use resourceRequirements instead.This parameter is deprecated, use
resourceRequirements
to override thevcpus
parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides thevcpus
parameter set in the job definition, but doesn't override any vCPU requirement specified in theresourceRequirements
structure in the job definition. To override vCPU requirements that are specified in theresourceRequirements
structure in the job definition,resourceRequirements
must be specified in theSubmitJob
request, withtype
set toVCPU
andvalue
set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.- Parameters:
vcpus
- This parameter is deprecated, useresourceRequirements
to override thevcpus
parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides thevcpus
parameter set in the job definition, but doesn't override any vCPU requirement specified in theresourceRequirements
structure in the job definition. To override vCPU requirements that are specified in theresourceRequirements
structure in the job definition,resourceRequirements
must be specified in theSubmitJob
request, withtype
set toVCPU
andvalue
set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memory
Deprecated.This field is deprecated, use resourceRequirements instead.This parameter is deprecated, use
resourceRequirements
to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides thememory
parameter set in the job definition, but doesn't override any memory requirement that's specified in theresourceRequirements
structure in the job definition. To override memory requirements that are specified in theresourceRequirements
structure in the job definition,resourceRequirements
must be specified in theSubmitJob
request, withtype
set toMEMORY
andvalue
set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.- Parameters:
memory
- This parameter is deprecated, useresourceRequirements
to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides thememory
parameter set in the job definition, but doesn't override any memory requirement that's specified in theresourceRequirements
structure in the job definition. To override memory requirements that are specified in theresourceRequirements
structure in the job definition,resourceRequirements
must be specified in theSubmitJob
request, withtype
set toMEMORY
andvalue
set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
command
The command to send to the container that overrides the default command from the Docker image or the job definition.
This parameter can't contain an empty string.
- Parameters:
command
- The command to send to the container that overrides the default command from the Docker image or the job definition.This parameter can't contain an empty string.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
command
The command to send to the container that overrides the default command from the Docker image or the job definition.
This parameter can't contain an empty string.
- Parameters:
command
- The command to send to the container that overrides the default command from the Docker image or the job definition.This parameter can't contain an empty string.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceType
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.
- Parameters:
instanceType
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
environment
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 cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.- Parameters:
environment
- 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 cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environment
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 cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.- Parameters:
environment
- 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 cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environment
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 cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.KeyValuePair.Builder
avoiding the need to create one manually viaKeyValuePair.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironment(List<KeyValuePair>)
.- Parameters:
environment
- a consumer that will call methods onKeyValuePair.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
resourceRequirements
ContainerOverrides.Builder resourceRequirements(Collection<ResourceRequirement> resourceRequirements) 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
, andVCPU
.- Parameters:
resourceRequirements
- The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources includeGPU
,MEMORY
, andVCPU
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceRequirements
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
, andVCPU
.- Parameters:
resourceRequirements
- The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources includeGPU
,MEMORY
, andVCPU
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceRequirements
ContainerOverrides.Builder resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements) The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include
This is a convenience method that creates an instance of theGPU
,MEMORY
, andVCPU
.ResourceRequirement.Builder
avoiding the need to create one manually viaResourceRequirement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceRequirements(List<ResourceRequirement>)
.- Parameters:
resourceRequirements
- a consumer that will call methods onResourceRequirement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-