Class CfnPipe.BatchContainerOverridesProperty
The overrides that are sent to a container.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.AWS.Pipes.dll
Syntax (csharp)
public class BatchContainerOverridesProperty : Object, CfnPipe.IBatchContainerOverridesProperty
Syntax (vb)
Public Class BatchContainerOverridesProperty
Inherits Object
Implements CfnPipe.IBatchContainerOverridesProperty
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.AWS.Pipes;
var batchContainerOverridesProperty = new BatchContainerOverridesProperty {
Command = new [] { "command" },
Environment = new [] { new BatchEnvironmentVariableProperty {
Name = "name",
Value = "value"
} },
InstanceType = "instanceType",
ResourceRequirements = new [] { new BatchResourceRequirementProperty {
Type = "type",
Value = "value"
} }
};
Synopsis
Constructors
BatchContainerOverridesProperty() |
Properties
Command | The command to send to the container that overrides the default command from the Docker image or the task definition. |
Environment | The environment variables to send to the container. |
InstanceType | The instance type to use for a multi-node parallel job. |
ResourceRequirements | The type and amount of resources to assign to a container. |
Constructors
BatchContainerOverridesProperty()
public BatchContainerOverridesProperty()
Properties
Command
The command to send to the container that overrides the default command from the Docker image or the task definition.
public string[] Command { get; set; }
Property Value
System.String[]
Remarks
Environment
The environment variables to send to the container.
public object Environment { get; set; }
Property Value
System.Object
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 task definition.
Environment variables cannot start with " AWS Batch
". This naming convention is reserved for variables that AWS Batch sets.
InstanceType
The instance type to use for a multi-node parallel job.
public string InstanceType { get; set; }
Property Value
System.String
Remarks
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
ResourceRequirements
The type and amount of resources to assign to a container.
public object ResourceRequirements { get; set; }
Property Value
System.Object
Remarks
This overrides the settings in the job definition. The supported resources include GPU
, MEMORY
, and VCPU
.