Interface ContainerGroupDefinition.Builder

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

  • Method Details

    • containerGroupDefinitionArn

      ContainerGroupDefinition.Builder containerGroupDefinitionArn(String containerGroupDefinitionArn)

      The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift Servers ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version].

      Parameters:
      containerGroupDefinitionArn - The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift Servers ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version] .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      ContainerGroupDefinition.Builder creationTime(Instant creationTime)

      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      Parameters:
      creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operatingSystem

      ContainerGroupDefinition.Builder operatingSystem(String operatingSystem)

      The platform that all containers in the container group definition run on.

      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.

      Parameters:
      operatingSystem - The platform that all containers in the container group definition run on.

      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.

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

    • operatingSystem

      ContainerGroupDefinition.Builder operatingSystem(ContainerOperatingSystem operatingSystem)

      The platform that all containers in the container group definition run on.

      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.

      Parameters:
      operatingSystem - The platform that all containers in the container group definition run on.

      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.

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

    • name

      ContainerGroupDefinition.Builder name(String name)

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

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

    • containerGroupType

      ContainerGroupDefinition.Builder containerGroupType(String containerGroupType)

      The type of container group. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.

      Parameters:
      containerGroupType - The type of container group. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • containerGroupType

      ContainerGroupDefinition.Builder containerGroupType(ContainerGroupType containerGroupType)

      The type of container group. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.

      Parameters:
      containerGroupType - The type of container group. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • totalMemoryLimitMebibytes

      ContainerGroupDefinition.Builder totalMemoryLimitMebibytes(Integer totalMemoryLimitMebibytes)

      The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

      You can set a limit for each container definition in the group. If individual containers have limits, this total value must be greater than any individual container's memory limit.

      Parameters:
      totalMemoryLimitMebibytes - The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

      You can set a limit for each container definition in the group. If individual containers have limits, this 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

      ContainerGroupDefinition.Builder totalVcpuLimit(Double totalVcpuLimit)

      The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group.

      Parameters:
      totalVcpuLimit - The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameServerContainerDefinition

      ContainerGroupDefinition.Builder gameServerContainerDefinition(GameServerContainerDefinition gameServerContainerDefinition)

      The definition for the game server container in this group. This property is used only when the container group type is GAME_SERVER. This container definition specifies a container image with the game server build.

      Parameters:
      gameServerContainerDefinition - The definition for the game server container in this group. This property is used only when the container group type is GAME_SERVER. This container definition specifies a container image with the game server build.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gameServerContainerDefinition

      default ContainerGroupDefinition.Builder gameServerContainerDefinition(Consumer<GameServerContainerDefinition.Builder> gameServerContainerDefinition)

      The definition for the game server container in this group. This property is used only when the container group type is GAME_SERVER. This container definition specifies a container image with the game server build.

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

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

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

    • supportContainerDefinitions

      ContainerGroupDefinition.Builder supportContainerDefinitions(Collection<SupportContainerDefinition> supportContainerDefinitions)

      The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group.

      Parameters:
      supportContainerDefinitions - The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportContainerDefinitions

      ContainerGroupDefinition.Builder supportContainerDefinitions(SupportContainerDefinition... supportContainerDefinitions)

      The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group.

      Parameters:
      supportContainerDefinitions - The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportContainerDefinitions

      ContainerGroupDefinition.Builder supportContainerDefinitions(Consumer<SupportContainerDefinition.Builder>... supportContainerDefinitions)

      The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group.

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

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

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

    • versionNumber

      ContainerGroupDefinition.Builder versionNumber(Integer versionNumber)

      Indicates the version of a particular container group definition. This number is incremented automatically when you update a container group definition. You can view, update, or delete individual versions or the entire container group definition.

      Parameters:
      versionNumber - Indicates the version of a particular container group definition. This number is incremented automatically when you update a container group definition. You can view, update, or delete individual versions or the entire container group definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionDescription

      ContainerGroupDefinition.Builder versionDescription(String versionDescription)

      An optional description that was provided for a container group definition update. Each version can have a unique description.

      Parameters:
      versionDescription - An optional description that was provided for a container group definition update. Each version can have a unique description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ContainerGroupDefinition.Builder status(String status)

      Current status of the container group definition resource. Values include:

      • COPYING -- Amazon GameLift Servers is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

      • READY -- Amazon GameLift Servers has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

      • FAILED -- Amazon GameLift Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

      Parameters:
      status - Current status of the container group definition resource. Values include:

      • COPYING -- Amazon GameLift Servers is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

      • READY -- Amazon GameLift Servers has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

      • FAILED -- Amazon GameLift Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

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

    • status

      ContainerGroupDefinition.Builder status(ContainerGroupDefinitionStatus status)

      Current status of the container group definition resource. Values include:

      • COPYING -- Amazon GameLift Servers is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

      • READY -- Amazon GameLift Servers has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

      • FAILED -- Amazon GameLift Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

      Parameters:
      status - Current status of the container group definition resource. Values include:

      • COPYING -- Amazon GameLift Servers is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.

      • READY -- Amazon GameLift Servers has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.

      • FAILED -- Amazon GameLift Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes.

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

    • statusReason

      ContainerGroupDefinition.Builder statusReason(String statusReason)

      Additional information about a container group definition that's in FAILED status. Possible reasons include:

      • An internal issue prevented Amazon GameLift Servers from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

      • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift Servers.

      • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

      • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift Servers endpoints and quotas.

      • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

      Parameters:
      statusReason - Additional information about a container group definition that's in FAILED status. Possible reasons include:

      • An internal issue prevented Amazon GameLift Servers from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.

      • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift Servers.

      • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account.

      • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift Servers endpoints and quotas.

      • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

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