deployment_strategies

Creates, updates, deletes or gets a deployment_strategy resource or lists deployment_strategies in a region

Overview

Name	deployment_strategies
Type	Resource
Description	Resource Type definition for AWS::AppConfig::DeploymentStrategy
Id	aws.appconfig.deployment_strategies

Fields

Name	Datatype	Description
deployment_duration_in_minutes	number	Total amount of time for a deployment to last.
description	string	A description of the deployment strategy.
final_bake_time_in_minutes	number	Specifies the amount of time AWS 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, AWS AppConfig rolls back the deployment. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AWS AppConfig User Guide.
growth_factor	number	The percentage of targets to receive a deployed configuration during each interval.
growth_type	string	The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: Linear: For this type, AWS 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, AWS 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.
name	string	A name for the deployment strategy.
replicate_to	string	Save the deployment strategy to a Systems Manager (SSM) document.
tags	array	Assigns metadata to an AWS AppConfig resource. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
id	string	The deployment strategy ID.
region	string	AWS region.

For more information, see AWS::AppConfig::DeploymentStrategy.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DeploymentDurationInMinutes, GrowthFactor, Name, ReplicateTo, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all deployment_strategies in a region.

SELECT
region,
deployment_duration_in_minutes,
description,
final_bake_time_in_minutes,
growth_factor,
growth_type,
name,
replicate_to,
tags,
id
FROM aws.appconfig.deployment_strategies
WHERE region = 'us-east-1';

Gets all properties from an individual deployment_strategy.

SELECT
region,
deployment_duration_in_minutes,
description,
final_bake_time_in_minutes,
growth_factor,
growth_type,
name,
replicate_to,
tags,
id
FROM aws.appconfig.deployment_strategies
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new deployment_strategy resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.appconfig.deployment_strategies (
 DeploymentDurationInMinutes,
 GrowthFactor,
 Name,
 ReplicateTo,
 region
)
SELECT 
'{{ DeploymentDurationInMinutes }}',
 '{{ GrowthFactor }}',
 '{{ Name }}',
 '{{ ReplicateTo }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appconfig.deployment_strategies (
 DeploymentDurationInMinutes,
 Description,
 FinalBakeTimeInMinutes,
 GrowthFactor,
 GrowthType,
 Name,
 ReplicateTo,
 Tags,
 region
)
SELECT 
 '{{ DeploymentDurationInMinutes }}',
 '{{ Description }}',
 '{{ FinalBakeTimeInMinutes }}',
 '{{ GrowthFactor }}',
 '{{ GrowthType }}',
 '{{ Name }}',
 '{{ ReplicateTo }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: deployment_strategy
    props:
      - name: DeploymentDurationInMinutes
        value: null
      - name: Description
        value: '{{ Description }}'
      - name: FinalBakeTimeInMinutes
        value: null
      - name: GrowthFactor
        value: null
      - name: GrowthType
        value: '{{ GrowthType }}'
      - name: Name
        value: '{{ Name }}'
      - name: ReplicateTo
        value: '{{ ReplicateTo }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.appconfig.deployment_strategies
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the deployment_strategies resource, the following permissions are required:

Create

appconfig:CreateDeploymentStrategy,
appconfig:TagResource

Read

appconfig:GetDeploymentStrategy,
appconfig:ListTagsForResource

Update

appconfig:UpdateDeploymentStrategy,
appconfig:TagResource,
appconfig:UntagResource

Delete

appconfig:DeleteDeploymentStrategy

List

appconfig:ListDeploymentStrategies