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

Interface ContainerDefinition.Builder

    • Method Detail

      • containerName

        ContainerDefinition.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.

      • imageUri

        ContainerDefinition.Builder imageUri​(String imageUri)

        The URI to the image that $short; copied and deployed to a container fleet. For a more specific identifier, see ResolvedImageDigest.

        Parameters:
        imageUri - The URI to the image that $short; copied and deployed 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.

      • resolvedImageDigest

        ContainerDefinition.Builder resolvedImageDigest​(String resolvedImageDigest)

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

        Parameters:
        resolvedImageDigest - A unique and immutable identifier for the container image that is deployed to a container fleet. 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.

      • memoryLimits

        ContainerDefinition.Builder memoryLimits​(ContainerMemoryLimits memoryLimits)

        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$TotalMemoryLimit

        Parameters:
        memoryLimits - 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$TotalMemoryLimit

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

      • portConfiguration

        ContainerDefinition.Builder portConfiguration​(ContainerPortConfiguration portConfiguration)

        Defines the ports that are available to assign to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. 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 - Defines the ports that are available to assign to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. 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.

      • cpu

        ContainerDefinition.Builder cpu​(Integer cpu)

        The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group.

        Related data type: ContainerGroupDefinition$TotalCpuLimit

        Parameters:
        cpu - The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group.

        Related data type: ContainerGroupDefinition$TotalCpuLimit

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

      • healthCheck

        ContainerDefinition.Builder healthCheck​(ContainerHealthCheck healthCheck)

        A configuration for a non-terminal health check. A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.

        Parameters:
        healthCheck - A configuration for a non-terminal health check. A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • command

        ContainerDefinition.Builder command​(Collection<String> command)

        A command that's passed to the container on startup. Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.

        Parameters:
        command - A command that's passed to the container on startup. Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • command

        ContainerDefinition.Builder command​(String... command)

        A command that's passed to the container on startup. Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.

        Parameters:
        command - A command that's passed to the container on startup. Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • essential

        ContainerDefinition.Builder essential​(Boolean essential)

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

        Parameters:
        essential - Indicates whether the container is vital to the container group. If an essential container fails, the entire container group is restarted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • entryPoint

        ContainerDefinition.Builder entryPoint​(Collection<String> entryPoint)

        The entry point that's passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.

        Parameters:
        entryPoint - The entry point that's passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • entryPoint

        ContainerDefinition.Builder entryPoint​(String... entryPoint)

        The entry point that's passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.

        Parameters:
        entryPoint - The entry point that's passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • workingDirectory

        ContainerDefinition.Builder workingDirectory​(String workingDirectory)

        The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.

        Parameters:
        workingDirectory - The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        ContainerDefinition.Builder environment​(ContainerEnvironment... environment)

        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:
        environment - 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.

      • dependsOn

        ContainerDefinition.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

        ContainerDefinition.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.