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

Interface ContainerGroupDefinition.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ContainerGroupDefinition.Builder,ContainerGroupDefinition>, SdkBuilder<ContainerGroupDefinition.Builder,ContainerGroupDefinition>, SdkPojo
Enclosing class:
ContainerGroupDefinition
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 ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].

      Parameters:
      containerGroupDefinitionArn - The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name] .
      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 required for all containers in the container group definition.

      Parameters:
      operatingSystem - The platform required for all containers in the container group definition.
      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 required for all containers in the container group definition.

      Parameters:
      operatingSystem - The platform required for all containers in the container group definition.
      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.

    • schedulingStrategy

      ContainerGroupDefinition.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 maintains only one copy per fleet instance.

      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 maintains only one copy per fleet instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schedulingStrategy

      ContainerGroupDefinition.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 maintains only one copy per fleet instance.

      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 maintains only one copy per fleet instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • totalMemoryLimit

      ContainerGroupDefinition.Builder totalMemoryLimit(Integer totalMemoryLimit)

      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 additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

      • Equal to or greater than the sum of all container-specific soft memory limits in the group.

      • Equal to or greater than any container-specific hard limits in the group.

      For more details on memory allocation, see the Container fleet design guide.

      Parameters:
      totalMemoryLimit - 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 additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

      • Equal to or greater than the sum of all container-specific soft memory limits in the group.

      • Equal to or greater than any container-specific hard limits in the group.

      For more details on memory allocation, see the Container fleet design guide.

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

    • totalCpuLimit

      ContainerGroupDefinition.Builder totalCpuLimit(Integer totalCpuLimit)

      The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

      You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

      For more details on memory allocation, see the Container fleet design guide.

      Parameters:
      totalCpuLimit - The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

      You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

      For more details on memory allocation, see the Container fleet design guide.

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

    • containerDefinitions

      ContainerGroupDefinition.Builder containerDefinitions(Collection<ContainerDefinition> containerDefinitions)

      The set of container definitions that are included in the container group.

      Parameters:
      containerDefinitions - The set of container definitions that are included in the container group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerDefinitions

      ContainerGroupDefinition.Builder containerDefinitions(ContainerDefinition... containerDefinitions)

      The set of container definitions that are included in the container group.

      Parameters:
      containerDefinitions - The set of container definitions that are included in the container group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerDefinitions

      ContainerGroupDefinition.Builder containerDefinitions(Consumer<ContainerDefinition.Builder>... containerDefinitions)

      The set of container definitions that are included in the container group.

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

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

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

    • status

      ContainerGroupDefinition.Builder status(String status)

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

      • COPYING -- Amazon GameLift 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 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 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 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 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 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 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 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 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 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 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 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 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.

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

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