Package software.amazon.awscdk.services.batch

Class EcsFargateContainerDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.EcsFargateContainerDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsFargateContainerDefinitionProps>

Enclosing interface:

EcsFargateContainerDefinitionProps

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

A builder for EcsFargateContainerDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EcsFargateContainerDefinitionProps.Builder	assignPublicIp(Boolean assignPublicIp)	Sets the value of EcsFargateContainerDefinitionProps.getAssignPublicIp()
EcsFargateContainerDefinitionProps	build()	Builds the configured instance.
EcsFargateContainerDefinitionProps.Builder	command(List<String> command)	Sets the value of EcsContainerDefinitionProps.getCommand()
EcsFargateContainerDefinitionProps.Builder	cpu(Number cpu)	Sets the value of EcsContainerDefinitionProps.getCpu()
EcsFargateContainerDefinitionProps.Builder	environment(Map<String,String> environment)	Sets the value of EcsContainerDefinitionProps.getEnvironment()
EcsFargateContainerDefinitionProps.Builder	ephemeralStorageSize(Size ephemeralStorageSize)	Sets the value of EcsFargateContainerDefinitionProps.getEphemeralStorageSize()
EcsFargateContainerDefinitionProps.Builder	executionRole(IRole executionRole)	Sets the value of EcsContainerDefinitionProps.getExecutionRole()
EcsFargateContainerDefinitionProps.Builder	fargateCpuArchitecture(CpuArchitecture fargateCpuArchitecture)	Sets the value of EcsFargateContainerDefinitionProps.getFargateCpuArchitecture()
EcsFargateContainerDefinitionProps.Builder	fargateOperatingSystemFamily(OperatingSystemFamily fargateOperatingSystemFamily)	Sets the value of EcsFargateContainerDefinitionProps.getFargateOperatingSystemFamily()
EcsFargateContainerDefinitionProps.Builder	fargatePlatformVersion(FargatePlatformVersion fargatePlatformVersion)	Sets the value of EcsFargateContainerDefinitionProps.getFargatePlatformVersion()
EcsFargateContainerDefinitionProps.Builder	image(ContainerImage image)	Sets the value of EcsContainerDefinitionProps.getImage()
EcsFargateContainerDefinitionProps.Builder	jobRole(IRole jobRole)	Sets the value of EcsContainerDefinitionProps.getJobRole()
EcsFargateContainerDefinitionProps.Builder	linuxParameters(LinuxParameters linuxParameters)	Sets the value of EcsContainerDefinitionProps.getLinuxParameters()
EcsFargateContainerDefinitionProps.Builder	logging(LogDriver logging)	Sets the value of EcsContainerDefinitionProps.getLogging()
EcsFargateContainerDefinitionProps.Builder	memory(Size memory)	Sets the value of EcsContainerDefinitionProps.getMemory()
EcsFargateContainerDefinitionProps.Builder	readonlyRootFilesystem(Boolean readonlyRootFilesystem)	Sets the value of EcsContainerDefinitionProps.getReadonlyRootFilesystem()
EcsFargateContainerDefinitionProps.Builder	secrets(Map<String,? extends Secret> secrets)	Sets the value of EcsContainerDefinitionProps.getSecrets()
EcsFargateContainerDefinitionProps.Builder	user(String user)	Sets the value of EcsContainerDefinitionProps.getUser()
EcsFargateContainerDefinitionProps.Builder	volumes(List<? extends EcsVolume> volumes)	Sets the value of EcsContainerDefinitionProps.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

assignPublicIp

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder assignPublicIp(Boolean assignPublicIp)

Sets the value of EcsFargateContainerDefinitionProps.getAssignPublicIp()

Parameters:

assignPublicIp - Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet.

Returns:

this

ephemeralStorageSize

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder ephemeralStorageSize(Size ephemeralStorageSize)

Sets the value of EcsFargateContainerDefinitionProps.getEphemeralStorageSize()

Parameters:

ephemeralStorageSize - The size for ephemeral storage.

