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

Interface ContainerGroupsConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ContainerGroupsConfiguration.Builder,ContainerGroupsConfiguration>, SdkBuilder<ContainerGroupsConfiguration.Builder,ContainerGroupsConfiguration>, SdkPojo
Enclosing class:
ContainerGroupsConfiguration
public static interface ContainerGroupsConfiguration.Builder extends SdkPojo, CopyableBuilder<ContainerGroupsConfiguration.Builder,ContainerGroupsConfiguration>

  • Method Details

    • containerGroupDefinitionNames

      ContainerGroupsConfiguration.Builder containerGroupDefinitionNames(Collection<String> containerGroupDefinitionNames)

      The list of container group definition names to deploy to a new container fleet.

      Parameters:
      containerGroupDefinitionNames - The list of container group definition names to deploy to a new container fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerGroupDefinitionNames

      ContainerGroupsConfiguration.Builder containerGroupDefinitionNames(String... containerGroupDefinitionNames)

      The list of container group definition names to deploy to a new container fleet.

      Parameters:
      containerGroupDefinitionNames - The list of container group definition names to deploy to a new container fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectionPortRange

      ContainerGroupsConfiguration.Builder connectionPortRange(ConnectionPortRange connectionPortRange)

      A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.

      Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:

      [Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]

      As a best practice, double the minimum number of connection ports.

      Use the fleet's EC2InboundPermissions property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. See IpPermission for more details.

      Parameters:
      connectionPortRange - A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.

      Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:

      [Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]

      As a best practice, double the minimum number of connection ports.

      Use the fleet's EC2InboundPermissions property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. See IpPermission for more details.

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

    • connectionPortRange

      default ContainerGroupsConfiguration.Builder connectionPortRange(Consumer<ConnectionPortRange.Builder> connectionPortRange)

      A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.

      Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:

      [Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]

      As a best practice, double the minimum number of connection ports.

      Use the fleet's EC2InboundPermissions property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. See IpPermission for more details.

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

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

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

    • desiredReplicaContainerGroupsPerInstance

      ContainerGroupsConfiguration.Builder desiredReplicaContainerGroupsPerInstance(Integer desiredReplicaContainerGroupsPerInstance)

      The number of times to replicate the replica container group on each instance in a container fleet. By default, Amazon GameLift calculates the maximum number of replica container groups that can fit on a fleet instance (based on CPU and memory resources). Leave this parameter empty if you want to use the maximum number, or specify a desired number to override the maximum. The desired number is used if it's less than the maximum number.

      Parameters:
      desiredReplicaContainerGroupsPerInstance - The number of times to replicate the replica container group on each instance in a container fleet. By default, Amazon GameLift calculates the maximum number of replica container groups that can fit on a fleet instance (based on CPU and memory resources). Leave this parameter empty if you want to use the maximum number, or specify a desired number to override the maximum. The desired number is used if it's less than the maximum number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.