applications

Creates, updates, deletes or gets an application resource or lists applications in a region

Overview

Name	applications
Type	Resource
Description	Resource schema for AWS::ApplicationInsights::Application
Id	aws.applicationinsights.applications

Fields

Name	Datatype	Description
resource_group_name	string	The name of the resource group.
application_arn	string	The ARN of the ApplicationInsights application.
cwe_monitor_enabled	boolean	Indicates whether Application Insights can listen to CloudWatch events for the application resources.
ops_center_enabled	boolean	When set to true, creates opsItems for any problems detected on an application.
ops_item_sns_topic_arn	string	The SNS topic provided to Application Insights that is associated to the created opsItem.
sns_notification_arn	string	Application Insights sends notifications to this SNS topic whenever there is a problem update in the associated application.
tags	array	The tags of Application Insights application.
custom_components	array	The custom grouped components.
log_pattern_sets	array	The log pattern sets.
auto_configuration_enabled	boolean	If set to true, application will be configured with recommended monitoring configuration.
component_monitoring_settings	array	The monitoring settings of the components.
grouping_type	string	The grouping type of the application
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
region	string	AWS region.

For more information, see AWS::ApplicationInsights::Application.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ResourceGroupName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all applications in a region.

SELECT
region,
resource_group_name,
application_arn,
cwe_monitor_enabled,
ops_center_enabled,
ops_item_sns_topic_arn,
sns_notification_arn,
tags,
custom_components,
log_pattern_sets,
auto_configuration_enabled,
component_monitoring_settings,
grouping_type,
attach_missing_permission
FROM aws.applicationinsights.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
resource_group_name,
application_arn,
cwe_monitor_enabled,
ops_center_enabled,
ops_item_sns_topic_arn,
sns_notification_arn,
tags,
custom_components,
log_pattern_sets,
auto_configuration_enabled,
component_monitoring_settings,
grouping_type,
attach_missing_permission
FROM aws.applicationinsights.applications
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationARN>';

INSERT example

Use the following StackQL query and manifest file to create a new application resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.applicationinsights.applications (
 ResourceGroupName,
 region
)
SELECT 
'{{ ResourceGroupName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.applicationinsights.applications (
 ResourceGroupName,
 CWEMonitorEnabled,
 OpsCenterEnabled,
 OpsItemSNSTopicArn,
 SNSNotificationArn,
 Tags,
 CustomComponents,
 LogPatternSets,
 AutoConfigurationEnabled,
 ComponentMonitoringSettings,
 GroupingType,
 AttachMissingPermission,
 region
)
SELECT 
 '{{ ResourceGroupName }}',
 '{{ CWEMonitorEnabled }}',
 '{{ OpsCenterEnabled }}',
 '{{ OpsItemSNSTopicArn }}',
 '{{ SNSNotificationArn }}',
 '{{ Tags }}',
 '{{ CustomComponents }}',
 '{{ LogPatternSets }}',
 '{{ AutoConfigurationEnabled }}',
 '{{ ComponentMonitoringSettings }}',
 '{{ GroupingType }}',
 '{{ AttachMissingPermission }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: application
    props:
      - name: ResourceGroupName
        value: '{{ ResourceGroupName }}'
      - name: CWEMonitorEnabled
        value: '{{ CWEMonitorEnabled }}'
      - name: OpsCenterEnabled
        value: '{{ OpsCenterEnabled }}'
      - name: OpsItemSNSTopicArn
        value: '{{ OpsItemSNSTopicArn }}'
      - name: SNSNotificationArn
        value: '{{ SNSNotificationArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: CustomComponents
        value:
          - ComponentName: '{{ ComponentName }}'
            ResourceList:
              - '{{ ResourceList[0] }}'
      - name: LogPatternSets
        value:
          - PatternSetName: '{{ PatternSetName }}'
            LogPatterns:
              - PatternName: '{{ PatternName }}'
                Pattern: '{{ Pattern }}'
                Rank: '{{ Rank }}'
      - name: AutoConfigurationEnabled
        value: '{{ AutoConfigurationEnabled }}'
      - name: ComponentMonitoringSettings
        value:
          - ComponentName: '{{ ComponentName }}'
            ComponentARN: '{{ ComponentARN }}'
            Tier: '{{ Tier }}'
            ComponentConfigurationMode: '{{ ComponentConfigurationMode }}'
            DefaultOverwriteComponentConfiguration:
              ConfigurationDetails:
                AlarmMetrics:
                  - AlarmMetricName: '{{ AlarmMetricName }}'
                Logs:
                  - LogGroupName: '{{ LogGroupName }}'
                    LogPath: '{{ LogPath }}'
                    LogType: '{{ LogType }}'
                    Encoding: '{{ Encoding }}'
                    PatternSet: '{{ PatternSet }}'
                WindowsEvents:
                  - LogGroupName: '{{ LogGroupName }}'
                    EventName: '{{ EventName }}'
                    EventLevels:
                      - '{{ EventLevels[0] }}'
                    PatternSet: '{{ PatternSet }}'
                Processes:
                  - ProcessName: '{{ ProcessName }}'
                    AlarmMetrics:
                      - null
                Alarms:
                  - AlarmName: '{{ AlarmName }}'
                    Severity: '{{ Severity }}'
                JMXPrometheusExporter:
                  JMXURL: '{{ JMXURL }}'
                  HostPort: '{{ HostPort }}'
                  PrometheusPort: '{{ PrometheusPort }}'
                HANAPrometheusExporter:
                  HANASID: '{{ HANASID }}'
                  HANAPort: '{{ HANAPort }}'
                  HANASecretName: '{{ HANASecretName }}'
                  AgreeToInstallHANADBClient: '{{ AgreeToInstallHANADBClient }}'
                  PrometheusPort: '{{ PrometheusPort }}'
                HAClusterPrometheusExporter:
                  PrometheusPort: '{{ PrometheusPort }}'
                NetWeaverPrometheusExporter:
                  SAPSID: '{{ SAPSID }}'
                  InstanceNumbers:
                    - '{{ InstanceNumbers[0] }}'
                  PrometheusPort: '{{ PrometheusPort }}'
                SQLServerPrometheusExporter:
                  PrometheusPort: '{{ PrometheusPort }}'
                  SQLSecretName: '{{ SQLSecretName }}'
              SubComponentTypeConfigurations:
                - SubComponentType: '{{ SubComponentType }}'
                  SubComponentConfigurationDetails:
                    AlarmMetrics:
                      - null
                    Logs:
                      - null
                    WindowsEvents:
                      - null
                    Processes:
                      - null
            CustomComponentConfiguration: null
      - name: GroupingType
        value: '{{ GroupingType }}'
      - name: AttachMissingPermission
        value: '{{ AttachMissingPermission }}'

