Interface UpdateContainerGroupDefinitionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateContainerGroupDefinitionRequest.Builder,UpdateContainerGroupDefinitionRequest>, GameLiftRequest.Builder, SdkBuilder<UpdateContainerGroupDefinitionRequest.Builder,UpdateContainerGroupDefinitionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateContainerGroupDefinitionRequest
@Mutable @NotThreadSafe public static interface UpdateContainerGroupDefinitionRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<UpdateContainerGroupDefinitionRequest.Builder,UpdateContainerGroupDefinitionRequest>

  • Method Details

    • name

      UpdateContainerGroupDefinitionRequest.Builder name(String name)

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

      Parameters:
      name - A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameServerContainerDefinition

      UpdateContainerGroupDefinitionRequest.Builder gameServerContainerDefinition(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • gameServerContainerDefinition

      default UpdateContainerGroupDefinitionRequest.Builder gameServerContainerDefinition(Consumer<GameServerContainerDefinitionInput.Builder> 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.

      This is a convenience method that creates an instance of the GameServerContainerDefinitionInput.Builder avoiding the need to create one manually via GameServerContainerDefinitionInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to gameServerContainerDefinition(GameServerContainerDefinitionInput).

      Parameters:
      gameServerContainerDefinition - a consumer that will call methods on GameServerContainerDefinitionInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • supportContainerDefinitions

      UpdateContainerGroupDefinitionRequest.Builder supportContainerDefinitions(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportContainerDefinitions

      UpdateContainerGroupDefinitionRequest.Builder supportContainerDefinitions(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportContainerDefinitions

      UpdateContainerGroupDefinitionRequest.Builder supportContainerDefinitions(Consumer<SupportContainerDefinitionInput.Builder>... 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.

      This is a convenience method that creates an instance of the SupportContainerDefinitionInput.Builder avoiding the need to create one manually via SupportContainerDefinitionInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to supportContainerDefinitions(List<SupportContainerDefinitionInput>).

      Parameters:
      supportContainerDefinitions - a consumer that will call methods on SupportContainerDefinitionInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • totalMemoryLimitMebibytes

      UpdateContainerGroupDefinitionRequest.Builder totalMemoryLimitMebibytes(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • totalVcpuLimit

      UpdateContainerGroupDefinitionRequest.Builder totalVcpuLimit(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 these resources. If you set vCPU reservations for individual containers, the total value must be equal to or greater than the sum of the Vcpu values for all containers in the group.

      For a game server container group, Amazon GameLift Servers requires either a total vCPU limit or a Vcpu value for the game server container. If the container group has a total vCPU limit, Amazon GameLift Servers uses this value to calculate how many game server container groups fit on an instance. If the container group doesn't have a total vCPU limit, its containers can use up to the instance's available vCPU, and Amazon GameLift Servers uses the sum of the containers' Vcpu values to calculate how many game server container groups fit on an instance. To remove the total vCPU limit, omit this parameter and set RemoveAttributes to TOTAL_VCPU_LIMIT.

      Parameters:
      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 these resources. If you set vCPU reservations for individual containers, the total value must be equal to or greater than the sum of the Vcpu values for all containers in the group.

      For a game server container group, Amazon GameLift Servers requires either a total vCPU limit or a Vcpu value for the game server container. If the container group has a total vCPU limit, Amazon GameLift Servers uses this value to calculate how many game server container groups fit on an instance. If the container group doesn't have a total vCPU limit, its containers can use up to the instance's available vCPU, and Amazon GameLift Servers uses the sum of the containers' Vcpu values to calculate how many game server container groups fit on an instance. To remove the total vCPU limit, omit this parameter and set RemoveAttributes to TOTAL_VCPU_LIMIT.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionDescription

      UpdateContainerGroupDefinitionRequest.Builder versionDescription(String versionDescription)

      A description for this update to the container group definition.

      Parameters:
      versionDescription - A description for this update to the container group definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceVersionNumber

      UpdateContainerGroupDefinitionRequest.Builder sourceVersionNumber(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • operatingSystem

      UpdateContainerGroupDefinitionRequest.Builder operatingSystem(String 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/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.

      Parameters:
      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/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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • operatingSystem

      UpdateContainerGroupDefinitionRequest.Builder operatingSystem(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/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.

      Parameters:
      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/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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • removeAttributesWithStrings

      UpdateContainerGroupDefinitionRequest.Builder removeAttributesWithStrings(Collection<String> removeAttributes)

      If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.

      Parameters:
      removeAttributes - If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • removeAttributesWithStrings

      UpdateContainerGroupDefinitionRequest.Builder removeAttributesWithStrings(String... removeAttributes)

      If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.

      Parameters:
      removeAttributes - If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • removeAttributes

      UpdateContainerGroupDefinitionRequest.Builder removeAttributes(Collection<ContainerGroupDefinitionRemoveAttribute> removeAttributes)

      If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.

      Parameters:
      removeAttributes - If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • removeAttributes

      UpdateContainerGroupDefinitionRequest.Builder removeAttributes(ContainerGroupDefinitionRemoveAttribute... removeAttributes)

      If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.

      Parameters:
      removeAttributes - If set, this update removes the container group's total vCPU limit, and the group's containers can use up to the instance's available vCPU. You can't remove the total vCPU limit from a per-instance container group. A game server container group needs either a total vCPU limit or a Vcpu value for the game server container. You can't set TotalVcpuLimit in the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateContainerGroupDefinitionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateContainerGroupDefinitionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.