Class UpdateContainerGroupDefinitionRequest

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.UpdateContainerGroupDefinitionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateContainerGroupDefinitionRequest.Builder,UpdateContainerGroupDefinitionRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateContainerGroupDefinitionRequest extends GameLiftRequest implements ToCopyableBuilder<UpdateContainerGroupDefinitionRequest.Builder,UpdateContainerGroupDefinitionRequest>

  • Method Details

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

    • gameServerContainerDefinition

      public final GameServerContainerDefinitionInput gameServerContainerDefinition()

      An updated definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER. You can pass in your container definitions as a JSON file.

      Returns:
      An updated definition for the game server container in this group. Define a game server container only when the container group type is GAME_SERVER. 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 definitions 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 definitions 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.

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

      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.

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

      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.

    • versionDescription

      public final String versionDescription()

      A description for this update to the container group definition.

      Returns:
      A description for this update to the container group definition.

    • sourceVersionNumber

      public final Integer sourceVersionNumber()

      The container group definition version to update. The new version starts with values from the source version, and then updates values included in this request.

      Returns:
      The container group definition version to update. The new version starts with values from the source version, and then updates values included in this request.

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

      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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to 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.

      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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.

      See Also:

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

      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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to 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.

      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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.

      See Also:

    • toBuilder

      public UpdateContainerGroupDefinitionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateContainerGroupDefinitionRequest.Builder,UpdateContainerGroupDefinitionRequest>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateContainerGroupDefinitionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateContainerGroupDefinitionRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.