Class DeploymentConfiguration

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

Set of rules for processing a deployment for a container fleet update.

See Also:

  • Method Details

    • protectionStrategy

      public final DeploymentProtectionStrategy protectionStrategy()

      Determines how fleet deployment activity affects active game sessions on the fleet. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.

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

      Returns:
      Determines how fleet deployment activity affects active game sessions on the fleet. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.
      See Also:

    • protectionStrategyAsString

      public final String protectionStrategyAsString()

      Determines how fleet deployment activity affects active game sessions on the fleet. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.

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

      Returns:
      Determines how fleet deployment activity affects active game sessions on the fleet. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.
      See Also:

    • minimumHealthyPercentage

      public final Integer minimumHealthyPercentage()

      Sets a minimum level of healthy tasks to maintain during deployment activity.

      Returns:
      Sets a minimum level of healthy tasks to maintain during deployment activity.

    • impairmentStrategy

      public final DeploymentImpairmentStrategy impairmentStrategy()

      Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.

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

      Returns:
      Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.
      See Also:

    • impairmentStrategyAsString

      public final String impairmentStrategyAsString()

      Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.

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

      Returns:
      Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.
      See Also:

    • toBuilder

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

    • builder

      public static DeploymentConfiguration.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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