software.amazon.awscdk.services.ecs.patterns

Class ApplicationLoadBalancedTaskImageOptions.Builder

java.lang.Object

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

Enclosing interface:

ApplicationLoadBalancedTaskImageOptions

public static final class ApplicationLoadBalancedTaskImageOptions.Builder
extends java.lang.Object

A builder for ApplicationLoadBalancedTaskImageOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ApplicationLoadBalancedTaskImageOptions	build() Builds the configured instance.
ApplicationLoadBalancedTaskImageOptions.Builder	containerName(java.lang.String containerName) Sets the value of ApplicationLoadBalancedTaskImageOptions.getContainerName()
ApplicationLoadBalancedTaskImageOptions.Builder	containerPort(java.lang.Number containerPort) Sets the value of ApplicationLoadBalancedTaskImageOptions.getContainerPort()
ApplicationLoadBalancedTaskImageOptions.Builder	dockerLabels(java.util.Map<java.lang.String,java.lang.String> dockerLabels) Sets the value of ApplicationLoadBalancedTaskImageOptions.getDockerLabels()
ApplicationLoadBalancedTaskImageOptions.Builder	enableLogging(java.lang.Boolean enableLogging) Sets the value of ApplicationLoadBalancedTaskImageOptions.getEnableLogging()
ApplicationLoadBalancedTaskImageOptions.Builder	environment(java.util.Map<java.lang.String,java.lang.String> environment) Sets the value of ApplicationLoadBalancedTaskImageOptions.getEnvironment()
ApplicationLoadBalancedTaskImageOptions.Builder	executionRole(IRole executionRole) Sets the value of ApplicationLoadBalancedTaskImageOptions.getExecutionRole()
ApplicationLoadBalancedTaskImageOptions.Builder	family(java.lang.String family) Sets the value of ApplicationLoadBalancedTaskImageOptions.getFamily()
ApplicationLoadBalancedTaskImageOptions.Builder	image(ContainerImage image) Sets the value of ApplicationLoadBalancedTaskImageOptions.getImage()
ApplicationLoadBalancedTaskImageOptions.Builder	logDriver(LogDriver logDriver) Sets the value of ApplicationLoadBalancedTaskImageOptions.getLogDriver()
ApplicationLoadBalancedTaskImageOptions.Builder	secrets(java.util.Map<java.lang.String,? extends Secret> secrets) Sets the value of ApplicationLoadBalancedTaskImageOptions.getSecrets()
ApplicationLoadBalancedTaskImageOptions.Builder	taskRole(IRole taskRole) Sets the value of ApplicationLoadBalancedTaskImageOptions.getTaskRole()

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

public ApplicationLoadBalancedTaskImageOptions.Builder image(ContainerImage image)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getImage()

Parameters:

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

Returns:

this

containerName

public ApplicationLoadBalancedTaskImageOptions.Builder containerName(java.lang.String containerName)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getContainerName()

Parameters:

containerName - The container name value to be specified in the task definition.

Returns:

this

containerPort

public ApplicationLoadBalancedTaskImageOptions.Builder containerPort(java.lang.Number containerPort)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getContainerPort()

Parameters:

containerPort - The port number on the container that is bound to the user-specified or automatically assigned host port. If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range.

Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

For more information, see hostPort.

Returns:

this

dockerLabels

public ApplicationLoadBalancedTaskImageOptions.Builder dockerLabels(java.util.Map<java.lang.String,java.lang.String> dockerLabels)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getDockerLabels()

Parameters:

dockerLabels - A key/value map of labels to add to the container.

Returns:

this

enableLogging

public ApplicationLoadBalancedTaskImageOptions.Builder enableLogging(java.lang.Boolean enableLogging)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getEnableLogging()

Parameters:

enableLogging - Flag to indicate whether to enable logging.

Returns:

this

environment

public ApplicationLoadBalancedTaskImageOptions.Builder environment(java.util.Map<java.lang.String,java.lang.String> environment)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getEnvironment()

Parameters:

environment - The environment variables to pass to the container.

Returns:

this

executionRole

public ApplicationLoadBalancedTaskImageOptions.Builder executionRole(IRole executionRole)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getExecutionRole()

Parameters:

executionRole - The name of the task execution IAM role that grants the Amazon ECS container agent permission to call AWS APIs on your behalf.

Returns:

this

family

public ApplicationLoadBalancedTaskImageOptions.Builder family(java.lang.String family)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getFamily()

Parameters:

family - The name of a family that this task definition is registered to. A family groups multiple versions of a task definition.

Returns:

this

logDriver

public ApplicationLoadBalancedTaskImageOptions.Builder logDriver(LogDriver logDriver)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getLogDriver()

Parameters:

logDriver - The log driver to use.

Returns:

this

secrets

public ApplicationLoadBalancedTaskImageOptions.Builder secrets(java.util.Map<java.lang.String,? extends Secret> secrets)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getSecrets()

Parameters:

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

Returns:

this

taskRole

public ApplicationLoadBalancedTaskImageOptions.Builder taskRole(IRole taskRole)

Sets the value of ApplicationLoadBalancedTaskImageOptions.getTaskRole()

Parameters:

taskRole - The name of the task IAM role that grants containers in the task permission to call AWS APIs on your behalf.

Returns:

this

build

public ApplicationLoadBalancedTaskImageOptions build()

Builds the configured instance.

Returns:

a new instance of ApplicationLoadBalancedTaskImageOptions

Throws:

java.lang.NullPointerException - if any required attribute was not provided