UpdateDeploymentStrategyCommand

Suggest an Edit

Updates a deployment strategy.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppConfigClient, UpdateDeploymentStrategyCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
// const { AppConfigClient, UpdateDeploymentStrategyCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
const client = new AppConfigClient(config);
const input = { // UpdateDeploymentStrategyRequest
  DeploymentStrategyId: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  DeploymentDurationInMinutes: Number("int"),
  FinalBakeTimeInMinutes: Number("int"),
  GrowthFactor: Number("float"),
  GrowthType: "LINEAR" || "EXPONENTIAL",
};
const command = new UpdateDeploymentStrategyCommand(input);
const response = await client.send(command);
// { // DeploymentStrategy
//   Id: "STRING_VALUE",
//   Name: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   DeploymentDurationInMinutes: Number("int"),
//   GrowthType: "LINEAR" || "EXPONENTIAL",
//   GrowthFactor: Number("float"),
//   FinalBakeTimeInMinutes: Number("int"),
//   ReplicateTo: "NONE" || "SSM_DOCUMENT",
// };

Example Usage

 Loading code editorLoading code editor

UpdateDeploymentStrategyCommand Input

See UpdateDeploymentStrategyCommandInput for more details

Parameter
Type
Description
DeploymentStrategyId
Required
string | undefined

The deployment strategy ID.

DeploymentDurationInMinutes
number | undefined

Total amount of time for a deployment to last.

Description
string | undefined

A description of the deployment strategy.

FinalBakeTimeInMinutes
number | undefined

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

GrowthFactor
number | undefined

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

GrowthType
GrowthType | undefined

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.

UpdateDeploymentStrategyCommand Output

See UpdateDeploymentStrategyCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DeploymentDurationInMinutes
number | undefined

Total amount of time the deployment lasted.

Description
string | undefined

The description of the deployment strategy.

FinalBakeTimeInMinutes
number | undefined

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

GrowthFactor
number | undefined

The percentage of targets that received a deployed configuration during each interval.

GrowthType
GrowthType | undefined

The algorithm used to define how percentage grew over time.

Id
string | undefined

The deployment strategy ID.

Name
string | undefined

The name of the deployment strategy.

ReplicateTo
ReplicateTo | undefined

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

Throws

Name
Fault
Details
BadRequestException
client

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException
server

There was an internal failure in the AppConfig service.

ResourceNotFoundException
client

The requested resource could not be found.

AppConfigServiceException
Base exception class for all service exceptions from AppConfig service.