Class CfnPipePropsMixin.BatchContainerOverridesProperty

The overrides that are sent to a container.

Inheritance

object

CfnPipePropsMixin.BatchContainerOverridesProperty

Implements

CfnPipePropsMixin.IBatchContainerOverridesProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Pipes.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnPipePropsMixin.BatchContainerOverridesProperty : CfnPipePropsMixin.IBatchContainerOverridesProperty

Syntax (vb)

Public Class CfnPipePropsMixin.BatchContainerOverridesProperty Implements CfnPipePropsMixin.IBatchContainerOverridesProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html

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.Mixins.Preview.AWS.Pipes.Mixins;

             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()

The overrides that are sent to a container.

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()

The overrides that are sent to a container.

public BatchContainerOverridesProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html

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.Mixins.Preview.AWS.Pipes.Mixins;

             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"
                 } }
             };

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

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html#cfn-pipes-pipe-batchcontaineroverrides-command

Environment

The environment variables to send to the container.

public object? Environment { get; set; }

Property Value

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 " <code>AWS Batch</code> ". This naming convention is reserved for variables that AWS Batch sets.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html#cfn-pipes-pipe-batchcontaineroverrides-environment

Type union: either IResolvable or (either IResolvable or CfnPipePropsMixin.IBatchEnvironmentVariableProperty)[]

InstanceType

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

public string? InstanceType { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html#cfn-pipes-pipe-batchcontaineroverrides-instancetype

ResourceRequirements

The type and amount of resources to assign to a container.

public object? ResourceRequirements { get; set; }

Property Value

object

Remarks

This overrides the settings in the job definition. The supported resources include GPU , MEMORY , and VCPU .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html#cfn-pipes-pipe-batchcontaineroverrides-resourcerequirements

Type union: either IResolvable or (either IResolvable or CfnPipePropsMixin.IBatchResourceRequirementProperty)[]

Implements

CfnPipePropsMixin.IBatchContainerOverridesProperty