Interface GameServerContainerDefinition.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<GameServerContainerDefinition.Builder,GameServerContainerDefinition>,SdkBuilder<GameServerContainerDefinition.Builder,GameServerContainerDefinition>,SdkPojo
- Enclosing class:
- GameServerContainerDefinition
public static interface GameServerContainerDefinition.Builder extends SdkPojo, CopyableBuilder<GameServerContainerDefinition.Builder,GameServerContainerDefinition>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description GameServerContainerDefinition.BuildercontainerName(String containerName)The container definition identifier.GameServerContainerDefinition.BuilderdependsOn(Collection<ContainerDependency> dependsOn)Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences.GameServerContainerDefinition.BuilderdependsOn(Consumer<ContainerDependency.Builder>... dependsOn)Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences.GameServerContainerDefinition.BuilderdependsOn(ContainerDependency... dependsOn)Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences.GameServerContainerDefinition.BuilderenvironmentOverride(Collection<ContainerEnvironment> environmentOverride)A set of environment variables that's passed to the container on startup.GameServerContainerDefinition.BuilderenvironmentOverride(Consumer<ContainerEnvironment.Builder>... environmentOverride)A set of environment variables that's passed to the container on startup.GameServerContainerDefinition.BuilderenvironmentOverride(ContainerEnvironment... environmentOverride)A set of environment variables that's passed to the container on startup.GameServerContainerDefinition.BuilderimageUri(String imageUri)The URI to the image that Amazon GameLift uses when deploying this container to a container fleet.GameServerContainerDefinition.BuildermountPoints(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.GameServerContainerDefinition.BuildermountPoints(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.GameServerContainerDefinition.BuildermountPoints(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 GameServerContainerDefinition.BuilderportConfiguration(Consumer<ContainerPortConfiguration.Builder> portConfiguration)The set of ports that are available to bind to processes in the container.GameServerContainerDefinition.BuilderportConfiguration(ContainerPortConfiguration portConfiguration)The set of ports that are available to bind to processes in the container.GameServerContainerDefinition.BuilderresolvedImageDigest(String resolvedImageDigest)A unique and immutable identifier for the container image.GameServerContainerDefinition.BuilderserverSdkVersion(String serverSdkVersion)The Amazon GameLift server SDK version that the game server is integrated with.-
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
GameServerContainerDefinition.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
GameServerContainerDefinition.Builder dependsOn(Collection<ContainerDependency> dependsOn)
Indicates that the container relies on the status of other containers in the same container group during 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 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
GameServerContainerDefinition.Builder dependsOn(ContainerDependency... dependsOn)
Indicates that the container relies on the status of other containers in the same container group during 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 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
GameServerContainerDefinition.Builder dependsOn(Consumer<ContainerDependency.Builder>... dependsOn)
Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences. A container might have dependencies on multiple containers.
This is a convenience method that creates an instance of theContainerDependency.Builderavoiding the need to create one manually viaContainerDependency.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#dependsOn(List.) - Parameters:
dependsOn- a consumer that will call methods onContainerDependency.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#dependsOn(java.util.Collection)
-
mountPoints
GameServerContainerDefinition.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
GameServerContainerDefinition.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
GameServerContainerDefinition.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 theContainerMountPoint.Builderavoiding the need to create one manually viaContainerMountPoint.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#mountPoints(List.) - Parameters:
mountPoints- a consumer that will call methods onContainerMountPoint.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#mountPoints(java.util.Collection)
-
environmentOverride
GameServerContainerDefinition.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
GameServerContainerDefinition.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
GameServerContainerDefinition.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 theContainerEnvironment.Builderavoiding the need to create one manually viaContainerEnvironment.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#environmentOverride(List.) - Parameters:
environmentOverride- a consumer that will call methods onContainerEnvironment.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#environmentOverride(java.util.Collection)
-
imageUri
GameServerContainerDefinition.Builder imageUri(String imageUri)
The URI to the image that Amazon GameLift uses when deploying this container to a container fleet. For a more specific identifier, see
ResolvedImageDigest.- Parameters:
imageUri- The URI to the image that Amazon GameLift uses when deploying this container to a container fleet. For a more specific identifier, seeResolvedImageDigest.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
portConfiguration
GameServerContainerDefinition.Builder portConfiguration(ContainerPortConfiguration portConfiguration)
The set of ports that are available to bind 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- The set of ports that are available to bind 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'sConnectionPortRange.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
portConfiguration
default GameServerContainerDefinition.Builder portConfiguration(Consumer<ContainerPortConfiguration.Builder> portConfiguration)
The set of ports that are available to bind 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
This is a convenience method that creates an instance of theConnectionPortRange.ContainerPortConfiguration.Builderavoiding the need to create one manually viaContainerPortConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toportConfiguration(ContainerPortConfiguration).- Parameters:
portConfiguration- a consumer that will call methods onContainerPortConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
portConfiguration(ContainerPortConfiguration)
-
resolvedImageDigest
GameServerContainerDefinition.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.
-
serverSdkVersion
GameServerContainerDefinition.Builder serverSdkVersion(String serverSdkVersion)
The Amazon GameLift 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 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.
-
-