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

Class NetworkLoadBalancedTaskImageOptions.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkLoadBalancedTaskImageOptions>

Enclosing interface:

NetworkLoadBalancedTaskImageOptions

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

A builder for NetworkLoadBalancedTaskImageOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

image

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

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

containerName

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

Sets the value of NetworkLoadBalancedTaskImageOptions.getContainerName()

Parameters:

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

Returns:

this

containerPort

@Stability(Stable)
public NetworkLoadBalancedTaskImageOptions.Builder containerPort(Number containerPort)

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

@Stability(Stable)
public NetworkLoadBalancedTaskImageOptions.Builder dockerLabels(Map<String,String> dockerLabels)

Sets the value of NetworkLoadBalancedTaskImageOptions.getDockerLabels()

Parameters:

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

Returns:

this

enableLogging

@Stability(Stable)
public NetworkLoadBalancedTaskImageOptions.Builder enableLogging(Boolean enableLogging)

Sets the value of NetworkLoadBalancedTaskImageOptions.getEnableLogging()

Parameters:

enableLogging - Flag to indicate whether to enable logging.

Returns:

this

environment

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

Sets the value of NetworkLoadBalancedTaskImageOptions.getEnvironment()

Parameters:

environment - The environment variables to pass to the container.

Returns:

this

executionRole

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

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

@Stability(Stable)
public NetworkLoadBalancedTaskImageOptions.Builder family(String family)

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

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

Sets the value of NetworkLoadBalancedTaskImageOptions.getLogDriver()

Parameters:

logDriver - The log driver to use.

Returns:

this

secrets

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

Sets the value of NetworkLoadBalancedTaskImageOptions.getSecrets()

Parameters:

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

Returns:

this

taskRole

@Stability(Stable)
public NetworkLoadBalancedTaskImageOptions.Builder taskRole(IRole taskRole)

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

@Stability(Stable)
public NetworkLoadBalancedTaskImageOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NetworkLoadBalancedTaskImageOptions

Throws:

NullPointerException - if any required attribute was not provided