Package software.amazon.awscdk.services.ecs.patterns

Class ScheduledEc2TaskImageOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.patterns.ScheduledEc2TaskImageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ScheduledEc2TaskImageOptions>

Enclosing interface:

ScheduledEc2TaskImageOptions

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

A builder for ScheduledEc2TaskImageOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ScheduledEc2TaskImageOptions	build()	Builds the configured instance.
ScheduledEc2TaskImageOptions.Builder	command(List<String> command)	Sets the value of ScheduledTaskImageProps.getCommand()
ScheduledEc2TaskImageOptions.Builder	containerName(String containerName)	Sets the value of ScheduledTaskImageProps.getContainerName()
ScheduledEc2TaskImageOptions.Builder	cpu(Number cpu)	Sets the value of ScheduledEc2TaskImageOptions.getCpu()
ScheduledEc2TaskImageOptions.Builder	environment(Map<String,String> environment)	Sets the value of ScheduledTaskImageProps.getEnvironment()
ScheduledEc2TaskImageOptions.Builder	image(ContainerImage image)	Sets the value of ScheduledTaskImageProps.getImage()
ScheduledEc2TaskImageOptions.Builder	logDriver(LogDriver logDriver)	Sets the value of ScheduledTaskImageProps.getLogDriver()
ScheduledEc2TaskImageOptions.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of ScheduledEc2TaskImageOptions.getMemoryLimitMiB()
ScheduledEc2TaskImageOptions.Builder	memoryReservationMiB(Number memoryReservationMiB)	Sets the value of ScheduledEc2TaskImageOptions.getMemoryReservationMiB()
ScheduledEc2TaskImageOptions.Builder	secrets(Map<String,? extends Secret> secrets)	Sets the value of ScheduledTaskImageProps.getSecrets()

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

cpu

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

Sets the value of ScheduledEc2TaskImageOptions.getCpu()

Parameters:

cpu - The minimum number of CPU units to reserve for the container.

Returns:

this

memoryLimitMiB

@Stability(Stable)
public ScheduledEc2TaskImageOptions.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of ScheduledEc2TaskImageOptions.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

Returns:

this

memoryReservationMiB

@Stability(Stable)
public ScheduledEc2TaskImageOptions.Builder memoryReservationMiB(Number memoryReservationMiB)

Sets the value of ScheduledEc2TaskImageOptions.getMemoryReservationMiB()

Parameters:

memoryReservationMiB - The soft limit (in MiB) of memory to reserve for the container. When system memory is under contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

Returns:

this

image

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

Sets the value of ScheduledTaskImageProps.getImage()

Parameters:

image - The image used to start a container. This parameter is required. Image or taskDefinition must be specified, but not both.

Returns:

this

command

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

Sets the value of ScheduledTaskImageProps.getCommand()

Parameters:

command - The command that is passed to the container. If you provide a shell command as a single string, you have to quote command-line arguments.

Returns:

this

containerName

@Stability(Stable)
public ScheduledEc2TaskImageOptions.Builder containerName(String containerName)

Sets the value of ScheduledTaskImageProps.getContainerName()

Parameters:

containerName - Optional name for the container added.

Returns:

this

environment

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

Sets the value of ScheduledTaskImageProps.getEnvironment()

Parameters:

environment - The environment variables to pass to the container.

Returns:

this

logDriver

@Stability(Stable)
public ScheduledEc2TaskImageOptions.Builder logDriver(LogDriver logDriver)

Sets the value of ScheduledTaskImageProps.getLogDriver()

Parameters:

logDriver - The log driver to use.

Returns:

this

secrets

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

Sets the value of ScheduledTaskImageProps.getSecrets()

Parameters:

secrets - The secret to expose to the container as an environment variable.

Returns:

this

build

@Stability(Stable)
public ScheduledEc2TaskImageOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ScheduledEc2TaskImageOptions

Throws:

NullPointerException - if any required attribute was not provided