software.amazon.awssdk.services.appconfig.model

Class CreateDeploymentStrategyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeploymentStrategyRequest.Builder,CreateDeploymentStrategyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDeploymentStrategyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDeploymentStrategyRequest.Builder	builder()
Integer	deploymentDurationInMinutes() Total amount of time for a deployment to last.
String	description() A description of the deployment strategy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Integer	finalBakeTimeInMinutes() The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() A name for the deployment strategy.
ReplicateTo	replicateTo() Save the deployment strategy to a Systems Manager (SSM) document.
String	replicateToAsString() Save the deployment strategy to a Systems Manager (SSM) document.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeploymentStrategyRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Metadata to assign to the deployment strategy.
CreateDeploymentStrategyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

A name for the deployment strategy.

Returns:

A name for the deployment strategy.

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 AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

Returns:

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

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. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the 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. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the 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. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the 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. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the 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

replicateTo

public final ReplicateTo replicateTo()

Save the deployment strategy to a Systems Manager (SSM) document.

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

Returns:

Save the deployment strategy to a Systems Manager (SSM) document.

See Also:

ReplicateTo

replicateToAsString

public final String replicateToAsString()

Save the deployment strategy to a Systems Manager (SSM) document.

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

Returns:

Save the deployment strategy to a Systems Manager (SSM) document.

See Also:

ReplicateTo

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

toBuilder

public CreateDeploymentStrategyRequest.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<CreateDeploymentStrategyRequest.Builder,CreateDeploymentStrategyRequest>

Specified by:

toBuilder in class AppConfigRequest

Returns:

a builder for type T

builder

public static CreateDeploymentStrategyRequest.Builder builder()

serializableBuilderClass

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