software.amazon.awssdk.services.appconfig.model

Interface CreateDeploymentStrategyRequest.Builder

All Superinterfaces:

AppConfigRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateDeploymentStrategyRequest.Builder,CreateDeploymentStrategyRequest>, SdkBuilder<CreateDeploymentStrategyRequest.Builder,CreateDeploymentStrategyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDeploymentStrategyRequest

public static interface CreateDeploymentStrategyRequest.Builder
extends AppConfigRequest.Builder, SdkPojo, CopyableBuilder<CreateDeploymentStrategyRequest.Builder,CreateDeploymentStrategyRequest>

Method Summary

Modifier and Type	Method and Description
CreateDeploymentStrategyRequest.Builder	deploymentDurationInMinutes(Integer deploymentDurationInMinutes) Total amount of time for a deployment to last.
CreateDeploymentStrategyRequest.Builder	description(String description) A description of the deployment strategy.
CreateDeploymentStrategyRequest.Builder	finalBakeTimeInMinutes(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.
CreateDeploymentStrategyRequest.Builder	growthFactor(Float growthFactor) The percentage of targets to receive a deployed configuration during each interval.
CreateDeploymentStrategyRequest.Builder	growthType(GrowthType growthType) The algorithm used to define how percentage grows over time.
CreateDeploymentStrategyRequest.Builder	growthType(String growthType) The algorithm used to define how percentage grows over time.
CreateDeploymentStrategyRequest.Builder	name(String name) A name for the deployment strategy.
CreateDeploymentStrategyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateDeploymentStrategyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateDeploymentStrategyRequest.Builder	replicateTo(ReplicateTo replicateTo) Save the deployment strategy to a Systems Manager (SSM) document.
CreateDeploymentStrategyRequest.Builder	replicateTo(String replicateTo) Save the deployment strategy to a Systems Manager (SSM) document.
CreateDeploymentStrategyRequest.Builder	tags(Map<String,String> tags) Metadata to assign to the deployment strategy.

Methods inherited from interface software.amazon.awssdk.services.appconfig.model.AppConfigRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

CreateDeploymentStrategyRequest.Builder name(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.

description

CreateDeploymentStrategyRequest.Builder description(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.

deploymentDurationInMinutes

CreateDeploymentStrategyRequest.Builder deploymentDurationInMinutes(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.

finalBakeTimeInMinutes

CreateDeploymentStrategyRequest.Builder finalBakeTimeInMinutes(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.

Parameters:

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:

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

growthFactor

CreateDeploymentStrategyRequest.Builder growthFactor(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.

growthType

CreateDeploymentStrategyRequest.Builder growthType(String 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.

Parameters:

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.

Returns:

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

See Also:

GrowthType, GrowthType

growthType

CreateDeploymentStrategyRequest.Builder growthType(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.

Parameters:

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.

Returns:

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

See Also:

GrowthType, GrowthType

replicateTo

CreateDeploymentStrategyRequest.Builder replicateTo(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, ReplicateTo

replicateTo

CreateDeploymentStrategyRequest.Builder replicateTo(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, ReplicateTo

tags

CreateDeploymentStrategyRequest.Builder tags(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.

overrideConfiguration

CreateDeploymentStrategyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateDeploymentStrategyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.