applications

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

Overview

Name	applications
Type	Resource
Id	aws.application_insights.applications

Fields

The following fields are returned by SELECT queries:

describe_application

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID for the owner of the application. (pattern: <code>^\d{12}$</code>)
attach_missing_permission	boolean	If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.
auto_config_enabled	boolean	Indicates whether auto-configuration is turned on for this application.
cwe_monitor_enabled	boolean	Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
discovery_type	string	The method used by Application Insights to onboard your resources. (RESOURCE_GROUP_BASED, ACCOUNT_BASED)
life_cycle	string	The lifecycle of the application.
ops_center_enabled	boolean	Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
ops_item_sns_topic_arn	string	The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates. (pattern: <code>^arn:aws(-\w+):[\w\d-]+:([\w\d-])?:[\w\d_-]([:/].+)$</code>)
remarks	string	The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include: “Configuring application, detected 1 Errors, 3 Warnings” “Configuring application, detected 1 Unconfigured Components”
resource_group_name	string	The name of the resource group used for the application. (pattern: <code>[a-zA-Z0-9.-_]*</code>)
sns_notification_arn	string	The SNS topic ARN that is associated with SNS notifications for updates or issues. (pattern: <code>^arn:aws(-\w+):[\w\d-]+:([\w\d-])?:[\w\d_-]([:/].+)$</code>)

list_applications

Name	Datatype	Description
application_info_list	array	The list of applications.
next_token	string	The token used to retrieve the next page of results. This value is null when there are no more results to return. (pattern: <code>.+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_application	select	region		Describes the application.
list_applications	select	region		Lists the IDs of the applications that you are monitoring.
create_application	insert	region		Adds an application that is created from a resource group.
update_application	update	region, ResourceGroupName		Updates the application.
delete_application	delete	region		Removes the specified application from monitoring. Does not delete the 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

describe_application

Describes the application.

SELECT
account_id,
attach_missing_permission,
auto_config_enabled,
cwe_monitor_enabled,
discovery_type,
life_cycle,
ops_center_enabled,
ops_item_sns_topic_arn,
remarks,
resource_group_name,
sns_notification_arn
FROM aws.application_insights.applications
WHERE region = '{{ region }}' -- required
;

list_applications

Lists the IDs of the applications that you are monitoring.

SELECT
application_info_list,
next_token
FROM aws.application_insights.applications
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_application

Adds an application that is created from a resource group.

INSERT INTO aws.application_insights.applications (
ResourceGroupName,
OpsCenterEnabled,
CWEMonitorEnabled,
OpsItemSNSTopicArn,
SNSNotificationArn,
Tags,
AutoConfigEnabled,
AutoCreate,
GroupingType,
AttachMissingPermission,
region
)
SELECT 
'{{ ResourceGroupName }}',
{{ OpsCenterEnabled }},
{{ CWEMonitorEnabled }},
'{{ OpsItemSNSTopicArn }}',
'{{ SNSNotificationArn }}',
'{{ Tags }}',
{{ AutoConfigEnabled }},
{{ AutoCreate }},
'{{ GroupingType }}',
{{ AttachMissingPermission }},
'{{ region }}'
RETURNING
application_info
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: ResourceGroupName
    value: "{{ ResourceGroupName }}"
    description: |
      The name of the resource group.
  - name: OpsCenterEnabled
    value: {{ OpsCenterEnabled }}
    description: |
      When set to true, creates opsItems for any problems detected on an application.
  - name: CWEMonitorEnabled
    value: {{ CWEMonitorEnabled }}
    description: |
      Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.
  - name: OpsItemSNSTopicArn
    value: "{{ OpsItemSNSTopicArn }}"
    description: |
      The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
  - name: SNSNotificationArn
    value: "{{ SNSNotificationArn }}"
    description: |
      The SNS notification topic ARN.
  - name: Tags
    description: |
      List of tags to add to the application. tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: AutoConfigEnabled
    value: {{ AutoConfigEnabled }}
    description: |
      Indicates whether Application Insights automatically configures unmonitored resources in the resource group.
  - name: AutoCreate
    value: {{ AutoCreate }}
    description: |
      Configures all of the resources in the resource group by applying the recommended configurations.
  - name: GroupingType
    value: "{{ GroupingType }}"
    description: |
      Application Insights can create applications based on a resource group or on an account. To create an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED.
    valid_values: ['ACCOUNT_BASED']
  - name: AttachMissingPermission
    value: {{ AttachMissingPermission }}
    description: |
      If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

UPDATE examples

update_application

Updates the application.

UPDATE aws.application_insights.applications
SET 
ResourceGroupName = '{{ ResourceGroupName }}',
OpsCenterEnabled = {{ OpsCenterEnabled }},
CWEMonitorEnabled = {{ CWEMonitorEnabled }},
OpsItemSNSTopicArn = '{{ OpsItemSNSTopicArn }}',
SNSNotificationArn = '{{ SNSNotificationArn }}',
RemoveSNSTopic = {{ RemoveSNSTopic }},
AutoConfigEnabled = {{ AutoConfigEnabled }},
AttachMissingPermission = {{ AttachMissingPermission }}
WHERE 
region = '{{ region }}' --required
AND ResourceGroupName = '{{ ResourceGroupName }}' --required
RETURNING
application_info;

DELETE examples

delete_application

Removes the specified application from monitoring. Does not delete the application.

DELETE FROM aws.application_insights.applications
WHERE region = '{{ region }}' --required
;