software.amazon.awscdk.services.ecs.patterns

Class NetworkLoadBalancedTaskImageProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkLoadBalancedTaskImageProps>

Enclosing interface:

NetworkLoadBalancedTaskImageProps

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

A builder for NetworkLoadBalancedTaskImageProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
NetworkLoadBalancedTaskImageProps	build() Builds the configured instance.
NetworkLoadBalancedTaskImageProps.Builder	containerName(String containerName) Sets the value of NetworkLoadBalancedTaskImageProps.getContainerName()
NetworkLoadBalancedTaskImageProps.Builder	containerPorts(List<? extends Number> containerPorts) Sets the value of NetworkLoadBalancedTaskImageProps.getContainerPorts()
NetworkLoadBalancedTaskImageProps.Builder	dockerLabels(Map<String,String> dockerLabels) Sets the value of NetworkLoadBalancedTaskImageProps.getDockerLabels()
NetworkLoadBalancedTaskImageProps.Builder	enableLogging(Boolean enableLogging) Sets the value of NetworkLoadBalancedTaskImageProps.getEnableLogging()
NetworkLoadBalancedTaskImageProps.Builder	environment(Map<String,String> environment) Sets the value of NetworkLoadBalancedTaskImageProps.getEnvironment()
NetworkLoadBalancedTaskImageProps.Builder	executionRole(IRole executionRole) Sets the value of NetworkLoadBalancedTaskImageProps.getExecutionRole()
NetworkLoadBalancedTaskImageProps.Builder	family(String family) Sets the value of NetworkLoadBalancedTaskImageProps.getFamily()
NetworkLoadBalancedTaskImageProps.Builder	image(ContainerImage image) Sets the value of NetworkLoadBalancedTaskImageProps.getImage()
NetworkLoadBalancedTaskImageProps.Builder	logDriver(LogDriver logDriver) Sets the value of NetworkLoadBalancedTaskImageProps.getLogDriver()
NetworkLoadBalancedTaskImageProps.Builder	secrets(Map<String,? extends Secret> secrets) Sets the value of NetworkLoadBalancedTaskImageProps.getSecrets()
NetworkLoadBalancedTaskImageProps.Builder	taskRole(IRole taskRole) Sets the value of NetworkLoadBalancedTaskImageProps.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

@Stability(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder image(ContainerImage image)

Sets the value of NetworkLoadBalancedTaskImageProps.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(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder containerName(String containerName)

Sets the value of NetworkLoadBalancedTaskImageProps.getContainerName()

Parameters:

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

Returns:

this

containerPorts

@Stability(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder containerPorts(List<? extends Number> containerPorts)

Sets the value of NetworkLoadBalancedTaskImageProps.getContainerPorts()

Parameters:

containerPorts - A list of port numbers 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(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder dockerLabels(Map<String,String> dockerLabels)

Sets the value of NetworkLoadBalancedTaskImageProps.getDockerLabels()

Parameters:

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

Returns:

this

enableLogging

@Stability(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder enableLogging(Boolean enableLogging)

Sets the value of NetworkLoadBalancedTaskImageProps.getEnableLogging()

Parameters:

enableLogging - Flag to indicate whether to enable logging.

Returns:

this

environment

@Stability(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder environment(Map<String,String> environment)

Sets the value of NetworkLoadBalancedTaskImageProps.getEnvironment()

Parameters:

environment - The environment variables to pass to the container.

Returns:

this

executionRole

@Stability(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder executionRole(IRole executionRole)

Sets the value of NetworkLoadBalancedTaskImageProps.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(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder family(String family)

Sets the value of NetworkLoadBalancedTaskImageProps.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(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder logDriver(LogDriver logDriver)

Sets the value of NetworkLoadBalancedTaskImageProps.getLogDriver()

Parameters:

logDriver - The log driver to use.

Returns:

this

secrets

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

Sets the value of NetworkLoadBalancedTaskImageProps.getSecrets()

Parameters:

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

Returns:

this

taskRole

@Stability(value=Stable)
public NetworkLoadBalancedTaskImageProps.Builder taskRole(IRole taskRole)

Sets the value of NetworkLoadBalancedTaskImageProps.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(value=Stable)
public NetworkLoadBalancedTaskImageProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NetworkLoadBalancedTaskImageProps

Throws:

NullPointerException - if any required attribute was not provided