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.

      • containerGroupType

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

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

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

      • containerGroupType

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

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

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

      • totalMemoryLimitMebibytes

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

        Default value: 1024

        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.

        Default value: 1024

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

      • totalVcpuLimit

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

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

      • gameServerContainerDefinition

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

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

      • supportContainerDefinitions

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

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

      • supportContainerDefinitions

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

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

      • operatingSystem

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

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

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

      • versionDescription

        CreateContainerGroupDefinitionRequest.Builder versionDescription​(String versionDescription)

        A description for the initial version of this container group definition.

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

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