Returns:

this

fargateCpuArchitecture

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder fargateCpuArchitecture(CpuArchitecture fargateCpuArchitecture)

Sets the value of EcsFargateContainerDefinitionProps.getFargateCpuArchitecture()

Parameters:

fargateCpuArchitecture - The vCPU architecture of Fargate Runtime.

Returns:

this

fargateOperatingSystemFamily

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder fargateOperatingSystemFamily(OperatingSystemFamily fargateOperatingSystemFamily)

Sets the value of EcsFargateContainerDefinitionProps.getFargateOperatingSystemFamily()

Parameters:

fargateOperatingSystemFamily - The operating system for the compute environment.

Returns:

this

fargatePlatformVersion

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder fargatePlatformVersion(FargatePlatformVersion fargatePlatformVersion)

Sets the value of EcsFargateContainerDefinitionProps.getFargatePlatformVersion()

Parameters:

fargatePlatformVersion - Which version of Fargate to use when running this container.

Returns:

this

cpu

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder cpu(Number cpu)

Sets the value of EcsContainerDefinitionProps.getCpu()

Parameters:

cpu - The number of vCPUs reserved for the container. This parameter is required. Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.

Returns:

this

image

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder image(ContainerImage image)

Sets the value of EcsContainerDefinitionProps.getImage()

Parameters:

image - The image that this container will run. This parameter is required.

Returns:

this

memory

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder memory(Size memory)

Sets the value of EcsContainerDefinitionProps.getMemory()

Parameters:

memory - The memory hard limit present to the container. This parameter is required. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job.

Returns:

this

command

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder command(List<String> command)

Sets the value of EcsContainerDefinitionProps.getCommand()

Parameters:

command - The command that's passed to the container.

Returns:

this

environment

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder environment(Map<String,String> environment)

Sets the value of EcsContainerDefinitionProps.getEnvironment()

Parameters:

environment - The environment variables to pass to a container. Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Returns:

this

executionRole

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder executionRole(IRole executionRole)

Sets the value of EcsContainerDefinitionProps.getExecutionRole()

Parameters:

executionRole - The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.

Returns:

this

jobRole

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder jobRole(IRole jobRole)

Sets the value of EcsContainerDefinitionProps.getJobRole()

Parameters:

jobRole - The role that the container can assume.

Returns:

this

linuxParameters

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder linuxParameters(LinuxParameters linuxParameters)

Sets the value of EcsContainerDefinitionProps.getLinuxParameters()

Parameters:

linuxParameters - Linux-specific modifications that are applied to the container, such as details for device mappings.

Returns:

this

logging

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder logging(LogDriver logging)

Sets the value of EcsContainerDefinitionProps.getLogging()

Parameters:

logging - The loging configuration for this Job.

Returns:

this

readonlyRootFilesystem

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder readonlyRootFilesystem(Boolean readonlyRootFilesystem)

Sets the value of EcsContainerDefinitionProps.getReadonlyRootFilesystem()

Parameters:

readonlyRootFilesystem - Gives the container readonly access to its root filesystem.

Returns:

this

secrets

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder secrets(Map<String,? extends Secret> secrets)

Sets the value of EcsContainerDefinitionProps.getSecrets()

Parameters:

secrets - A map from environment variable names to the secrets for the container. Allows your job definitions to reference the secret by the environment variable name defined in this property.

Returns:

this

user

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder user(String user)

Sets the value of EcsContainerDefinitionProps.getUser()

Parameters:

user - The user name to use inside the container.

Returns:

this

volumes

@Stability(Stable)
public EcsFargateContainerDefinitionProps.Builder volumes(List<? extends EcsVolume> volumes)

Sets the value of EcsContainerDefinitionProps.getVolumes()

Parameters:

volumes - The volumes to mount to this container. Automatically added to the job definition.

Returns:

this

build

@Stability(Stable)
public EcsFargateContainerDefinitionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<EcsFargateContainerDefinitionProps>

Returns:

a new instance of EcsFargateContainerDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided