createDeploymentStrategy method

Future<DeploymentStrategy> createDeploymentStrategy({ required int deploymentDurationInMinutes, required double growthFactor, required String name, required ReplicateTo replicateTo, String? description, int? finalBakeTimeInMinutes, GrowthType? growthType, Map<String, String>? tags, })

A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

May throw InternalServerException. May throw BadRequestException.

Parameter deploymentDurationInMinutes : Total amount of time for a deployment to last.

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

Parameter name : A name for the deployment strategy.

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

Parameter description : A description of the deployment strategy.

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

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

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

Implementation

Future<DeploymentStrategy> createDeploymentStrategy({
  required int deploymentDurationInMinutes,
  required double growthFactor,
  required String name,
  required ReplicateTo replicateTo,
  String? description,
  int? finalBakeTimeInMinutes,
  GrowthType? growthType,
  Map<String, String>? tags,
}) async {
  ArgumentError.checkNotNull(
      deploymentDurationInMinutes, 'deploymentDurationInMinutes');
  _s.validateNumRange(
    'deploymentDurationInMinutes',
    deploymentDurationInMinutes,
    0,
    1440,
    isRequired: true,
  );
  ArgumentError.checkNotNull(growthFactor, 'growthFactor');
  _s.validateNumRange(
    'growthFactor',
    growthFactor,
    1,
    100,
    isRequired: true,
  );
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    64,
    isRequired: true,
  );
  ArgumentError.checkNotNull(replicateTo, 'replicateTo');
  _s.validateStringLength(
    'description',
    description,
    0,
    1024,
  );
  _s.validateNumRange(
    'finalBakeTimeInMinutes',
    finalBakeTimeInMinutes,
    0,
    1440,
  );
  final $payload = <String, dynamic>{
    'DeploymentDurationInMinutes': deploymentDurationInMinutes,
    'GrowthFactor': growthFactor,
    'Name': name,
    'ReplicateTo': replicateTo.toValue(),
    if (description != null) 'Description': description,
    if (finalBakeTimeInMinutes != null)
      'FinalBakeTimeInMinutes': finalBakeTimeInMinutes,
    if (growthType != null) 'GrowthType': growthType.toValue(),
    if (tags != null) 'Tags': tags,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/deploymentstrategies',
    exceptionFnMap: _exceptionFns,
  );
  return DeploymentStrategy.fromJson(response);
}