DELETE example

/*+ delete */
DELETE FROM aws.applicationinsights.applications
WHERE data__Identifier = '<ApplicationARN>'
AND region = 'us-east-1';

Permissions

To operate on the applications resource, the following permissions are required:

Create

applicationinsights:CreateApplication,
applicationinsights:DescribeApplication,
applicationinsights:CreateComponent,
applicationinsights:DescribeComponent,
applicationinsights:CreateLogPattern,
applicationinsights:DescribeLogPattern,
applicationinsights:DescribeComponentConfigurationRecommendation,
applicationinsights:UpdateComponentConfiguration,
applicationinsights:ListComponents,
applicationinsights:TagResource,
ec2:DescribeInstances,
ec2:DescribeVolumes,
rds:DescribeDBInstances,
rds:DescribeDBClusters,
sqs:ListQueues,
elasticloadbalancing:DescribeLoadBalancers,
elasticloadbalancing:DescribeTargetGroups,
elasticloadbalancing:DescribeTargetHealth,
autoscaling:DescribeAutoScalingGroups,
lambda:ListFunctions,
dynamodb:ListTables,
s3:ListAllMyBuckets,
sns:ListTopics,
states:ListStateMachines,
apigateway:GET,
ecs:ListClusters,
ecs:DescribeTaskDefinition,
ecs:ListServices,
ecs:ListTasks,
eks:ListClusters,
eks:ListNodegroups,
fsx:DescribeFileSystems,
logs:DescribeLogGroups,
elasticfilesystem:DescribeFileSystems

Read

applicationinsights:DescribeApplication,
applicationinsights:ListTagsForResource,
applicationinsights:DescribeComponent,
applicationinsights:ListComponents,
applicationinsights:DescribeLogPattern,
applicationinsights:ListLogPatterns,
applicationinsights:ListLogPatternSets

Update

applicationinsights:CreateApplication,
applicationinsights:DescribeApplication,
applicationinsights:UpdateApplication,
applicationinsights:TagResource,
applicationinsights:UntagResource,
applicationinsights:ListTagsForResource,
applicationinsights:CreateComponent,
applicationinsights:DescribeComponent,
applicationinsights:DeleteComponent,
applicationinsights:ListComponents,
applicationinsights:CreateLogPattern,
applicationinsights:DeleteLogPattern,
applicationinsights:DescribeLogPattern,
applicationinsights:ListLogPatterns,
applicationinsights:ListLogPatternSets,
applicationinsights:UpdateLogPattern,
applicationinsights:DescribeComponentConfiguration,
applicationinsights:DescribeComponentConfigurationRecommendation,
applicationinsights:UpdateComponentConfiguration

Delete

applicationinsights:DeleteApplication,
applicationinsights:DescribeApplication

List

applicationinsights:ListApplications,
applicationinsights:DescribeApplication,
applicationinsights:ListTagsForResource,
applicationinsights:DescribeComponent,
applicationinsights:ListComponents,
applicationinsights:DescribeLogPattern,
applicationinsights:ListLogPatterns,
applicationinsights:ListLogPatternSets