software.amazon.awssdk.services.ecs.model

Interface Container.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Container.Builder,Container>, SdkBuilder<Container.Builder,Container>, SdkPojo

Enclosing class:

Container

public static interface Container.Builder
extends SdkPojo, CopyableBuilder<Container.Builder,Container>

Method Summary

Modifier and Type	Method and Description
Container.Builder	containerArn(String containerArn) The Amazon Resource Name (ARN) of the container.
Container.Builder	cpu(String cpu) The number of CPU units set for the container.
Container.Builder	exitCode(Integer exitCode) The exit code returned from the container.
Container.Builder	gpuIds(Collection<String> gpuIds) The IDs of each GPU assigned to the container.
Container.Builder	gpuIds(String... gpuIds) The IDs of each GPU assigned to the container.
Container.Builder	healthStatus(HealthStatus healthStatus) The health status of the container.
Container.Builder	healthStatus(String healthStatus) The health status of the container.
Container.Builder	image(String image) The image used for the container.
Container.Builder	imageDigest(String imageDigest) The container image manifest digest.
Container.Builder	lastStatus(String lastStatus) The last known status of the container.
Container.Builder	managedAgents(Collection<ManagedAgent> managedAgents) The details of any Amazon ECS managed agents associated with the container.
Container.Builder	managedAgents(Consumer<ManagedAgent.Builder>... managedAgents) The details of any Amazon ECS managed agents associated with the container.
Container.Builder	managedAgents(ManagedAgent... managedAgents) The details of any Amazon ECS managed agents associated with the container.
Container.Builder	memory(String memory) The hard limit (in MiB) of memory set for the container.
Container.Builder	memoryReservation(String memoryReservation) The soft limit (in MiB) of memory set for the container.
Container.Builder	name(String name) The name of the container.
Container.Builder	networkBindings(Collection<NetworkBinding> networkBindings) The network bindings associated with the container.
Container.Builder	networkBindings(Consumer<NetworkBinding.Builder>... networkBindings) The network bindings associated with the container.
Container.Builder	networkBindings(NetworkBinding... networkBindings) The network bindings associated with the container.
Container.Builder	networkInterfaces(Collection<NetworkInterface> networkInterfaces) The network interfaces associated with the container.
Container.Builder	networkInterfaces(Consumer<NetworkInterface.Builder>... networkInterfaces) The network interfaces associated with the container.
Container.Builder	networkInterfaces(NetworkInterface... networkInterfaces) The network interfaces associated with the container.
Container.Builder	reason(String reason) A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
Container.Builder	runtimeId(String runtimeId) The ID of the Docker container.
Container.Builder	taskArn(String taskArn) The ARN of the task.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

containerArn

Container.Builder containerArn(String containerArn)

The Amazon Resource Name (ARN) of the container.

Parameters:

containerArn - The Amazon Resource Name (ARN) of the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskArn

Container.Builder taskArn(String taskArn)

The ARN of the task.

Parameters:

taskArn - The ARN of the task.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

Container.Builder name(String name)

The name of the container.

Parameters:

name - The name of the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

image

Container.Builder image(String image)

The image used for the container.

Parameters:

image - The image used for the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageDigest

Container.Builder imageDigest(String imageDigest)

The container image manifest digest.

Parameters:

imageDigest - The container image manifest digest.

Returns:

Returns a reference to this object so that method calls can be chained together.

runtimeId

Container.Builder runtimeId(String runtimeId)

The ID of the Docker container.

Parameters:

runtimeId - The ID of the Docker container.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastStatus

Container.Builder lastStatus(String lastStatus)

The last known status of the container.

Parameters:

lastStatus - The last known status of the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

exitCode

Container.Builder exitCode(Integer exitCode)

The exit code returned from the container.

Parameters:

exitCode - The exit code returned from the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

reason

Container.Builder reason(String reason)

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

Parameters:

reason - A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkBindings

