com.amazonaws.services.appconfig.model

Class CreateDeploymentStrategyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.appconfig.model.CreateDeploymentStrategyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDeploymentStrategyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDeploymentStrategyRequest()

Method Summary

Modifier and Type	Method and Description
CreateDeploymentStrategyRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateDeploymentStrategyRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateDeploymentStrategyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getDeploymentDurationInMinutes() Total amount of time for a deployment to last.
String	getDescription() A description of the deployment strategy.
Integer	getFinalBakeTimeInMinutes() Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete.
Float	getGrowthFactor() The percentage of targets to receive a deployed configuration during each interval.
String	getGrowthType() The algorithm used to define how percentage grows over time.
String	getName() A name for the deployment strategy.
String	getReplicateTo() Save the deployment strategy to a Systems Manager (SSM) document.
Map<String,String>	getTags() Metadata to assign to the deployment strategy.
int	hashCode()
void	setDeploymentDurationInMinutes(Integer deploymentDurationInMinutes) Total amount of time for a deployment to last.
void	setDescription(String description) A description of the deployment strategy.
void	setFinalBakeTimeInMinutes(Integer finalBakeTimeInMinutes) Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete.
void	setGrowthFactor(Float growthFactor) The percentage of targets to receive a deployed configuration during each interval.
void	setGrowthType(String growthType) The algorithm used to define how percentage grows over time.
void	setName(String name) A name for the deployment strategy.
void	setReplicateTo(String replicateTo) Save the deployment strategy to a Systems Manager (SSM) document.
void	setTags(Map<String,String> tags) Metadata to assign to the deployment strategy.
String	toString() Returns a string representation of this object.
CreateDeploymentStrategyRequest	withDeploymentDurationInMinutes(Integer deploymentDurationInMinutes) Total amount of time for a deployment to last.
CreateDeploymentStrategyRequest	withDescription(String description) A description of the deployment strategy.
CreateDeploymentStrategyRequest	withFinalBakeTimeInMinutes(Integer finalBakeTimeInMinutes) Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete.
CreateDeploymentStrategyRequest	withGrowthFactor(Float growthFactor) The percentage of targets to receive a deployed configuration during each interval.
CreateDeploymentStrategyRequest	withGrowthType(GrowthType growthType) The algorithm used to define how percentage grows over time.
CreateDeploymentStrategyRequest	withGrowthType(String growthType) The algorithm used to define how percentage grows over time.
CreateDeploymentStrategyRequest	withName(String name) A name for the deployment strategy.
CreateDeploymentStrategyRequest	withReplicateTo(ReplicateTo replicateTo) Save the deployment strategy to a Systems Manager (SSM) document.
CreateDeploymentStrategyRequest	withReplicateTo(String replicateTo) Save the deployment strategy to a Systems Manager (SSM) document.
CreateDeploymentStrategyRequest	withTags(Map<String,String> tags) Metadata to assign to the deployment strategy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDeploymentStrategyRequest

public CreateDeploymentStrategyRequest()

Method Detail

setName

public void setName(String name)

A name for the deployment strategy.

Parameters:

name - A name for the deployment strategy.

getName

public String getName()

A name for the deployment strategy.

Returns:

A name for the deployment strategy.

withName

public CreateDeploymentStrategyRequest withName(String name)

A name for the deployment strategy.

Parameters:

name - A name for the deployment strategy.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description of the deployment strategy.

Parameters:

description - A description of the deployment strategy.

getDescription

public String getDescription()

A description of the deployment strategy.

Returns:

A description of the deployment strategy.

withDescription

public CreateDeploymentStrategyRequest withDescription(String description)

A description of the deployment strategy.

Parameters:

description - A description of the deployment strategy.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeploymentDurationInMinutes

public void setDeploymentDurationInMinutes(Integer deploymentDurationInMinutes)

Total amount of time for a deployment to last.

Parameters:

deploymentDurationInMinutes - Total amount of time for a deployment to last.

getDeploymentDurationInMinutes

public Integer getDeploymentDurationInMinutes()

Total amount of time for a deployment to last.

Returns:

Total amount of time for a deployment to last.

withDeploymentDurationInMinutes

public CreateDeploymentStrategyRequest withDeploymentDurationInMinutes(Integer deploymentDurationInMinutes)

Total amount of time for a deployment to last.

Parameters:

deploymentDurationInMinutes - Total amount of time for a deployment to last.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFinalBakeTimeInMinutes

public void setFinalBakeTimeInMinutes(Integer finalBakeTimeInMinutes)

Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

Parameters:

finalBakeTimeInMinutes - Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

getFinalBakeTimeInMinutes

public Integer getFinalBakeTimeInMinutes()

Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

Returns:

Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

withFinalBakeTimeInMinutes

public CreateDeploymentStrategyRequest withFinalBakeTimeInMinutes(Integer finalBakeTimeInMinutes)

Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

Parameters:

finalBakeTimeInMinutes - Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setGrowthFactor

public void setGrowthFactor(Float growthFactor)

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

Parameters:

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

getGrowthFactor

public Float getGrowthFactor()

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.

withGrowthFactor

public CreateDeploymentStrategyRequest withGrowthFactor(Float growthFactor)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setGrowthType

public void setGrowthType(String 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 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.

Parameters:

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

getGrowthType

public String getGrowthType()

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

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

withGrowthType

public CreateDeploymentStrategyRequest withGrowthType(String 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 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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GrowthType

withGrowthType

public CreateDeploymentStrategyRequest withGrowthType(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 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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GrowthType

setReplicateTo

public void setReplicateTo(String replicateTo)

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

Parameters:

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

See Also:

ReplicateTo

getReplicateTo

public String getReplicateTo()

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

Returns:

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

See Also:

ReplicateTo

withReplicateTo

public CreateDeploymentStrategyRequest withReplicateTo(String replicateTo)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicateTo

withReplicateTo

public CreateDeploymentStrategyRequest withReplicateTo(ReplicateTo replicateTo)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicateTo

getTags

public Map<String,String> getTags()

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.

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.

setTags

public void setTags(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.

Parameters:

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.

withTags

public CreateDeploymentStrategyRequest withTags(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateDeploymentStrategyRequest addTagsEntry(String key,
                                                    String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateDeploymentStrategyRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDeploymentStrategyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()