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

Class CreateContainerGroupDefinitionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.CreateContainerGroupDefinitionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateContainerGroupDefinitionRequest.Builder,CreateContainerGroupDefinitionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateContainerGroupDefinitionRequest
extends GameLiftRequest
implements ToCopyableBuilder<CreateContainerGroupDefinitionRequest.Builder,CreateContainerGroupDefinitionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateContainerGroupDefinitionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateContainerGroupDefinitionRequest.Builder	builder()
List<ContainerDefinitionInput>	containerDefinitions()	Definitions for all containers in this group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContainerDefinitions()	For responses, this returns true if the service returned a value for the ContainerDefinitions property.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	A descriptive identifier for the container group definition.
ContainerOperatingSystem	operatingSystem()	The platform that is used by containers in the container group definition.
String	operatingSystemAsString()	The platform that is used by containers in the container group definition.
ContainerSchedulingStrategy	schedulingStrategy()	The method for deploying the container group across fleet instances.
String	schedulingStrategyAsString()	The method for deploying the container group across fleet instances.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateContainerGroupDefinitionRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of labels to assign to the container group definition resource.
CreateContainerGroupDefinitionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	totalCpuLimit()	The maximum amount of CPU units to allocate to the container group.
Integer	totalMemoryLimit()	The maximum amount of memory (in MiB) to allocate to the container group.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

Returns:

A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

schedulingStrategy

public final ContainerSchedulingStrategy schedulingStrategy()

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

If the service returns an enum value that is not available in the current SDK version, schedulingStrategy will return ContainerSchedulingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schedulingStrategyAsString().

Returns:

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

See Also:

ContainerSchedulingStrategy

schedulingStrategyAsString

public final String schedulingStrategyAsString()

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

If the service returns an enum value that is not available in the current SDK version, schedulingStrategy will return ContainerSchedulingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schedulingStrategyAsString().

Returns:

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

See Also:

ContainerSchedulingStrategy

totalMemoryLimit

public final Integer totalMemoryLimit()

The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

Returns:

The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

totalCpuLimit

public final Integer totalCpuLimit()

The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

Returns:

The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

hasContainerDefinitions

public final boolean hasContainerDefinitions()

For responses, this returns true if the service returned a value for the ContainerDefinitions 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.

containerDefinitions

public final List<ContainerDefinitionInput> containerDefinitions()

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

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 hasContainerDefinitions() method.

Returns:

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

operatingSystem

public final ContainerOperatingSystem operatingSystem()

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.

If the service returns an enum value that is not available in the current SDK version, operatingSystem will return ContainerOperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemAsString().

Returns:

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.

See Also:

ContainerOperatingSystem

operatingSystemAsString

public final String operatingSystemAsString()

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.

If the service returns an enum value that is not available in the current SDK version, operatingSystem will return ContainerOperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemAsString().

Returns:

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.

See Also:

ContainerOperatingSystem

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General 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 hasTags() method.

Returns:

A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

toBuilder

public CreateContainerGroupDefinitionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateContainerGroupDefinitionRequest.Builder,CreateContainerGroupDefinitionRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static CreateContainerGroupDefinitionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateContainerGroupDefinitionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo