Package software.amazon.awscdk.services.pipes

Interface CfnPipe.BatchContainerOverridesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.BatchContainerOverridesProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.BatchContainerOverridesProperty
extends software.amazon.jsii.JsiiSerializable

The overrides that are sent to a container.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 BatchContainerOverridesProperty batchContainerOverridesProperty = BatchContainerOverridesProperty.builder()
         .command(List.of("command"))
         .environment(List.of(BatchEnvironmentVariableProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .instanceType("instanceType")
         .resourceRequirements(List.of(BatchResourceRequirementProperty.builder()
                 .type("type")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.BatchContainerOverridesProperty.Builder	A builder for CfnPipe.BatchContainerOverridesProperty
static final class	CfnPipe.BatchContainerOverridesProperty.Jsii$Proxy	An implementation for CfnPipe.BatchContainerOverridesProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.BatchContainerOverridesProperty.Builder	builder()
default List<String>	getCommand()	The command to send to the container that overrides the default command from the Docker image or the task definition.
default Object	getEnvironment()	The environment variables to send to the container.
default String	getInstanceType()	The instance type to use for a multi-node parallel job.
default Object	getResourceRequirements()	The type and amount of resources to assign to a container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

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

See Also:

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

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

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 task definition.

Environment variables cannot start with " AWS Batch ". This naming convention is reserved for variables that AWS Batch sets.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipe.BatchEnvironmentVariableProperty>

See Also:

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

getInstanceType

@Stability(Stable)
@Nullable
default String getInstanceType()

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.

See Also:

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

getResourceRequirements

@Stability(Stable)
@Nullable
default Object getResourceRequirements()

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipe.BatchResourceRequirementProperty>

See Also:

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

builder

@Stability(Stable)
static CfnPipe.BatchContainerOverridesProperty.Builder builder()

Returns:

a CfnPipe.BatchContainerOverridesProperty.Builder of CfnPipe.BatchContainerOverridesProperty