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. For how Amazon GameLift Servers validates and rolls out a deployment, see Container fleet deployments.

See Also:
  • Method Details

    • protectionStrategy

      public final DeploymentProtectionStrategy protectionStrategy()

      Determines how fleet deployment activity affects active game sessions on the fleet. A protected game session can't be terminated while it's active; a fleet sets the default protection for its new game sessions with NewGameSessionProtectionPolicy.

      • WITH_PROTECTION -- The deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends.

      • IGNORE_PROTECTION -- The deployment replaces containers regardless of game session activity, including active game sessions. This option is useful during development and testing.

      This setting also affects how long deployment validation can take. When the fleet's NewGameSessionProtectionPolicy is FullProtection and the deployment uses WITH_PROTECTION, validation waits for protected game sessions to end.

      Default value: WITH_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. A protected game session can't be terminated while it's active; a fleet sets the default protection for its new game sessions with NewGameSessionProtectionPolicy.

      • WITH_PROTECTION -- The deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends.

      • IGNORE_PROTECTION -- The deployment replaces containers regardless of game session activity, including active game sessions. This option is useful during development and testing.

      This setting also affects how long deployment validation can take. When the fleet's NewGameSessionProtectionPolicy is FullProtection and the deployment uses WITH_PROTECTION, validation waits for protected game sessions to end.

      Default value: WITH_PROTECTION

      See Also:
    • protectionStrategyAsString

      public final String protectionStrategyAsString()

      Determines how fleet deployment activity affects active game sessions on the fleet. A protected game session can't be terminated while it's active; a fleet sets the default protection for its new game sessions with NewGameSessionProtectionPolicy.

      • WITH_PROTECTION -- The deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends.

      • IGNORE_PROTECTION -- The deployment replaces containers regardless of game session activity, including active game sessions. This option is useful during development and testing.

      This setting also affects how long deployment validation can take. When the fleet's NewGameSessionProtectionPolicy is FullProtection and the deployment uses WITH_PROTECTION, validation waits for protected game sessions to end.

      Default value: WITH_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. A protected game session can't be terminated while it's active; a fleet sets the default protection for its new game sessions with NewGameSessionProtectionPolicy.

      • WITH_PROTECTION -- The deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends.

      • IGNORE_PROTECTION -- The deployment replaces containers regardless of game session activity, including active game sessions. This option is useful during development and testing.

      This setting also affects how long deployment validation can take. When the fleet's NewGameSessionProtectionPolicy is FullProtection and the deployment uses WITH_PROTECTION, validation waits for protected game sessions to end.

      Default value: WITH_PROTECTION

      See Also:
    • minimumHealthyPercentage

      public final Integer minimumHealthyPercentage()

      Sets the minimum percentage of the fleet's game server container groups to keep healthy during deployment activity. A low value favors deployment speed; a high value favors game server availability. For example, if the fleet runs 20 game server container groups and this value is 75, Amazon GameLift Servers keeps at least 15 of them healthy, so it replaces no more than 5 at a time.

      Default value: 75

      Returns:
      Sets the minimum percentage of the fleet's game server container groups to keep healthy during deployment activity. A low value favors deployment speed; a high value favors game server availability. For example, if the fleet runs 20 game server container groups and this value is 75, Amazon GameLift Servers keeps at least 15 of them healthy, so it replaces no more than 5 at a time.

      Default value: 75

    • impairmentStrategy

      public final DeploymentImpairmentStrategy impairmentStrategy()

      Determines what actions to take if a deployment fails validation. If the fleet is multi-location, this strategy applies across all fleet locations.

      • ROLLBACK -- Returns all of the fleet's containers to the last successful deployment.

      • MAINTAIN -- Keeps the containers that failed validation in place so that you can inspect them, and returns all other containers to the last successful deployment. Use this option when you're deploying a container image that you want to be able to debug on failure.

      Default value: MAINTAIN

      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 validation. If the fleet is multi-location, this strategy applies across all fleet locations.

      • ROLLBACK -- Returns all of the fleet's containers to the last successful deployment.

      • MAINTAIN -- Keeps the containers that failed validation in place so that you can inspect them, and returns all other containers to the last successful deployment. Use this option when you're deploying a container image that you want to be able to debug on failure.

      Default value: MAINTAIN

      See Also:
    • impairmentStrategyAsString

      public final String impairmentStrategyAsString()

      Determines what actions to take if a deployment fails validation. If the fleet is multi-location, this strategy applies across all fleet locations.

      • ROLLBACK -- Returns all of the fleet's containers to the last successful deployment.

      • MAINTAIN -- Keeps the containers that failed validation in place so that you can inspect them, and returns all other containers to the last successful deployment. Use this option when you're deploying a container image that you want to be able to debug on failure.

      Default value: MAINTAIN

      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 validation. If the fleet is multi-location, this strategy applies across all fleet locations.

      • ROLLBACK -- Returns all of the fleet's containers to the last successful deployment.

      • MAINTAIN -- Keeps the containers that failed validation in place so that you can inspect them, and returns all other containers to the last successful deployment. Use this option when you're deploying a container image that you want to be able to debug on failure.

      Default value: MAINTAIN

      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.