applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	aws.appconfig.applications

Fields

The following fields are returned by SELECT queries:

get_application

Name	Datatype	Description
description	string	The description of the application.
id	string	The application ID. (pattern: <code>[a-z0-9]{4,7}</code>)
name	string	The application name.

list_applications

Name	Datatype	Description
description	string	The description of the application.
id	string	The application ID. (pattern: <code>[a-z0-9]{4,7}</code>)
name	string	The application name.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application	select	application_id, region		Retrieves information about an application.
list_applications	select	region	max_results, next_token	Lists all applications in your Amazon Web Services account.
create_application	insert	region		Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.
update_application	update	application_id, region		Updates an application.
delete_application	delete	application_id, region		Deletes an application.
stop_deployment	exec	application_id, environment_id, deployment_number, region	Allow-Revert	Stops a deployment. This API action works only on deployments that have a status of DEPLOYING, unless an AllowRevert parameter is supplied. If the AllowRevert parameter is supplied, the status of an in-progress deployment will be ROLLED_BACK. The status of a completed deployment will be REVERTED. AppConfig only allows a revert within 72 hours of deployment completion.
start_deployment	exec	application_id, environment_id, region, DeploymentStrategyId, ConfigurationProfileId, ConfigurationVersion		Starts a deployment. AppConfig Agent supports deploying feature flag or free-form configuration data to specific segments or individual users during a gradual rollout. Entity-based gradual deployments ensure that once a user or segment receives a configuration version, they continue to receive that same version throughout the deployment period, regardless of which compute resource serves their requests. For more information, see Using AppConfig Agent for user-based or entity-based gradual deployments

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)
Allow-Revert	boolean	A Boolean that enables AppConfig to rollback a COMPLETED deployment to the previous configuration version. This action moves the deployment to a status of REVERTED.
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. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.

SELECT examples

get_application

Retrieves information about an application.

SELECT
description,
id,
name
FROM aws.appconfig.applications
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
;

list_applications

Lists all applications in your Amazon Web Services account.

SELECT
description,
id,
name
FROM aws.appconfig.applications
WHERE region = '{{ region }}' -- required
AND max_results = '{{ max_results }}'
AND next_token = '{{ next_token }}'
;

INSERT examples

create_application

Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.

INSERT INTO aws.appconfig.applications (
Name,
Description,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
description,
id,
name
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_application

Updates an application.

UPDATE aws.appconfig.applications
SET 
Name = '{{ Name }}',
Description = '{{ Description }}'
WHERE 
application_id = '{{ application_id }}' --required
AND region = '{{ region }}' --required
RETURNING
description,
id,
name;

DELETE examples

delete_application

Deletes an application.

DELETE FROM aws.appconfig.applications
WHERE application_id = '{{ application_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

stop_deployment

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING, unless an AllowRevert parameter is supplied. If the AllowRevert parameter is supplied, the status of an in-progress deployment will be ROLLED_BACK. The status of a completed deployment will be REVERTED. AppConfig only allows a revert within 72 hours of deployment completion.

EXEC aws.appconfig.applications.stop_deployment 
@application_id='{{ application_id }}' --required, 
@environment_id='{{ environment_id }}' --required, 
@deployment_number='{{ deployment_number }}' --required, 
@region='{{ region }}' --required, 
@Allow-Revert={{ Allow-Revert }}
;

start_deployment

Starts a deployment. AppConfig Agent supports deploying feature flag or free-form configuration data to specific segments or individual users during a gradual rollout. Entity-based gradual deployments ensure that once a user or segment receives a configuration version, they continue to receive that same version throughout the deployment period, regardless of which compute resource serves their requests. For more information, see Using AppConfig Agent for user-based or entity-based gradual deployments

EXEC aws.appconfig.applications.start_deployment 
@application_id='{{ application_id }}' --required, 
@environment_id='{{ environment_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"DeploymentStrategyId": "{{ DeploymentStrategyId }}", 
"ConfigurationProfileId": "{{ ConfigurationProfileId }}", 
"ConfigurationVersion": "{{ ConfigurationVersion }}", 
"Description": "{{ Description }}", 
"Tags": "{{ Tags }}", 
"KmsKeyIdentifier": "{{ KmsKeyIdentifier }}", 
"DynamicExtensionParameters": "{{ DynamicExtensionParameters }}", 
"LatestDeploymentNumber": {{ LatestDeploymentNumber }}
}'
;