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(value=Stable)
public static final class ScheduledFargateTaskImageOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ScheduledFargateTaskImageOptions>

A builder for ScheduledFargateTaskImageOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and 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 FargateServiceBaseProps.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 FargateServiceBaseProps.getMemoryLimitMiB()
ScheduledFargateTaskImageOptions.Builder	platformVersion(FargatePlatformVersion platformVersion) Sets the value of FargateServiceBaseProps.getPlatformVersion()
ScheduledFargateTaskImageOptions.Builder	runtimePlatform(RuntimePlatform runtimePlatform) Sets the value of FargateServiceBaseProps.getRuntimePlatform()
ScheduledFargateTaskImageOptions.Builder	secrets(Map<String,? extends Secret> secrets) Sets the value of ScheduledTaskImageProps.getSecrets()
ScheduledFargateTaskImageOptions.Builder	taskDefinition(FargateTaskDefinition taskDefinition) Sets the value of FargateServiceBaseProps.getTaskDefinition()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

image

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

Sets the value of ScheduledTaskImageProps.getLogDriver()

Parameters:

logDriver - The log driver to use.

Returns:

this

secrets

@Stability(value=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

cpu

@Stability(value=Stable)
public ScheduledFargateTaskImageOptions.Builder cpu(Number cpu)

Sets the value of FargateServiceBaseProps.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(value=Stable)
public ScheduledFargateTaskImageOptions.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of FargateServiceBaseProps.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The amount (in MiB) of memory used by the task. This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

platformVersion

@Stability(value=Stable)
public ScheduledFargateTaskImageOptions.Builder platformVersion(FargatePlatformVersion platformVersion)

Sets the value of FargateServiceBaseProps.getPlatformVersion()

Parameters:

platformVersion - The platform version on which to run your service. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

this

runtimePlatform

@Stability(value=Stable)
public ScheduledFargateTaskImageOptions.Builder runtimePlatform(RuntimePlatform runtimePlatform)

Sets the value of FargateServiceBaseProps.getRuntimePlatform()

Parameters:

runtimePlatform - The runtime platform of the task definition.

Returns:

this

taskDefinition

@Stability(value=Stable)
public ScheduledFargateTaskImageOptions.Builder taskDefinition(FargateTaskDefinition taskDefinition)

Sets the value of FargateServiceBaseProps.getTaskDefinition()

Parameters:

taskDefinition - The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. [disable-awslint:ref-via-interface]

Returns:

this

build

@Stability(value=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