Class UpdateContainerFleetRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.gamelift.model.GameLiftRequest
software.amazon.awssdk.services.gamelift.model.UpdateContainerFleetRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateContainerFleetRequest.Builder,UpdateContainerFleetRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateContainerFleetRequest extends GameLiftRequest implements ToCopyableBuilder<UpdateContainerFleetRequest.Builder,UpdateContainerFleetRequest>

  • Method Details

    • fleetId

      public final String fleetId()

      A unique identifier for the container fleet to update. You can use either the fleet ID or ARN value.

      Returns:
      A unique identifier for the container fleet to update. You can use either the fleet ID or ARN value.

    • gameServerContainerGroupDefinitionName

      public final String gameServerContainerGroupDefinitionName()

      The name or ARN value of a new game server container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value. You can't remove a fleet's game server container group definition, you can only update or replace it with another definition.

      Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

      Returns:
      The name or ARN value of a new game server container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value. You can't remove a fleet's game server container group definition, you can only update or replace it with another definition.

      Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

    • perInstanceContainerGroupDefinitionName

      public final String perInstanceContainerGroupDefinitionName()

      The name or ARN value of a new per-instance container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value.

      Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

      To remove a fleet's per-instance container group definition, leave this parameter empty and use the parameter RemoveAttributes.

      Returns:
      The name or ARN value of a new per-instance container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value.

      Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

      To remove a fleet's per-instance container group definition, leave this parameter empty and use the parameter RemoveAttributes.

    • gameServerContainerGroupsPerInstance

      public final Integer gameServerContainerGroupsPerInstance()

      The number of times to replicate the game server container group on each fleet instance. By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. You can remove this property value to use the calculated value, or set it manually. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.

      Returns:
      The number of times to replicate the game server container group on each fleet instance. By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. You can remove this property value to use the calculated value, or set it manually. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.

    • instanceConnectionPortRange

      public final ConnectionPortRange instanceConnectionPortRange()

      A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. If you previously set this parameter manually, you can't reset this to use the calculated settings.

      Returns:
      A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. If you previously set this parameter manually, you can't reset this to use the calculated settings.

    • hasInstanceInboundPermissionAuthorizations

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

    • instanceInboundPermissionAuthorizations

      public final List<IpPermission> instanceInboundPermissionAuthorizations()

      A set of ports to add to the container fleet's inbound permissions.

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

      Returns:
      A set of ports to add to the container fleet's inbound permissions.

    • hasInstanceInboundPermissionRevocations

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

    • instanceInboundPermissionRevocations

      public final List<IpPermission> instanceInboundPermissionRevocations()

      A set of ports to remove from the container fleet's inbound permissions.

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

      Returns:
      A set of ports to remove from the container fleet's inbound permissions.

    • deploymentConfiguration

      public final DeploymentConfiguration deploymentConfiguration()

      Instructions for how to deploy updates to a container fleet, if the fleet update initiates a deployment. The deployment configuration lets you determine how to replace fleet instances and what actions to take if the deployment fails.

      Returns:
      Instructions for how to deploy updates to a container fleet, if the fleet update initiates a deployment. The deployment configuration lets you determine how to replace fleet instances and what actions to take if the deployment fails.

    • description

      public final String description()

      A meaningful description of the container fleet.

      Returns:
      A meaningful description of the container fleet.

    • hasMetricGroups

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

    • metricGroups

      public final List<String> metricGroups()

      The name of an Amazon Web Services CloudWatch metric group to add this fleet to.

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

      Returns:
      The name of an Amazon Web Services CloudWatch metric group to add this fleet to.

    • newGameSessionProtectionPolicy

      public final ProtectionPolicy newGameSessionProtectionPolicy()

      The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.

      If the service returns an enum value that is not available in the current SDK version, newGameSessionProtectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from newGameSessionProtectionPolicyAsString().

      Returns:
      The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.
      See Also:

    • newGameSessionProtectionPolicyAsString

      public final String newGameSessionProtectionPolicyAsString()

      The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.

      If the service returns an enum value that is not available in the current SDK version, newGameSessionProtectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from newGameSessionProtectionPolicyAsString().

      Returns:
      The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.
      See Also:

    • gameSessionCreationLimitPolicy

      public final GameSessionCreationLimitPolicy gameSessionCreationLimitPolicy()

      A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.

      Returns:
      A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.

    • logConfiguration

      public final LogConfiguration logConfiguration()

      The method for collecting container logs for the fleet.

      Returns:
      The method for collecting container logs for the fleet.

    • removeAttributes

      public final List<ContainerFleetRemoveAttribute> removeAttributes()

      If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

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

      Returns:
      If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

    • hasRemoveAttributes

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

    • removeAttributesAsStrings

      public final List<String> removeAttributesAsStrings()

      If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

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

      Returns:
      If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

    • toBuilder

      public UpdateContainerFleetRequest.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<UpdateContainerFleetRequest.Builder,UpdateContainerFleetRequest>
      Specified by:
      toBuilder in class GameLiftRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateContainerFleetRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.