Interface IBatchContainerOverrides
The overrides that should be sent to a container.
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBatchContainerOverrides
Syntax (vb)
Public Interface IBatchContainerOverrides
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.StepFunctions.Tasks;
InstanceType instanceType;
Size size;
var batchContainerOverrides = new BatchContainerOverrides {
Command = new [] { "command" },
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
},
GpuCount = 123,
InstanceType = instanceType,
Memory = size,
Vcpus = 123
};
Synopsis
Properties
Command | The command to send to the container that overrides the default command from the Docker image or the job definition. |
Environment | The environment variables to send to the container. |
GpuCount | The number of physical GPUs to reserve for the container. |
InstanceType | The instance type to use for a multi-node parallel job. |
Memory | Memory reserved for the job. |
Vcpus | The number of vCPUs to reserve for the container. |
Properties
Command
The command to send to the container that overrides the default command from the Docker image or the job definition.
virtual string[] Command { get; }
Property Value
System.String[]
Remarks
Default: - No command overrides
Environment
The environment variables to send to the container.
virtual IDictionary<string, string> Environment { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
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.
Default: - No environment overrides
GpuCount
The number of physical GPUs to reserve for the container.
virtual Nullable<double> GpuCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
Default: - No GPU reservation
InstanceType
The instance type to use for a multi-node parallel job.
virtual InstanceType InstanceType { get; }
Property Value
Remarks
This parameter is not valid for single-node container jobs.
Default: - No instance type overrides
Memory
Memory reserved for the job.
virtual Size Memory { get; }
Property Value
Remarks
Default: - No memory overrides. The memory supplied in the job definition will be used.
Vcpus
The number of vCPUs to reserve for the container.
virtual Nullable<double> Vcpus { get; }
Property Value
System.Nullable<System.Double>
Remarks
This value overrides the value set in the job definition.
Default: - No vCPUs overrides