java.lang.Object
- software.amazon.awssdk.services.gamelift.model.SupportContainerDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SupportContainerDefinition.Builder,SupportContainerDefinition>
```
@Generated("software.amazon.awssdk:codegen")
public final class SupportContainerDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SupportContainerDefinition.Builder,SupportContainerDefinition>
```
Describes a support container in a container group. A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes.

You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput.

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SupportContainerDefinition.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SupportContainerDefinition.Builder`	`builder()`
`String`	`containerName()`	The container definition identifier.
`List<ContainerDependency>`	`dependsOn()`	Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.
`List<ContainerEnvironment>`	`environmentOverride()`	A set of environment variables that's passed to the container on startup.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`essential()`	Indicates whether the container is vital to the container group.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDependsOn()`	For responses, this returns true if the service returned a value for the DependsOn property.
`boolean`	`hasEnvironmentOverride()`	For responses, this returns true if the service returned a value for the EnvironmentOverride property.
`int`	`hashCode()`
`boolean`	`hasMountPoints()`	For responses, this returns true if the service returned a value for the MountPoints property.
`ContainerHealthCheck`	`healthCheck()`	A configuration for a non-terminal health check.
`String`	`imageUri()`	The URI to the image that Amazon GameLift deploys to a container fleet.
`Integer`	`memoryHardLimitMebibytes()`	The amount of memory that Amazon GameLift makes available to the container.
`List<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.
`ContainerPortConfiguration`	`portConfiguration()`	A set of ports that allow access to the container from external users.
`String`	`resolvedImageDigest()`	A unique and immutable identifier for the container image.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SupportContainerDefinition.Builder>`	`serializableBuilderClass()`
`SupportContainerDefinition.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Double`	`vcpu()`	The number of vCPU units that are reserved for the container.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - containerName
```
public final String containerName()
```
    The container definition identifier. Container names are unique within a container group definition.
    
    Returns:
    
    The container definition identifier. Container names are unique within a container group definition.
  - hasDependsOn
```
public final boolean hasDependsOn()
```
    For responses, this returns true if the service returned a value for the DependsOn property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dependsOn
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDependsOn() method.
    
    Returns:
    
    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.
  - hasMountPoints
```
public final boolean hasMountPoints()
```
    For responses, this returns true if the service returned a value for the MountPoints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - mountPoints
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMountPoints() method.
    
    Returns:
    
    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.
  - hasEnvironmentOverride
```
public final boolean hasEnvironmentOverride()
```
    For responses, this returns true if the service returned a value for the EnvironmentOverride property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - environmentOverride
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentOverride() method.
    
    Returns:
    
    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.
  - essential
```
public final Boolean essential()
```
    Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.
    
    Returns:
    
    Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.
  - healthCheck
```
public final 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.
    
    Returns:
    
    A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.
  - imageUri
```
public final String imageUri()
```
    The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.
    
    Returns:
    
    The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.
  - memoryHardLimitMebibytes
```
public final 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
    
    Returns:
    
    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
  - portConfiguration
```
public final 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.
    
    Returns:
    
    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.
  - resolvedImageDigest
```
public final String resolvedImageDigest()
```
    A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.
    
    Returns:
    
    A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.
  - vcpu
```
public final 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
    
    Returns:
    
    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
  - toBuilder
```
public SupportContainerDefinition.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SupportContainerDefinition.Builder,SupportContainerDefinition>
  - builder
```
public static SupportContainerDefinition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SupportContainerDefinition.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class SupportContainerDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

containerName

hasDependsOn

dependsOn

hasMountPoints

mountPoints

hasEnvironmentOverride

environmentOverride

essential

healthCheck

imageUri

memoryHardLimitMebibytes

portConfiguration

resolvedImageDigest

vcpu

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField