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

Class ContainerGroupsAttributes

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

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

The properties of container groups that are running on a container fleet. Container group properties for a fleet can't be changed.

Returned by: DescribeFleetAttributes, CreateFleet

See Also:

  • Method Details

    • hasContainerGroupDefinitionProperties

      public final boolean hasContainerGroupDefinitionProperties()
      For responses, this returns true if the service returned a value for the ContainerGroupDefinitionProperties 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.

    • containerGroupDefinitionProperties

      public final List<ContainerGroupDefinitionProperty> containerGroupDefinitionProperties()

      A collection of properties that describe each container group in the fleet. A container fleet is deployed with one or more ContainerGroupDefinition resources, which is where these properties are set.

      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 hasContainerGroupDefinitionProperties() method.

      Returns:
      A collection of properties that describe each container group in the fleet. A container fleet is deployed with one or more ContainerGroupDefinition resources, which is where these properties are set.

    • connectionPortRange

      public final ConnectionPortRange connectionPortRange()

      A set of ports that allow inbound traffic to connect to processes running in the fleet's container groups. Amazon GameLift maps each connection port to a container port, which is assigned to a specific container process. A fleet's connection port range can't be changed, but you can control access to connection ports by updating a fleet's EC2InboundPermissions with UpdateFleetPortSettings.

      Returns:
      A set of ports that allow inbound traffic to connect to processes running in the fleet's container groups. Amazon GameLift maps each connection port to a container port, which is assigned to a specific container process. A fleet's connection port range can't be changed, but you can control access to connection ports by updating a fleet's EC2InboundPermissions with UpdateFleetPortSettings.

    • containerGroupsPerInstance

      public final ContainerGroupsPerInstance containerGroupsPerInstance()

      Details about the number of replica container groups that Amazon GameLift deploys to each instance in the container fleet.

      Returns:
      Details about the number of replica container groups that Amazon GameLift deploys to each instance in the container fleet.

    • toBuilder

      public ContainerGroupsAttributes.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<ContainerGroupsAttributes.Builder,ContainerGroupsAttributes>
      Returns:
      a builder for type T

    • builder

      public static ContainerGroupsAttributes.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerGroupsAttributes.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.