@Generated(value="software.amazon.awssdk:codegen") public final class CreateDeploymentStrategyRequest extends AppConfigRequest implements ToCopyableBuilder<CreateDeploymentStrategyRequest.Builder,CreateDeploymentStrategyRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateDeploymentStrategyRequest.Builder |
| 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.
|
overrideConfigurationcopypublic final String name()
A name for the deployment strategy.
public final String description()
A description of the deployment strategy.
public final Integer deploymentDurationInMinutes()
Total amount of time for a deployment to last.
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.
public final Float growthFactor()
The percentage of targets to receive a deployed configuration during each interval.
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().
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.
GrowthTypepublic 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().
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.
GrowthTypepublic 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().
ReplicateTopublic 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().
ReplicateTopublic final boolean hasTags()
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.
public CreateDeploymentStrategyRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateDeploymentStrategyRequest.Builder,CreateDeploymentStrategyRequest>toBuilder in class AppConfigRequestpublic static CreateDeploymentStrategyRequest.Builder builder()
public static Class<? extends CreateDeploymentStrategyRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.