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

Interface CreateContainerGroupDefinitionRequest.Builder

    • Method Detail

      • name

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

      • schedulingStrategy

        CreateContainerGroupDefinitionRequest.Builder schedulingStrategy​(String 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.

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

      • schedulingStrategy

        CreateContainerGroupDefinitionRequest.Builder schedulingStrategy​(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.

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

      • totalMemoryLimit

        CreateContainerGroupDefinitionRequest.Builder totalMemoryLimit​(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.

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

      • totalCpuLimit

        CreateContainerGroupDefinitionRequest.Builder totalCpuLimit​(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.

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

      • containerDefinitions

        CreateContainerGroupDefinitionRequest.Builder containerDefinitions​(Collection<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.

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

      • containerDefinitions

        CreateContainerGroupDefinitionRequest.Builder containerDefinitions​(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.

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

      • operatingSystem

        CreateContainerGroupDefinitionRequest.Builder operatingSystem​(String 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.

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

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

      • tags

        CreateContainerGroupDefinitionRequest.Builder tags​(Collection<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.

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

      • tags

        CreateContainerGroupDefinitionRequest.Builder tags​(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.

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

      • tags

        CreateContainerGroupDefinitionRequest.Builder tags​(Consumer<Tag.Builder>... 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.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)