Package software.amazon.awssdk.services.gamelift.model

Interface SupportContainerDefinition.Builder

All Superinterfaces:

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

Enclosing class:

SupportContainerDefinition

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

Method Summary

Modifier and Type	Method	Description
SupportContainerDefinition.Builder	containerName(String containerName)	The container definition identifier.
SupportContainerDefinition.Builder	dependsOn(Collection<ContainerDependency> dependsOn)	Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.
SupportContainerDefinition.Builder	dependsOn(Consumer<ContainerDependency.Builder>... dependsOn)	Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.
SupportContainerDefinition.Builder	dependsOn(ContainerDependency... dependsOn)	Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.
SupportContainerDefinition.Builder	environmentOverride(Collection<ContainerEnvironment> environmentOverride)	A set of environment variables that's passed to the container on startup.
SupportContainerDefinition.Builder	environmentOverride(Consumer<ContainerEnvironment.Builder>... environmentOverride)	A set of environment variables that's passed to the container on startup.
SupportContainerDefinition.Builder	environmentOverride(ContainerEnvironment... environmentOverride)	A set of environment variables that's passed to the container on startup.
SupportContainerDefinition.Builder	essential(Boolean essential)	Indicates whether the container is vital to the container group.
default SupportContainerDefinition.Builder	healthCheck(Consumer<ContainerHealthCheck.Builder> healthCheck)	A configuration for a non-terminal health check.
SupportContainerDefinition.Builder	healthCheck(ContainerHealthCheck healthCheck)	A configuration for a non-terminal health check.
SupportContainerDefinition.Builder	imageUri(String imageUri)	The URI to the image that Amazon GameLift deploys to a container fleet.
SupportContainerDefinition.Builder	memoryHardLimitMebibytes(Integer memoryHardLimitMebibytes)	The amount of memory that Amazon GameLift makes available to the container.
SupportContainerDefinition.Builder	mountPoints(Collection<ContainerMountPoint> mountPoints)	A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
SupportContainerDefinition.Builder	mountPoints(Consumer<ContainerMountPoint.Builder>... mountPoints)	A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
SupportContainerDefinition.Builder	mountPoints(ContainerMountPoint... mountPoints)	A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
default SupportContainerDefinition.Builder	portConfiguration(Consumer<ContainerPortConfiguration.Builder> portConfiguration)	A set of ports that allow access to the container from external users.
SupportContainerDefinition.Builder	portConfiguration(ContainerPortConfiguration portConfiguration)	A set of ports that allow access to the container from external users.
SupportContainerDefinition.Builder	resolvedImageDigest(String resolvedImageDigest)	A unique and immutable identifier for the container image.
SupportContainerDefinition.Builder	vcpu(Double vcpu)	The number of vCPU units that are reserved for the container.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

containerName

SupportContainerDefinition.Builder containerName(String containerName)

The container definition identifier. Container names are unique within a container group definition.

Parameters:

containerName - The container definition identifier. Container names are unique within a container group definition.

Returns:

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

dependsOn

SupportContainerDefinition.Builder dependsOn(Collection<ContainerDependency> dependsOn)

Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

Parameters:

dependsOn - Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

Returns:

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

dependsOn

SupportContainerDefinition.Builder dependsOn(ContainerDependency... dependsOn)

Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

Parameters:

dependsOn - Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

Returns:

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

dependsOn

SupportContainerDefinition.Builder dependsOn(Consumer<ContainerDependency.Builder>... dependsOn)

Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

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

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

Parameters:

dependsOn - a consumer that will call methods on ContainerDependency.Builder

Returns:

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

See Also:

#dependsOn(java.util.Collection)

mountPoints

SupportContainerDefinition.Builder mountPoints(Collection<ContainerMountPoint> mountPoints)

A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

Parameters:

mountPoints - A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

Returns:

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

mountPoints

SupportContainerDefinition.Builder mountPoints(ContainerMountPoint... mountPoints)

A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

Parameters:

mountPoints - A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

Returns:

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

mountPoints

SupportContainerDefinition.Builder mountPoints(Consumer<ContainerMountPoint.Builder>... mountPoints)

A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

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

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

Parameters:

mountPoints - a consumer that will call methods on ContainerMountPoint.Builder

Returns:

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

See Also:

#mountPoints(java.util.Collection)

environmentOverride

SupportContainerDefinition.Builder environmentOverride(Collection<ContainerEnvironment> environmentOverride)

A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

Parameters:

environmentOverride - A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

Returns:

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

environmentOverride

SupportContainerDefinition.Builder environmentOverride(ContainerEnvironment... environmentOverride)

A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

Parameters:

environmentOverride - A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

Returns:

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

environmentOverride

SupportContainerDefinition.Builder environmentOverride(Consumer<ContainerEnvironment.Builder>... environmentOverride)

A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.

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

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

Parameters:

environmentOverride - a consumer that will call methods on ContainerEnvironment.Builder

Returns:

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

See Also:

#environmentOverride(java.util.Collection)

essential

SupportContainerDefinition.Builder essential(Boolean essential)

Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.

Parameters:

essential - Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.

Returns:

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

healthCheck

SupportContainerDefinition.Builder healthCheck(ContainerHealthCheck healthCheck)

A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.

Parameters:

healthCheck - A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.

Returns:

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

healthCheck

default SupportContainerDefinition.Builder healthCheck(Consumer<ContainerHealthCheck.Builder> healthCheck)

A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthCheck(ContainerHealthCheck).

Parameters:

healthCheck - a consumer that will call methods on ContainerHealthCheck.Builder

Returns:

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

See Also:

healthCheck(ContainerHealthCheck)

imageUri

SupportContainerDefinition.Builder imageUri(String imageUri)

The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.

Parameters:

imageUri - The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.

Returns:

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

memoryHardLimitMebibytes

SupportContainerDefinition.Builder memoryHardLimitMebibytes(Integer memoryHardLimitMebibytes)

The amount of memory that Amazon GameLift makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition TotalMemoryLimitMebibytes

Parameters:

memoryHardLimitMebibytes - The amount of memory that Amazon GameLift makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition TotalMemoryLimitMebibytes

Returns:

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

portConfiguration

SupportContainerDefinition.Builder portConfiguration(ContainerPortConfiguration portConfiguration)

A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

Parameters:

portConfiguration - A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

Returns:

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

portConfiguration

default SupportContainerDefinition.Builder portConfiguration(Consumer<ContainerPortConfiguration.Builder> portConfiguration)

A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to portConfiguration(ContainerPortConfiguration).

Parameters:

portConfiguration - a consumer that will call methods on ContainerPortConfiguration.Builder

Returns:

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

See Also:

portConfiguration(ContainerPortConfiguration)

resolvedImageDigest

SupportContainerDefinition.Builder resolvedImageDigest(String resolvedImageDigest)

A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.

Parameters:

resolvedImageDigest - A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.

Returns:

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

vcpu

SupportContainerDefinition.Builder vcpu(Double vcpu)

The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group.

Related data type: ContainerGroupDefinition TotalVcpuLimit

Parameters:

vcpu - The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group.

Related data type: ContainerGroupDefinition TotalVcpuLimit

Returns:

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