applications
Creates, updates, deletes, gets or lists an applications resource.
Overview
| Name | applications |
| Type | Resource |
| Id | aws.codedeploy.applications |
Fields
The following fields are returned by SELECT queries:
- batch_get_applications
- get_application
- list_applications
| Name | Datatype | Description |
|---|---|---|
applications_info | array | Information about the applications. |
| Name | Datatype | Description |
|---|---|---|
application_id | string | The application ID. |
application_name | string | The application name. |
compute_platform | string | The destination platform type for deployment of the application (Lambda or Server). (Server, Lambda, ECS) |
create_time | string (date-time) | The time at which the application was created. |
git_hub_account_name | string | The name for a connection to a GitHub account. |
linked_to_git_hub | boolean | True if the user has authenticated with GitHub for the specified application. Otherwise, false. |
| Name | Datatype | Description |
|---|---|---|
application | string | A list of application names. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
batch_get_applications | select | region | Gets information about one or more applications. The maximum number of applications that can be returned is 100. | |
get_application | select | region | Gets information about an application. | |
list_applications | select | region | Lists the applications registered with the user or Amazon Web Services account. | |
create_application | insert | region, applicationName | Creates an application. | |
update_application | update | region | Changes the name of an application. | |
delete_application | delete | region | Deletes an application. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- batch_get_applications
- get_application
- list_applications
Gets information about one or more applications. The maximum number of applications that can be returned is 100.
SELECT
applications_info
FROM aws.codedeploy.applications
WHERE region = '{{ region }}' -- required
;
Gets information about an application.
SELECT
application_id,
application_name,
compute_platform,
create_time,
git_hub_account_name,
linked_to_git_hub
FROM aws.codedeploy.applications
WHERE region = '{{ region }}' -- required
;
Lists the applications registered with the user or Amazon Web Services account.
SELECT
application
FROM aws.codedeploy.applications
WHERE region = '{{ region }}' -- required
;
INSERT examples
- create_application
- Manifest
Creates an application.
INSERT INTO aws.codedeploy.applications (
applicationName,
computePlatform,
tags,
region
)
SELECT
'{{ applicationName }}' /* required */,
'{{ computePlatform }}',
'{{ tags }}',
'{{ region }}'
RETURNING
application_id
;
# Description fields are for documentation purposes
- name: applications
props:
- name: region
value: "{{ region }}"
description: Required parameter for the applications resource.
- name: applicationName
value: "{{ applicationName }}"
description: |
The name of the application. This name must be unique with the applicable user or Amazon Web Services account.
- name: computePlatform
value: "{{ computePlatform }}"
description: |
The destination platform type for the deployment (Lambda, Server, or ECS).
valid_values: ['Server', 'Lambda', 'ECS']
- name: tags
description: |
The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
value:
- Key: "{{ Key }}"
Value: "{{ Value }}"
UPDATE examples
- update_application
Changes the name of an application.
UPDATE aws.codedeploy.applications
SET
applicationName = '{{ applicationName }}',
newApplicationName = '{{ newApplicationName }}'
WHERE
region = '{{ region }}' --required;
DELETE examples
- delete_application
Deletes an application.
DELETE FROM aws.codedeploy.applications
WHERE region = '{{ region }}' --required
;