Package software.amazon.awscdk.cfnpropertymixins.services.batch

Class CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.batch.CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty>

Enclosing interface:

CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty

@Stability(Stable)
public static final class CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty>

A builder for CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty	build()	Builds the configured instance.
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	containers(List<? extends Object> containers)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getContainers()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	containers(IResolvable containers)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getContainers()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getEnableExecuteCommand()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	enableExecuteCommand(IResolvable enableExecuteCommand)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getEnableExecuteCommand()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	ephemeralStorage(CfnJobDefinitionPropsMixin.EphemeralStorageProperty ephemeralStorage)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getEphemeralStorage()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	ephemeralStorage(IResolvable ephemeralStorage)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getEphemeralStorage()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	executionRoleArn(String executionRoleArn)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getExecutionRoleArn()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	ipcMode(String ipcMode)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getIpcMode()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	networkConfiguration(CfnJobDefinitionPropsMixin.NetworkConfigurationProperty networkConfiguration)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getNetworkConfiguration()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	networkConfiguration(IResolvable networkConfiguration)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getNetworkConfiguration()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	pidMode(String pidMode)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getPidMode()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	platformVersion(String platformVersion)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getPlatformVersion()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	runtimePlatform(CfnJobDefinitionPropsMixin.RuntimePlatformProperty runtimePlatform)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getRuntimePlatform()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	runtimePlatform(IResolvable runtimePlatform)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getRuntimePlatform()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	taskRoleArn(String taskRoleArn)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getTaskRoleArn()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	volumes(List<? extends Object> volumes)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getVolumes()
CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder	volumes(IResolvable volumes)	Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getVolumes()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

containers

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder containers(IResolvable containers)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getContainers()

Parameters:

containers - This object is a list of containers.

Returns:

this

containers

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder containers(List<? extends Object> containers)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getContainers()

Parameters:

containers - This object is a list of containers.

Returns:

this

enableExecuteCommand

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Determines whether execute command functionality is turned on for this task. If true , execute command functionality is turned on all the containers in the task.

Returns:

this

enableExecuteCommand

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder enableExecuteCommand(IResolvable enableExecuteCommand)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Determines whether execute command functionality is turned on for this task. If true , execute command functionality is turned on all the containers in the task.

Returns:

this

ephemeralStorage

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder ephemeralStorage(IResolvable ephemeralStorage)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getEphemeralStorage()

Parameters:

ephemeralStorage - The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .

Returns:

this

ephemeralStorage

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder ephemeralStorage(CfnJobDefinitionPropsMixin.EphemeralStorageProperty ephemeralStorage)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getEphemeralStorage()

Parameters:

ephemeralStorage - The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .

Returns:

this

executionRoleArn

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder executionRoleArn(String executionRoleArn)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getExecutionRoleArn()

Parameters:

executionRoleArn - The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide .

Returns:

this

ipcMode

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder ipcMode(String ipcMode)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getIpcMode()

Parameters:

ipcMode - The IPC resource namespace to use for the containers in the task. The valid values are host , task , or none .

If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same IPC resources.

If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.

If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

Returns:

this

networkConfiguration

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder networkConfiguration(IResolvable networkConfiguration)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getNetworkConfiguration()

Parameters:

networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns:

this

networkConfiguration

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder networkConfiguration(CfnJobDefinitionPropsMixin.NetworkConfigurationProperty networkConfiguration)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getNetworkConfiguration()

Parameters:

networkConfiguration - The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns:

this

pidMode

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder pidMode(String pidMode)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getPidMode()

Parameters:

pidMode - The process namespace to use for the containers in the task. The valid values are host or task . For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

Returns:

this

platformVersion

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder platformVersion(String platformVersion)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getPlatformVersion()

Parameters:

platformVersion - The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide .

Returns:

this

runtimePlatform

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder runtimePlatform(IResolvable runtimePlatform)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getRuntimePlatform()

Parameters:

runtimePlatform - An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Returns:

this

runtimePlatform

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder runtimePlatform(CfnJobDefinitionPropsMixin.RuntimePlatformProperty runtimePlatform)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getRuntimePlatform()

Parameters:

runtimePlatform - An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Returns:

this

taskRoleArn

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder taskRoleArn(String taskRoleArn)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getTaskRoleArn()

Parameters:

taskRoleArn - The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

This is object is comparable to ContainerProperties:jobRoleArn .

Returns:

this

volumes

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder volumes(IResolvable volumes)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getVolumes()

Parameters:

volumes - A list of volumes that are associated with the job.

Returns:

this

volumes

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.Builder volumes(List<? extends Object> volumes)

Sets the value of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty.getVolumes()

Parameters:

volumes - A list of volumes that are associated with the job.

Returns:

this

build

@Stability(Stable)
public CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty>

Returns:

a new instance of CfnJobDefinitionPropsMixin.EcsTaskPropertiesProperty

Throws:

NullPointerException - if any required attribute was not provided