Class ContainerGroupsConfiguration

java.lang.Object
software.amazon.awssdk.services.gamelift.model.ContainerGroupsConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContainerGroupsConfiguration.Builder,ContainerGroupsConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ContainerGroupsConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContainerGroupsConfiguration.Builder,ContainerGroupsConfiguration>

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

Configuration details for a set of container groups, for use when creating a fleet with compute type CONTAINER.

Used with: CreateFleet

See Also:

  • Method Details

    • hasContainerGroupDefinitionNames

      public final boolean hasContainerGroupDefinitionNames()
      For responses, this returns true if the service returned a value for the ContainerGroupDefinitionNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • containerGroupDefinitionNames

      public final List<String> containerGroupDefinitionNames()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContainerGroupDefinitionNames() method.

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

    • connectionPortRange

      public final 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.

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

    • desiredReplicaContainerGroupsPerInstance

      public final 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.

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

    • toBuilder

      public ContainerGroupsConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ContainerGroupsConfiguration.Builder,ContainerGroupsConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ContainerGroupsConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerGroupsConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.