Package software.amazon.awssdk.services.appconfig.model

Class UpdateDeploymentStrategyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appconfig.model.AppConfigRequest

software.amazon.awssdk.services.appconfig.model.UpdateDeploymentStrategyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDeploymentStrategyRequest.Builder,UpdateDeploymentStrategyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateDeploymentStrategyRequest
extends AppConfigRequest
implements ToCopyableBuilder<UpdateDeploymentStrategyRequest.Builder,UpdateDeploymentStrategyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateDeploymentStrategyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateDeploymentStrategyRequest.Builder	builder()
Integer	deploymentDurationInMinutes()	Total amount of time for a deployment to last.
String	deploymentStrategyId()	The deployment strategy ID.
String	description()	A description of the deployment strategy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	finalBakeTimeInMinutes()	The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Float	growthFactor()	The percentage of targets to receive a deployed configuration during each interval.
GrowthType	growthType()	The algorithm used to define how percentage grows over time.
String	growthTypeAsString()	The algorithm used to define how percentage grows over time.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDeploymentStrategyRequest.Builder>	serializableBuilderClass()
UpdateDeploymentStrategyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

deploymentStrategyId

public final String deploymentStrategyId()

The deployment strategy ID.

Returns:

The deployment strategy ID.

description

public final String description()

A description of the deployment strategy.

Returns:

A description of the deployment strategy.

deploymentDurationInMinutes

public final Integer deploymentDurationInMinutes()

Total amount of time for a deployment to last.

Returns:

Total amount of time for a deployment to last.

finalBakeTimeInMinutes

public final Integer finalBakeTimeInMinutes()

The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

Returns:

The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

growthFactor

public final Float growthFactor()

The percentage of targets to receive a deployed configuration during each interval.

Returns:

The percentage of targets to receive a deployed configuration during each interval.

growthType

public final GrowthType growthType()

The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

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

Returns:

The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

See Also:

GrowthType

growthTypeAsString

public final String growthTypeAsString()

The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

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

Returns:

The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

See Also:

GrowthType

toBuilder

public UpdateDeploymentStrategyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDeploymentStrategyRequest.Builder,UpdateDeploymentStrategyRequest>

Specified by:

toBuilder in class AppConfigRequest

builder

public static UpdateDeploymentStrategyRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo