deployments

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

Overview

Name	deployments
Type	Resource
Id	aws.appconfig.deployments

Fields

The following fields are returned by SELECT queries:

get_deployment

Name	Datatype	Description
application_id	string	The ID of the application that was deployed. (pattern: <code>[a-z0-9]{4,7}</code>)
applied_extensions	array	A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.
completed_at	string (date-time)	The time the deployment completed.
configuration_location_uri	string	Information about the source location of the configuration.
configuration_name	string	The name of the configuration.
configuration_profile_id	string	The ID of the configuration profile that was deployed. (pattern: <code>[a-z0-9]{4,7}</code>)
configuration_version	string	The configuration version that was deployed.
deployment_duration_in_minutes	integer	Total amount of time the deployment lasted.
deployment_number	integer	The sequence number of the deployment.
deployment_strategy_id	string	The ID of the deployment strategy that was deployed. (pattern: <code>[a-z0-9]{4,7}</code>)
description	string	The description of the deployment.
environment_id	string	The ID of the environment that was deployed. (pattern: <code>[a-z0-9]{4,7}</code>)
event_log	array	A list containing all events related to a deployment. The most recent events are displayed first.
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 to receive a deployed configuration during each interval.
growth_type	string	The algorithm used to define how percentage grew over time. (LINEAR, EXPONENTIAL)
kms_key_arn	string	The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store. (pattern: <code>arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+</code>)
kms_key_identifier	string	The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
percentage_complete	number (float)	The percentage of targets for which the deployment is available.
started_at	string (date-time)	The time the deployment started.
state	string	The state of the deployment. (BAKING, VALIDATING, DEPLOYING, COMPLETE, ROLLING_BACK, ROLLED_BACK, REVERTED)
version_label	string	A user-defined label for an AppConfig hosted configuration version. (pattern: <code>.[^0-9].</code>)

list_deployments

Name	Datatype	Description
completed_at	string (date-time)	Time the deployment completed.
configuration_name	string	The name of the configuration.
configuration_profile_id	string	The ID of the configuration profile that was deployed. (pattern: <code>[a-z0-9]{4,7}</code>)
configuration_version	string	The version of the configuration.
deployment_duration_in_minutes	integer	Total amount of time the deployment lasted.
deployment_number	integer	The sequence number of the deployment.
final_bake_time_in_minutes	integer	The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
growth_factor	number (float)	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. (LINEAR, EXPONENTIAL)
percentage_complete	number (float)	The percentage of targets for which the deployment is available.
started_at	string (date-time)	Time the deployment started.
state	string	The state of the deployment. (BAKING, VALIDATING, DEPLOYING, COMPLETE, ROLLING_BACK, ROLLED_BACK, REVERTED)
type	string	The type of deployment. (USER, MANAGED)
version_label	string	A user-defined label for an AppConfig hosted configuration version. (pattern: <code>.[^0-9].</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment	select	application_id, environment_id, deployment_number, region		Retrieves information about a configuration deployment.
list_deployments	select	application_id, environment_id, region	max_results, next_token	Lists the deployments for an environment in descending deployment number order.

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
application_id	string	The application ID.
deployment_number	integer	The sequence number of the deployment.
environment_id	string	The environment ID.
region	string	AWS region (default: us-east-1)
max_results	integer	The maximum number of items that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null NextToken that you can provide in a subsequent call to get the next set of results.
next_token	string	The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first set of results.

SELECT examples

get_deployment

Retrieves information about a configuration deployment.

SELECT
application_id,
applied_extensions,
completed_at,
configuration_location_uri,
configuration_name,
configuration_profile_id,
configuration_version,
deployment_duration_in_minutes,
deployment_number,
deployment_strategy_id,
description,
environment_id,
event_log,
final_bake_time_in_minutes,
growth_factor,
growth_type,
kms_key_arn,
kms_key_identifier,
percentage_complete,
started_at,
state,
version_label
FROM aws.appconfig.deployments
WHERE application_id = '{{ application_id }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND deployment_number = '{{ deployment_number }}' -- required
AND region = '{{ region }}' -- required
;

list_deployments

Lists the deployments for an environment in descending deployment number order.

SELECT
completed_at,
configuration_name,
configuration_profile_id,
configuration_version,
deployment_duration_in_minutes,
deployment_number,
final_bake_time_in_minutes,
growth_factor,
growth_type,
percentage_complete,
started_at,
state,
type,
version_label
FROM aws.appconfig.deployments
WHERE application_id = '{{ application_id }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
;