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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateContainerGroupDefinitionRequest.Builder`	`builder()`
`ContainerGroupType`	`containerGroupType()`	The type of container group being defined.
`String`	`containerGroupTypeAsString()`	The type of container group being defined.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`GameServerContainerDefinitionInput`	`gameServerContainerDefinition()`	The definition for the game server container in this group.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSupportContainerDefinitions()`	For responses, this returns true if the service returned a value for the SupportContainerDefinitions property.
`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 all containers in the group use.
`String`	`operatingSystemAsString()`	The platform that all containers in the group use.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateContainerGroupDefinitionRequest.Builder>`	`serializableBuilderClass()`
`List<SupportContainerDefinitionInput>`	`supportContainerDefinitions()`	One or more definition for support containers in this group.
`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`	`totalMemoryLimitMebibytes()`	The maximum amount of memory (in MiB) to allocate to the container group.
`Double`	`totalVcpuLimit()`	The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024 CPU units).
`String`	`versionDescription()`	A description for the initial version of this container group definition.

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.
  - containerGroupType
```
public final ContainerGroupType containerGroupType()
```
    The type of container group being defined. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
    
    Default value: GAME_SERVER
    
    If the service returns an enum value that is not available in the current SDK version, containerGroupType will return ContainerGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerGroupTypeAsString().
    
    Returns:
    
    The type of container group being defined. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
    
    Default value: GAME_SERVER
    
    See Also:
    
    ContainerGroupType
  - containerGroupTypeAsString
```
public final String containerGroupTypeAsString()
```
    The type of container group being defined. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
    
    Default value: GAME_SERVER
    
    If the service returns an enum value that is not available in the current SDK version, containerGroupType will return ContainerGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerGroupTypeAsString().
    
    Returns:
    
    The type of container group being defined. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.
    
    Default value: GAME_SERVER
    
    See Also:
    
    ContainerGroupType
  - totalMemoryLimitMebibytes
```
public final Integer totalMemoryLimitMebibytes()
```
    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 an individual container, the total value must be greater than any individual container's memory limit.
    
    Default value: 1024
    
    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 an individual container, the total value must be greater than any individual container's memory limit.
    
    Default value: 1024
  - totalVcpuLimit
```
public final Double totalVcpuLimit()
```
    The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify vCPU limits for individual containers, the total value must be equal to or greater than the sum of the CPU limits for all containers in the group.
    
    Default value: 1
    
    Returns:
    
    The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify vCPU limits for individual containers, the total value must be equal to or greater than the sum of the CPU limits for all containers in the group.
    
    Default value: 1
  - gameServerContainerDefinition
```
public final GameServerContainerDefinitionInput gameServerContainerDefinition()
```
    The definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER. Game server containers specify a container image with your game server build. You can pass in your container definitions as a JSON file.
    
    Returns:
    
    The definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER. Game server containers specify a container image with your game server build. You can pass in your container definitions as a JSON file.
  - hasSupportContainerDefinitions
```
public final boolean hasSupportContainerDefinitions()
```
    For responses, this returns true if the service returned a value for the SupportContainerDefinitions 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.
  - supportContainerDefinitions
```
public final List<SupportContainerDefinitionInput> supportContainerDefinitions()
```
    One or more definition for support containers in this group. You can define a support container in any type of container group. You can pass in your container definitions as a JSON file.
    
    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 hasSupportContainerDefinitions() method.
    
    Returns:
    
    One or more definition for support containers in this group. You can define a support container in any type of container group. You can pass in your container definitions as a JSON file.
  - operatingSystem
```
public final ContainerOperatingSystem operatingSystem()
```
    The platform that all containers in the group use. Containers in a group must run on the same operating system.
    
    Default value: AMAZON_LINUX_2023
    
    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 all containers in the group use. Containers in a group must run on the same operating system.
    
    Default value: AMAZON_LINUX_2023
    
    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 all containers in the group use. Containers in a group must run on the same operating system.
    
    Default value: AMAZON_LINUX_2023
    
    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 all containers in the group use. Containers in a group must run on the same operating system.
    
    Default value: AMAZON_LINUX_2023
    
    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
  - versionDescription
```
public final String versionDescription()
```
    A description for the initial version of this container group definition.
    
    Returns:
    
    A description for the initial version of this container group definition.
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateContainerGroupDefinitionRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

name

containerGroupType

containerGroupTypeAsString

totalMemoryLimitMebibytes

totalVcpuLimit

gameServerContainerDefinition

hasSupportContainerDefinitions

supportContainerDefinitions

operatingSystem

operatingSystemAsString

versionDescription

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField