Interface GameServerContainerDefinitionInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GameServerContainerDefinitionInput.Builder,GameServerContainerDefinitionInput>, SdkBuilder<GameServerContainerDefinitionInput.Builder,GameServerContainerDefinitionInput>, SdkPojo
Enclosing class:
GameServerContainerDefinitionInput
@Mutable @NotThreadSafe public static interface GameServerContainerDefinitionInput.Builder extends SdkPojo, CopyableBuilder<GameServerContainerDefinitionInput.Builder,GameServerContainerDefinitionInput>

  • Method Details

    • containerName

      GameServerContainerDefinitionInput.Builder containerName(String containerName)

      A string that uniquely identifies the container definition within a container group.

      Parameters:
      containerName - A string that uniquely identifies the container definition within a container group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dependsOn

      GameServerContainerDefinitionInput.Builder dependsOn(Collection<ContainerDependency> dependsOn)

      Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

      You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.

      Parameters:
      dependsOn - Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

      You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.

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

    • dependsOn

      GameServerContainerDefinitionInput.Builder dependsOn(ContainerDependency... dependsOn)

      Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

      You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.

      Parameters:
      dependsOn - Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

      You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.

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

    • dependsOn

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

      Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.

      You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a START dependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.

      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:

    • mountPoints

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

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

      GameServerContainerDefinitionInput.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<ContainerMountPoint>).

      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:

    • environmentOverride

      GameServerContainerDefinitionInput.Builder environmentOverride(Collection<ContainerEnvironment> environmentOverride)

      A set of environment variables to pass 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 to pass 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

      GameServerContainerDefinitionInput.Builder environmentOverride(ContainerEnvironment... environmentOverride)

      A set of environment variables to pass 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 to pass 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

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

      A set of environment variables to pass 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<ContainerEnvironment>).

      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:

    • imageUri

      GameServerContainerDefinitionInput.Builder imageUri(String imageUri)

      The location of the container image to deploy to a container fleet. Provide an image in an Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift Servers endpoints and quotas. You can use any of the following image URI formats:

      • Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]

      • Image ID and digest: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]

      • Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]

      Parameters:
      imageUri - The location of the container image to deploy to a container fleet. Provide an image in an Amazon Elastic Container Registry public or private repository. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift Servers endpoints and quotas. You can use any of the following image URI formats:

      • Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]

      • Image ID and digest: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]

      • Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]

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

    • portConfiguration

      GameServerContainerDefinitionInput.Builder portConfiguration(ContainerPortConfiguration portConfiguration)

      A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.

      Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property ConnectionPortRange).

      Parameters:
      portConfiguration - A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.

      Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property ConnectionPortRange).

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

    • portConfiguration

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

      A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.

      Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property 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:

    • serverSdkVersion

      GameServerContainerDefinitionInput.Builder serverSdkVersion(String serverSdkVersion)

      The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.

      Parameters:
      serverSdkVersion - The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.