deployment_strategies

Creates, updates, deletes, gets or lists a deployment_strategies resource.

Overview

Name	deployment_strategies
Type	Resource
Id	aws.appconfig.deployment_strategies

Fields

The following fields are returned by SELECT queries:

get_deployment_strategy

Name	Datatype	Description
deployment_duration_in_minutes	integer	Total amount of time the deployment lasted.
description	string	The description of the deployment strategy.
final_bake_time_in_minutes	integer	The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
growth_factor	number (float)	The percentage of targets that received a deployed configuration during each interval.
growth_type	string	The algorithm used to define how percentage grew over time. (LINEAR, EXPONENTIAL)
id	string	The deployment strategy ID. (pattern: <code>[a-z0-9]{4,7}</code>)
name	string	The name of the deployment strategy.
replicate_to	string	Save the deployment strategy to a Systems Manager (SSM) document. (NONE, SSM_DOCUMENT)

list_deployment_strategies

Name	Datatype	Description
deployment_duration_in_minutes	integer	Total amount of time the deployment lasted.
description	string	The description of the deployment strategy.
final_bake_time_in_minutes	integer	The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
growth_factor	number (float)	The percentage of targets that received a deployed configuration during each interval.
growth_type	string	The algorithm used to define how percentage grew over time. (LINEAR, EXPONENTIAL)
id	string	The deployment strategy ID. (pattern: <code>[a-z0-9]{4,7}</code>)
name	string	The name of the deployment strategy.
replicate_to	string	Save the deployment strategy to a Systems Manager (SSM) document. (NONE, SSM_DOCUMENT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment_strategy	select	deployment_strategy_id, region		Retrieves information about a deployment strategy. 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.
list_deployment_strategies	select	region	max_results, next_token	Lists deployment strategies.
create_deployment_strategy	insert	region, DeploymentDurationInMinutes, GrowthFactor		Creates a deployment strategy that 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.
update_deployment_strategy	update	deployment_strategy_id, region		Updates a deployment strategy.
delete_deployment_strategy	delete	deployment_strategy_id, region		Deletes a deployment strategy.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_strategy_id	string	The ID of the deployment strategy you want to delete.
region	string	AWS region (default: us-east-1)
max_results	integer	The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token	string	A token to start the list. Use this token to get the next set of results.

SELECT examples

get_deployment_strategy

Retrieves information about a deployment strategy. 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.

SELECT
deployment_duration_in_minutes,
description,
final_bake_time_in_minutes,
growth_factor,
growth_type,
id,
name,
replicate_to
FROM aws.appconfig.deployment_strategies
WHERE deployment_strategy_id = '{{ deployment_strategy_id }}' -- required
AND region = '{{ region }}' -- required
;

list_deployment_strategies

Lists deployment strategies.

SELECT
deployment_duration_in_minutes,
description,
final_bake_time_in_minutes,
growth_factor,
growth_type,
id,
name,
replicate_to
FROM aws.appconfig.deployment_strategies
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
;

INSERT examples

create_deployment_strategy

Creates a deployment strategy that 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.

INSERT INTO aws.appconfig.deployment_strategies (
Name,
Description,
DeploymentDurationInMinutes,
FinalBakeTimeInMinutes,
GrowthFactor,
GrowthType,
ReplicateTo,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
{{ DeploymentDurationInMinutes }} /* required */,
{{ FinalBakeTimeInMinutes }},
{{ GrowthFactor }} /* required */,
'{{ GrowthType }}',
'{{ ReplicateTo }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
deployment_duration_in_minutes,
description,
final_bake_time_in_minutes,
growth_factor,
growth_type,
id,
name,
replicate_to
;

Manifest

# Description fields are for documentation purposes
- name: deployment_strategies
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the deployment_strategies resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: DeploymentDurationInMinutes
    value: {{ DeploymentDurationInMinutes }}
  - name: FinalBakeTimeInMinutes
    value: {{ FinalBakeTimeInMinutes }}
  - name: GrowthFactor
    value: {{ GrowthFactor }}
  - name: GrowthType
    value: "{{ GrowthType }}"
    valid_values: ['LINEAR', 'EXPONENTIAL']
  - name: ReplicateTo
    value: "{{ ReplicateTo }}"
    valid_values: ['NONE', 'SSM_DOCUMENT']
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_deployment_strategy

Updates a deployment strategy.

UPDATE aws.appconfig.deployment_strategies
SET 
Description = '{{ Description }}',
DeploymentDurationInMinutes = {{ DeploymentDurationInMinutes }},
FinalBakeTimeInMinutes = {{ FinalBakeTimeInMinutes }},
GrowthFactor = {{ GrowthFactor }},
GrowthType = '{{ GrowthType }}'
WHERE 
deployment_strategy_id = '{{ deployment_strategy_id }}' --required
AND region = '{{ region }}' --required
RETURNING
deployment_duration_in_minutes,
description,
final_bake_time_in_minutes,
growth_factor,
growth_type,
id,
name,
replicate_to;

DELETE examples

delete_deployment_strategy

Deletes a deployment strategy.

DELETE FROM aws.appconfig.deployment_strategies
WHERE deployment_strategy_id = '{{ deployment_strategy_id }}' --required
AND region = '{{ region }}' --required
;