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

Interface ContainerDefinition.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ContainerDefinition.Builder,ContainerDefinition>, SdkBuilder<ContainerDefinition.Builder,ContainerDefinition>, SdkPojo
Enclosing class:
ContainerDefinition
public static interface ContainerDefinition.Builder extends SdkPojo, CopyableBuilder<ContainerDefinition.Builder,ContainerDefinition>

  • Method Details

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

    • memoryLimits

      default ContainerDefinition.Builder memoryLimits(Consumer<ContainerMemoryLimits.Builder> 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

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

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

      Parameters:
      memoryLimits - a consumer that will call methods on ContainerMemoryLimits.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • portConfiguration

      default ContainerDefinition.Builder portConfiguration(Consumer<ContainerPortConfiguration.Builder> 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.

      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:

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

    • healthCheck

      default ContainerDefinition.Builder healthCheck(Consumer<ContainerHealthCheck.Builder> 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.

      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:

    • 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(Collection<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.

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

    • environment

      ContainerDefinition.Builder environment(Consumer<ContainerEnvironment.Builder>... 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.

      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 environment(List<ContainerEnvironment>).

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

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

    • dependsOn

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

      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: