Module Values.UpdateContainerGroupDefinitionInputSource

This API works with the following fleet types: Container Updates properties in an existing container group definition. This operation doesn't replace the definition. Instead, it creates a new version of the definition and saves it separately. You can access all versions that you choose to retain. The only property you can't update is the container group type. Request options: Update based on the latest version of the container group definition. Specify the container group definition name only, or use an ARN value without a version number. Provide updated values for the properties that you want to change only. All other values remain the same as the latest version. Update based on a specific version of the container group definition. Specify the container group definition name and a source version number, or use an ARN value with a version number. Provide updated values for the properties that you want to change only. All other values remain the same as the source version. Change a game server container definition. Provide the updated container definition. Add or change a support container definition. Provide a complete set of container definitions, including the updated definition. Remove a support container definition. Provide a complete set of container definitions, excluding the definition to remove. If the container group has only one support container definition, provide an empty set. Results: If successful, this operation returns the complete properties of the new container group definition version. If the container group definition version is used in an active fleets, the update automatically initiates a new fleet deployment of the new version. You can track a fleet's deployments using ListFleetDeployments.

Sourcetype nonrec t = {
  1. name : ContainerGroupDefinitionNameOrArn.t;
    (*

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

    *)
  2. gameServerContainerDefinition : GameServerContainerDefinitionInput.t option;
    (*

    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.

    *)
  3. supportContainerDefinitions : SupportContainerDefinitionInputList.t option;
    (*

    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.

    *)
  4. totalMemoryLimitMebibytes : ContainerTotalMemoryLimit.t option;
    (*

    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.

    *)
  5. totalVcpuLimit : ContainerTotalVcpuLimit.t option;
    (*

    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.

    *)
  6. versionDescription : NonZeroAndMaxString.t option;
    (*

    A description for this update to the container group definition.

    *)
  7. sourceVersionNumber : PositiveInteger.t option;
    (*

    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.

    *)
  8. operatingSystem : ContainerOperatingSystem.t option;
    (*

    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/2026. 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.

    *)
}
Sourceval context_ : string
Sourceval make : ?gameServerContainerDefinition:??? -> ?supportContainerDefinitions:??? -> ?totalMemoryLimitMebibytes:??? -> ?totalVcpuLimit:??? -> ?versionDescription:??? -> ?sourceVersionNumber:??? -> ?operatingSystem:??? -> name:ContainerGroupDefinitionNameOrArn.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Double of ContainerTotalVcpuLimit.t | `Enum of string | `Integer of ContainerTotalMemoryLimit.t | `List of [> `Structure of (string * [> `Boolean of BooleanModel.t | `Double of ContainerVcpu.t | `Integer of ContainerMemoryLimit.t | `List of [> `Structure of (string * [> `Enum of string | `String of NonZeroAnd128MaxAsciiString.t ]) list ] list | `String of NonZeroAnd128MaxAsciiString.t | `Structure of (string * [> `Integer of ContainerHealthCheckInterval.t | `List of [> `String of NonZeroAnd255MaxString.t | `Structure of (string * [> `Enum of string | `Integer of PortNumber.t ]) list ] list ]) list ]) list ] list | `String of ContainerGroupDefinitionNameOrArn.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `String of NonZeroAnd128MaxAsciiString.t ]) list ] list | `String of NonZeroAnd128MaxAsciiString.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `Integer of PortNumber.t ]) list ] list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t