Container.Builder networkBindings(Collection<NetworkBinding> networkBindings)

The network bindings associated with the container.

Parameters:

networkBindings - The network bindings associated with the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkBindings

Container.Builder networkBindings(NetworkBinding... networkBindings)

The network bindings associated with the container.

Parameters:

networkBindings - The network bindings associated with the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkBindings

Container.Builder networkBindings(Consumer<NetworkBinding.Builder>... networkBindings)

The network bindings associated with the container.

This is a convenience method that creates an instance of the NetworkBinding.Builder avoiding the need to create one manually via NetworkBinding.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #networkBindings(List).

Parameters:

networkBindings - a consumer that will call methods on NetworkBinding.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#networkBindings(java.util.Collection)

networkInterfaces

Container.Builder networkInterfaces(Collection<NetworkInterface> networkInterfaces)

The network interfaces associated with the container.

Parameters:

networkInterfaces - The network interfaces associated with the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkInterfaces

Container.Builder networkInterfaces(NetworkInterface... networkInterfaces)

The network interfaces associated with the container.

Parameters:

networkInterfaces - The network interfaces associated with the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkInterfaces

Container.Builder networkInterfaces(Consumer<NetworkInterface.Builder>... networkInterfaces)

The network interfaces associated with the container.

This is a convenience method that creates an instance of the NetworkInterface.Builder avoiding the need to create one manually via NetworkInterface.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #networkInterfaces(List).

Parameters:

networkInterfaces - a consumer that will call methods on NetworkInterface.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#networkInterfaces(java.util.Collection)

healthStatus

Container.Builder healthStatus(String healthStatus)

The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

Parameters:

healthStatus - The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HealthStatus, HealthStatus

healthStatus

Container.Builder healthStatus(HealthStatus healthStatus)

The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

Parameters:

healthStatus - The health status of the container. If health checks aren't configured for this container in its task definition, then it reports the health status as UNKNOWN.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HealthStatus, HealthStatus

managedAgents

Container.Builder managedAgents(Collection<ManagedAgent> managedAgents)

The details of any Amazon ECS managed agents associated with the container.

Parameters:

managedAgents - The details of any Amazon ECS managed agents associated with the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

managedAgents

Container.Builder managedAgents(ManagedAgent... managedAgents)

The details of any Amazon ECS managed agents associated with the container.

Parameters:

managedAgents - The details of any Amazon ECS managed agents associated with the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

managedAgents

Container.Builder managedAgents(Consumer<ManagedAgent.Builder>... managedAgents)

The details of any Amazon ECS managed agents associated with the container.

This is a convenience method that creates an instance of the ManagedAgent.Builder avoiding the need to create one manually via ManagedAgent.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #managedAgents(List).

Parameters:

managedAgents - a consumer that will call methods on ManagedAgent.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#managedAgents(java.util.Collection)

cpu

Container.Builder cpu(String cpu)

The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

Parameters:

cpu - The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.

Returns:

Returns a reference to this object so that method calls can be chained together.

memory

Container.Builder memory(String memory)

The hard limit (in MiB) of memory set for the container.

Parameters:

memory - The hard limit (in MiB) of memory set for the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

memoryReservation

Container.Builder memoryReservation(String memoryReservation)

The soft limit (in MiB) of memory set for the container.

Parameters:

memoryReservation - The soft limit (in MiB) of memory set for the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

gpuIds

Container.Builder gpuIds(Collection<String> gpuIds)

The IDs of each GPU assigned to the container.

Parameters:

gpuIds - The IDs of each GPU assigned to the container.

Returns:

Returns a reference to this object so that method calls can be chained together.

gpuIds

Container.Builder gpuIds(String... gpuIds)

The IDs of each GPU assigned to the container.

Parameters:

gpuIds - The IDs of each GPU assigned to the container.

Returns:

Returns a reference to this object so that method calls can be chained together.