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

Class ScheduledFargateTaskImageOptions.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ScheduledFargateTaskImageOptions>

Enclosing interface:

ScheduledFargateTaskImageOptions

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

A builder for ScheduledFargateTaskImageOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ScheduledFargateTaskImageOptions	build()	Builds the configured instance.
ScheduledFargateTaskImageOptions.Builder	command(List<String> command)	Sets the value of ScheduledTaskImageProps.getCommand()
ScheduledFargateTaskImageOptions.Builder	cpu(Number cpu)	Sets the value of ScheduledFargateTaskImageOptions.getCpu()
ScheduledFargateTaskImageOptions.Builder	environment(Map<String,String> environment)	Sets the value of ScheduledTaskImageProps.getEnvironment()
ScheduledFargateTaskImageOptions.Builder	image(ContainerImage image)	Sets the value of ScheduledTaskImageProps.getImage()
ScheduledFargateTaskImageOptions.Builder	logDriver(LogDriver logDriver)	Sets the value of ScheduledTaskImageProps.getLogDriver()
ScheduledFargateTaskImageOptions.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of ScheduledFargateTaskImageOptions.getMemoryLimitMiB()
ScheduledFargateTaskImageOptions.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 ScheduledFargateTaskImageOptions.Builder cpu(Number cpu)

Sets the value of ScheduledFargateTaskImageOptions.getCpu()

Parameters:

cpu - The number of cpu units used by the task. Valid values, which determines your range of valid values for the memory parameter:

256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

memoryLimitMiB

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

Sets the value of ScheduledFargateTaskImageOptions.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.

Returns:

this

image

@Stability(Stable)
public ScheduledFargateTaskImageOptions.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 ScheduledFargateTaskImageOptions.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

environment

@Stability(Stable)
public ScheduledFargateTaskImageOptions.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 ScheduledFargateTaskImageOptions.Builder logDriver(LogDriver logDriver)

Sets the value of ScheduledTaskImageProps.getLogDriver()

Parameters:

logDriver - The log driver to use.

Returns:

this

secrets

@Stability(Stable)
public ScheduledFargateTaskImageOptions.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 ScheduledFargateTaskImageOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ScheduledFargateTaskImageOptions

Throws:

NullPointerException - if any required attribute was not provided