Class DeploymentConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()Determines what actions to take if a deployment fails validation.final StringDetermines what actions to take if a deployment fails validation.final IntegerSets the minimum percentage of the fleet's game server container groups to keep healthy during deployment activity.Determines how fleet deployment activity affects active game sessions on the fleet.final StringDetermines how fleet deployment activity affects active game sessions on the fleet.static Class<? extends DeploymentConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
NewGameSessionProtectionPolicyisFullProtectionand the deployment usesWITH_PROTECTION, validation waits for protected game sessions to end.Default value:
WITH_PROTECTIONIf the service returns an enum value that is not available in the current SDK version,
protectionStrategywill returnDeploymentProtectionStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprotectionStrategyAsString().- 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
NewGameSessionProtectionPolicyisFullProtectionand the deployment usesWITH_PROTECTION, validation waits for protected game sessions to end.Default value:
WITH_PROTECTION -
- See Also:
-
-
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
NewGameSessionProtectionPolicyisFullProtectionand the deployment usesWITH_PROTECTION, validation waits for protected game sessions to end.Default value:
WITH_PROTECTIONIf the service returns an enum value that is not available in the current SDK version,
protectionStrategywill returnDeploymentProtectionStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprotectionStrategyAsString().- 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
NewGameSessionProtectionPolicyisFullProtectionand the deployment usesWITH_PROTECTION, validation waits for protected game sessions to end.Default value:
WITH_PROTECTION -
- See Also:
-
-
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
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:
MAINTAINIf the service returns an enum value that is not available in the current SDK version,
impairmentStrategywill returnDeploymentImpairmentStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromimpairmentStrategyAsString().- 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
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:
MAINTAINIf the service returns an enum value that is not available in the current SDK version,
impairmentStrategywill returnDeploymentImpairmentStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromimpairmentStrategyAsString().- 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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<DeploymentConfiguration.Builder,DeploymentConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-