This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # Amazon CloudWatch Application Insights **Resource types** + [AWS::ApplicationInsights::Application](aws-resource-applicationinsights-application.md) # AWS::ApplicationInsights::Application The `AWS::ApplicationInsights::Application` resource adds an application that is created from a resource group. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::ApplicationInsights::Application", "Properties" : { "[AttachMissingPermission](#cfn-applicationinsights-application-attachmissingpermission)" : Boolean, "[AutoConfigurationEnabled](#cfn-applicationinsights-application-autoconfigurationenabled)" : Boolean, "[ComponentMonitoringSettings](#cfn-applicationinsights-application-componentmonitoringsettings)" : [ ComponentMonitoringSetting, ... ], "[CustomComponents](#cfn-applicationinsights-application-customcomponents)" : [ CustomComponent, ... ], "[CWEMonitorEnabled](#cfn-applicationinsights-application-cwemonitorenabled)" : Boolean, "[GroupingType](#cfn-applicationinsights-application-groupingtype)" : String, "[LogPatternSets](#cfn-applicationinsights-application-logpatternsets)" : [ LogPatternSet, ... ], "[OpsCenterEnabled](#cfn-applicationinsights-application-opscenterenabled)" : Boolean, "[OpsItemSNSTopicArn](#cfn-applicationinsights-application-opsitemsnstopicarn)" : String, "[ResourceGroupName](#cfn-applicationinsights-application-resourcegroupname)" : String, "[SNSNotificationArn](#cfn-applicationinsights-application-snsnotificationarn)" : String, "[Tags](#cfn-applicationinsights-application-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::ApplicationInsights::Application Properties: [AttachMissingPermission](#cfn-applicationinsights-application-attachmissingpermission): Boolean [AutoConfigurationEnabled](#cfn-applicationinsights-application-autoconfigurationenabled): Boolean [ComponentMonitoringSettings](#cfn-applicationinsights-application-componentmonitoringsettings): - ComponentMonitoringSetting [CustomComponents](#cfn-applicationinsights-application-customcomponents): - CustomComponent [CWEMonitorEnabled](#cfn-applicationinsights-application-cwemonitorenabled): Boolean [GroupingType](#cfn-applicationinsights-application-groupingtype): String [LogPatternSets](#cfn-applicationinsights-application-logpatternsets): - LogPatternSet [OpsCenterEnabled](#cfn-applicationinsights-application-opscenterenabled): Boolean [OpsItemSNSTopicArn](#cfn-applicationinsights-application-opsitemsnstopicarn): String [ResourceGroupName](#cfn-applicationinsights-application-resourcegroupname): String [SNSNotificationArn](#cfn-applicationinsights-application-snsnotificationarn): String [Tags](#cfn-applicationinsights-application-tags): - Tag ``` ## Properties `AttachMissingPermission` If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AutoConfigurationEnabled` If set to `true`, the application components will be configured with the monitoring configuration recommended by Application Insights. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ComponentMonitoringSettings` The monitoring settings of the components. Not required to set up default monitoring for all components. To set up default monitoring for all components, set `AutoConfigurationEnabled` to `true`. *Required*: No *Type*: Array of [ComponentMonitoringSetting](aws-properties-applicationinsights-application-componentmonitoringsetting.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomComponents` Describes a custom component by grouping similar standalone instances to monitor. *Required*: No *Type*: Array of [CustomComponent](aws-properties-applicationinsights-application-customcomponent.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CWEMonitorEnabled` Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as `instance terminated`, `failed deployment`, and others. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GroupingType` 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`. *Required*: No *Type*: String *Allowed values*: `ACCOUNT_BASED` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `LogPatternSets` The log pattern sets. *Required*: No *Type*: Array of [LogPatternSet](aws-properties-applicationinsights-application-logpatternset.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OpsCenterEnabled` Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OpsItemSNSTopicArn` The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates. *Required*: No *Type*: String *Pattern*: `^arn:aws(-[\w]+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$` *Minimum*: `20` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResourceGroupName` The name of the resource group used for the application. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9.-_]*` *Minimum*: `1` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SNSNotificationArn` The SNS topic ARN that is associated with SNS notifications for updates or issues. *Required*: No *Type*: String *Pattern*: `^arn:aws(-[\w]+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$` *Minimum*: `20` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` An array of `Tags`. *Required*: No *Type*: Array of [Tag](aws-properties-applicationinsights-application-tag.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Name (ARN) of the application, such as `arn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `ApplicationARN` Returns the Amazon Resource Name (ARN) of the application, such as ` arn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group`. ## Examples **Topics** + [The following example template creates an Application Insights application with all components configured with recommended monitoring settings](#aws-resource-applicationinsights-application--examples--The_following_example_template_creates_an_Application_Insights_application_with_all_components_configured_with_recommended_monitoring_settings) + [The following example template creates an Application Insights application that includes all of the components in the account](#aws-resource-applicationinsights-application--examples--The_following_example_template_creates_an_Application_Insights_application_that_includes_all_of_the_components_in_the_account) + [The following example template creates an Application Insights application with detailed settings](#aws-resource-applicationinsights-application--examples--The_following_example_template_creates_an_Application_Insights_application_with_detailed_settings) + [The following example template creates an Application Insights application with CUSTOM mode component configuration](#aws-resource-applicationinsights-application--examples--The_following_example_template_creates_an_Application_Insights_application_with_CUSTOM_mode_component_configuration) + [The following example template creates an Application Insights application with DEFAULT mode component configuration](#aws-resource-applicationinsights-application--examples--The_following_example_template_creates_an_Application_Insights_application_with_DEFAULT_mode_component_configuration) + [The following example template creates an Application Insights application with DEFAULT\$1WITH\$1OVERWRITE mode component configuration](#aws-resource-applicationinsights-application--examples--The_following_example_template_creates_an_Application_Insights_application_with_DEFAULT_WITH_OVERWRITE_mode_component_configuration) ### The following example template creates an Application Insights application with all components configured with recommended monitoring settings The following example template performs the following actions: + Creates an Application Insights application. For more information, see [CreateApplication](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_CreateApplication.html) in the *Amazon CloudWatch Application Insights API Reference*. + Sets `AutoConfigurationEnabled` to `true`, which configures all components of the application with the recommended monitoring settings for the `DEFAULT` tier. For more information, see [DescribeComponentConfigurationRecommendation](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_DescribeComponentConfigurationRecommendation.html) in the *Amazon CloudWatch Application Insights API Reference*. #### YAML ``` --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group AutoConfigurationEnabled: true ``` #### JSON ``` { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", "AutoConfigurationEnabled": true } } ``` ### The following example template creates an Application Insights application that includes all of the components in the account The following example template performs the following actions: + Creates an Application Insights application. For more information, see [CreateApplication](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_CreateApplication.html) in the *Amazon CloudWatch Application Insights API Reference*. + Sets `GroupingType` to `ACCOUNT_BASED`, which creates an account level-based application that includes all of the supported resources in the account. + Sets `AutoConfigurationEnabled` to `true`, which configures all components of the application with the recommended monitoring settings for the `DEFAULT` tier. For more information, see [DescribeComponentConfigurationRecommendation](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_DescribeComponentConfigurationRecommendation.html) in the *Amazon CloudWatch Application Insights API Reference*. + You can specify any name for the `ResourceGroupName`. #### YAML ``` --- Type: AWS::ApplicationInsights::Application Properties: AutoConfigurationEnabled: true GroupingType: ACCOUNT_BASED ResourceGroupName: my_resource_group ``` #### JSON ``` { "Type": "AWS::ApplicationInsights::Application", "Properties": { "AutoConfigurationEnabled": true, "GroupingType": ACCOUNT_BASED, "ResourceGroupName": "my_resource_group" } } ``` ### The following example template creates an Application Insights application with detailed settings The following example template performs the following actions: + Creates an Application Insights application with CloudWatch Events notification and OpsCenter enabled. For more information, see [CreateApplication](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_CreateApplication.html) in the *Amazon CloudWatch Application Insights API Reference*. + Tags the application with two tags, one of which has no tag values. For more information, see [TagResource](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_TagResource.html) in the *Amazon CloudWatch Application Insights API Reference*. + Creates two custom instance group components. For more information, see [CreateComponent](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_CreateComponent.html) in the *Amazon CloudWatch Application Insights API Reference*. + Creates two log pattern sets. For more information, see [CreateLogPattern](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_CreateLogPattern.html) in the *Amazon CloudWatch Application Insights API Reference*. + Sets `AutoConfigurationEnabled` to `true`, which configures all components of the application with the recommended monitoring settings for the `DEFAULT` tier. For more information, see [DescribeComponentConfigurationRecommendation](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_DescribeComponentConfigurationRecommendation.html) in the *Amazon CloudWatch Application Insights API Reference*. #### YAML ``` --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group CWEMonitorEnabled: true OpsCenterEnabled: true OpsItemSNSTopicArn: arn:aws:sns:us-east-1:123456789012:my_topic AutoConfigurationEnabled: true Tags: - Key: key1 Value: value1 - Key: key2 Value: '' CustomComponents: - ComponentName: test_component_1 ResourceList: - arn:aws:ec2:us-east-1:123456789012:instance/i-XXXXX - ComponentName: test_component_2 ResourceList: - arn:aws:ec2:us-east-1:123456789012:instance/i-YYYYY - arn:aws:ec2:us-east-1:123456789012:instance/i-ZZZZZ LogPatternSets: - PatternSetName: pattern_set_1 LogPatterns: - PatternName: deadlock_pattern Pattern: ".*\\sDeadlocked\\sSchedulers(([^\\w].*)|($))" Rank: 1 - PatternSetName: pattern_set_2 LogPatterns: - PatternName: error_pattern Pattern: ".*[\\s\\[]ERROR[\\s\\]].*" Rank: 1 - PatternName: warning_pattern Pattern: ".*[\\s\\[]WARN(ING)?[\\s\\]].*" Rank: 10 ``` #### JSON ``` { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", "CWEMonitorEnabled": true, "OpsCenterEnabled": true, "OpsItemSNSTopicArn": "arn:aws:sns:us-east-1:123456789012:my_topic", "AutoConfigurationEnabled": true, "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "" } ], "CustomComponents": [ { "ComponentName": "test_component_1", "ResourceList": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-XXXXX" ] }, { "ComponentName": "test_component_2", "ResourceList": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-YYYYY", "arn:aws:ec2:us-east-1:123456789012:instance/i-ZZZZZ" ] } ], "LogPatternSets": [ { "PatternSetName": "pattern_set_1", "LogPatterns": [ { "PatternName": "deadlock_pattern", "Pattern": ".*\\sDeadlocked\\sSchedulers(([^\\w].*)|($))", "Rank": 1 } ] }, { "PatternSetName": "pattern_set_2", "LogPatterns": [ { "PatternName": "error_pattern", "Pattern": ".*[\\s\\[]ERROR[\\s\\]].*", "Rank": 1 }, { "PatternName": "warning_pattern", "Pattern": ".*[\\s\\[]WARN(ING)?[\\s\\]].*", "Rank": 10 } ] } ] } } ``` ### The following example template creates an Application Insights application with CUSTOM mode component configuration The following example template performs the following actions: + Creates an Application Insights application. For more information, see [CreateApplication](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_CreateApplication.html) in the *Amazon CloudWatch Application Insights API Reference*. + Component `my_component` sets `ComponentConfigurationMode` to `CUSTOM`, which causes this component to be configured as specified in `CustomComponentConfiguration`. For more information, see [UpdateComponentConfiguration](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_UpdateComponentConfiguration.html) in the *Amazon CloudWatch Application Insights API Reference*. #### YAML ``` --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group ComponentMonitoringSettings: - ComponentARN: my_component Tier: SQL_SERVER ComponentConfigurationMode: CUSTOM CustomComponentConfiguration: ConfigurationDetails: AlarmMetrics: - AlarmMetricName: StatusCheckFailed ... Logs: - LogGroupName: my_log_group_1 LogPath: C:\LogFolder_1\* LogType: DOT_NET_CORE Encoding: utf-8 PatternSet: my_pattern_set_1 ... WindowsEvents: - LogGroupName: my_windows_event_log_group_1 EventName: Application EventLevels: - ERROR - WARNING ... Encoding: utf-8 PatternSet: my_pattern_set_2 ... Alarms: - AlarmName: my_alarm_name Severity: HIGH ... SubComponentTypeConfigurations: - SubComponentType: EC2_INSTANCE SubComponentConfigurationDetails: AlarmMetrics: - AlarmMetricName: DiskReadOps ... Logs: - LogGroupName: my_log_group_2 LogPath: C:\LogFolder_2\* LogType: IIS Encoding: utf-8 PatternSet: my_pattern_set_3 ... WindowsEvents: - LogGroupName: my_windows_event_log_group_2 EventName: Application EventLevels: - ERROR - WARNING ... Encoding: utf-8 PatternSet: my_pattern_set_4 ... ``` #### JSON ``` { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", "ComponentMonitoringSettings": [ { "ComponentARN": "my_component", "Tier": "SQL_SERVER", "ComponentConfigurationMode": "CUSTOM", "CustomComponentConfiguration": { "ConfigurationDetails": { "AlarmMetrics": [ { "AlarmMetricName": "StatusCheckFailed" }, ... ], "Logs": [ { "LogGroupName": "my_log_group_1", "LogPath": "C:\\LogFolder_1\\*", "LogType": "DOT_NET_CORE", "Encoding": "utf-8", "PatternSet": "my_pattern_set_1" }, ... ], "WindowsEvents": [ { "LogGroupName": "my_windows_event_log_group_1", "EventName": "Application", "EventLevels": [ "ERROR", "WARNING", ... ], "Encoding": "utf-8", "PatternSet": "my_pattern_set_2" }, ... ], "Alarms": [ { "AlarmName": "my_alarm_name", "Severity": "HIGH" }, ... ] }, "SubComponentTypeConfigurations": [ { "SubComponentType": "EC2_INSTANCE", "SubComponentConfigurationDetails": { "AlarmMetrics": [ { "AlarmMetricName": "DiskReadOps" }, ... ], "Logs": [ { "LogGroupName": "my_log_group_2", "LogPath": "C:\\LogFolder_2\\*", "LogType": "IIS", "Encoding": "utf-8", "PatternSet": "my_pattern_set_3" }, ... ], "WindowsEvents": [ { "LogGroupName": "my_windows_event_log_group_2", "EventName": "Application", "EventLevels": [ "ERROR", "WARNING", ... ], "Encoding": "utf-8", "PatternSet": "my_pattern_set_4" }, ... ] } } ] } } ] } } ``` ### The following example template creates an Application Insights application with DEFAULT mode component configuration The following example template performs the following actions: + Creates an Application Insights application. For more information, see [CreateApplication](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_CreateApplication.html) in the *Amazon CloudWatch Application Insights API Reference*. + Component `my_component` sets `ComponentConfigurationMode` to `DEFAULT` and `Tier` to `SQL_SERVER`, which causes this component to be configured with the configuration settings that Application Insights recommends for the `SQL_Server` tier. For more information, see [DescribeComponentConfiguration](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_DescribeComponentConfiguration.html) and [UpdateComponentConfiguration](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_UpdateComponentConfiguration.html) in the *Amazon CloudWatch Application Insights API Reference*. #### YAML ``` --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group ComponentMonitoringSettings: - ComponentARN: my_component Tier: SQL_SERVER ComponentConfigurationMode: DEFAULT ``` #### JSON ``` { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", "ComponentMonitoringSettings": [ { "ComponentARN": "my_component", "Tier": "SQL_SERVER", "ComponentConfigurationMode": "DEFAULT" } ] } } ``` ### The following example template creates an Application Insights application with DEFAULT\$1WITH\$1OVERWRITE mode component configuration The following example template performs the following actions: + Creates an Application Insights application. For more information, see [CreateApplication](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_CreateApplication.html) in the *Amazon CloudWatch Application Insights API Reference*. + Component `my_component` sets `ComponentConfigurationMode` to `DEFAULT_WITH_OVERWRITE` and `tier` to `DOT_NET_CORE`, which causes this component to be configured with the configuration settings that Application Insights recommends for the `DOT_NET_CORE` tier. Overwritten configuration settings are specified in the `DefaultOverwriteComponentConfiguration`: + At the component level, `AlarmMetrics` settings are overwritten. + At the sub-component level, for the `EC2_Instance` type sub-components, `Logs` settings are overwritten. For more information, see [UpdateComponentConfiguration](https://docs.aws.amazon.com/cloudwatch/latest/APIReference/API_UpdateComponentConfiguration.html) in the *Amazon CloudWatch Application Insights API Reference*. #### YAML ``` --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group ComponentMonitoringSettings: - ComponentName: my_component Tier: DOT_NET_CORE ComponentConfigurationMode: DEFAULT_WITH_OVERWRITE DefaultOverwriteComponentConfiguration: ConfigurationDetails: AlarmMetrics: - AlarmMetricName: StatusCheckFailed SubComponentTypeConfigurations: - SubComponentType: EC2_INSTANCE SubComponentConfigurationDetails: Logs: - LogGroupName: my_log_group LogPath: C:\LogFolder\* LogType: IIS Encoding: utf-8 PatternSet: my_pattern_set ``` #### JSON ``` { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", "ComponentMonitoringSettings": [ { "ComponentName": "my_component", "Tier": "DOT_NET_CORE", "ComponentConfigurationMode": "DEFAULT_WITH_OVERWRITE", "DefaultOverwriteComponentConfiguration": { "ConfigurationDetails": { "AlarmMetrics": [ { "AlarmMetricName": "StatusCheckFailed" } ] }, "SubComponentTypeConfigurations": [ { "SubComponentType": "EC2_INSTANCE", "SubComponentConfigurationDetails": { "Logs": [ { "LogGroupName": "my_log_group", "LogPath": "C:\\LogFolder\\*", "LogType": "IIS", "Encoding": "utf-8", "PatternSet": "my_pattern_set" } ] } } ] } } ] } } ``` # AWS::ApplicationInsights::Application Alarm The `AWS::ApplicationInsights::Application Alarm` property type defines a CloudWatch alarm to be monitored for the component. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AlarmName](#cfn-applicationinsights-application-alarm-alarmname)" : String, "[Severity](#cfn-applicationinsights-application-alarm-severity)" : String } ``` ### YAML ``` [AlarmName](#cfn-applicationinsights-application-alarm-alarmname): String [Severity](#cfn-applicationinsights-application-alarm-severity): String ``` ## Properties `AlarmName` The name of the CloudWatch alarm to be monitored for the component. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Severity` Indicates the degree of outage when the alarm goes off. *Required*: No *Type*: String *Allowed values*: `HIGH | MEDIUM | LOW` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application AlarmMetric The `AWS::ApplicationInsights::Application AlarmMetric` property type defines a metric to monitor for the component. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AlarmMetricName](#cfn-applicationinsights-application-alarmmetric-alarmmetricname)" : String } ``` ### YAML ``` [AlarmMetricName](#cfn-applicationinsights-application-alarmmetric-alarmmetricname): String ``` ## Properties `AlarmMetricName` The name of the metric to be monitored for the component. For metrics supported by Application Insights, see [Logs and metrics supported by Amazon CloudWatch Application Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/appinsights-logs-and-metrics.html). *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application ComponentConfiguration The `AWS::ApplicationInsights::Application ComponentConfiguration` property type defines the configuration settings of the component. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConfigurationDetails](#cfn-applicationinsights-application-componentconfiguration-configurationdetails)" : ConfigurationDetails, "[SubComponentTypeConfigurations](#cfn-applicationinsights-application-componentconfiguration-subcomponenttypeconfigurations)" : [ SubComponentTypeConfiguration, ... ] } ``` ### YAML ``` [ConfigurationDetails](#cfn-applicationinsights-application-componentconfiguration-configurationdetails): ConfigurationDetails [SubComponentTypeConfigurations](#cfn-applicationinsights-application-componentconfiguration-subcomponenttypeconfigurations): - SubComponentTypeConfiguration ``` ## Properties `ConfigurationDetails` The configuration settings. *Required*: No *Type*: [ConfigurationDetails](aws-properties-applicationinsights-application-configurationdetails.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubComponentTypeConfigurations` Sub-component configurations of the component. *Required*: No *Type*: Array of [SubComponentTypeConfiguration](aws-properties-applicationinsights-application-subcomponenttypeconfiguration.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application ComponentMonitoringSetting The `AWS::ApplicationInsights::Application ComponentMonitoringSetting` property type defines the monitoring setting of the component. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ComponentARN](#cfn-applicationinsights-application-componentmonitoringsetting-componentarn)" : String, "[ComponentConfigurationMode](#cfn-applicationinsights-application-componentmonitoringsetting-componentconfigurationmode)" : String, "[ComponentName](#cfn-applicationinsights-application-componentmonitoringsetting-componentname)" : String, "[CustomComponentConfiguration](#cfn-applicationinsights-application-componentmonitoringsetting-customcomponentconfiguration)" : ComponentConfiguration, "[DefaultOverwriteComponentConfiguration](#cfn-applicationinsights-application-componentmonitoringsetting-defaultoverwritecomponentconfiguration)" : ComponentConfiguration, "[Tier](#cfn-applicationinsights-application-componentmonitoringsetting-tier)" : String } ``` ### YAML ``` [ComponentARN](#cfn-applicationinsights-application-componentmonitoringsetting-componentarn): String [ComponentConfigurationMode](#cfn-applicationinsights-application-componentmonitoringsetting-componentconfigurationmode): String [ComponentName](#cfn-applicationinsights-application-componentmonitoringsetting-componentname): String [CustomComponentConfiguration](#cfn-applicationinsights-application-componentmonitoringsetting-customcomponentconfiguration): ComponentConfiguration [DefaultOverwriteComponentConfiguration](#cfn-applicationinsights-application-componentmonitoringsetting-defaultoverwritecomponentconfiguration): ComponentConfiguration [Tier](#cfn-applicationinsights-application-componentmonitoringsetting-tier): String ``` ## Properties `ComponentARN` The ARN of the component. Either the component ARN or the component name is required. *Required*: No *Type*: String *Pattern*: `^arn:aws(-[\w]+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$` *Minimum*: `20` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ComponentConfigurationMode` Component monitoring can be configured in one of the following three modes: + `DEFAULT`: The component will be configured with the recommended default monitoring settings of the selected `Tier`. + `CUSTOM`: The component will be configured with the customized monitoring settings that are specified in `CustomComponentConfiguration`. If used, `CustomComponentConfiguration` must be provided. + `DEFAULT_WITH_OVERWRITE`: The component will be configured with the recommended default monitoring settings of the selected `Tier`, and merged with customized overwrite settings that are specified in `DefaultOverwriteComponentConfiguration`. If used, `DefaultOverwriteComponentConfiguration` must be provided. *Required*: Yes *Type*: String *Allowed values*: `DEFAULT | DEFAULT_WITH_OVERWRITE | CUSTOM` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ComponentName` The name of the component. Either the component ARN or the component name is required. *Required*: No *Type*: String *Pattern*: `^[\d\w\-_.+]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomComponentConfiguration` Customized monitoring settings. Required if CUSTOM mode is configured in `ComponentConfigurationMode`. *Required*: No *Type*: [ComponentConfiguration](aws-properties-applicationinsights-application-componentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefaultOverwriteComponentConfiguration` Customized overwrite monitoring settings. Required if CUSTOM mode is configured in `ComponentConfigurationMode`. *Required*: No *Type*: [ComponentConfiguration](aws-properties-applicationinsights-application-componentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tier` The tier of the application component. Supported tiers include `DOT_NET_CORE`, `DOT_NET_WORKER`, `DOT_NET_WEB`, `SQL_SERVER`, `SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP`, `SQL_SERVER_FAILOVER_CLUSTER_INSTANCE`, `MYSQL`, `POSTGRESQL`, `JAVA_JMX`, `ORACLE`, `SAP_HANA_MULTI_NODE`, `SAP_HANA_SINGLE_NODE`, `SAP_HANA_HIGH_AVAILABILITY`, `SHAREPOINT`. `ACTIVE_DIRECTORY`, and `DEFAULT`. *Required*: Yes *Type*: String *Pattern*: `^[A-Z][A-Z_]*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application ConfigurationDetails The `AWS::ApplicationInsights::Application ConfigurationDetails` property type specifies the configuration settings. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AlarmMetrics](#cfn-applicationinsights-application-configurationdetails-alarmmetrics)" : [ AlarmMetric, ... ], "[Alarms](#cfn-applicationinsights-application-configurationdetails-alarms)" : [ Alarm, ... ], "[HAClusterPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-haclusterprometheusexporter)" : HAClusterPrometheusExporter, "[HANAPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-hanaprometheusexporter)" : HANAPrometheusExporter, "[JMXPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-jmxprometheusexporter)" : JMXPrometheusExporter, "[Logs](#cfn-applicationinsights-application-configurationdetails-logs)" : [ Log, ... ], "[NetWeaverPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-netweaverprometheusexporter)" : NetWeaverPrometheusExporter, "[Processes](#cfn-applicationinsights-application-configurationdetails-processes)" : [ Process, ... ], "[SQLServerPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-sqlserverprometheusexporter)" : SQLServerPrometheusExporter, "[WindowsEvents](#cfn-applicationinsights-application-configurationdetails-windowsevents)" : [ WindowsEvent, ... ] } ``` ### YAML ``` [AlarmMetrics](#cfn-applicationinsights-application-configurationdetails-alarmmetrics): - AlarmMetric [Alarms](#cfn-applicationinsights-application-configurationdetails-alarms): - Alarm [HAClusterPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-haclusterprometheusexporter): HAClusterPrometheusExporter [HANAPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-hanaprometheusexporter): HANAPrometheusExporter [JMXPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-jmxprometheusexporter): JMXPrometheusExporter [Logs](#cfn-applicationinsights-application-configurationdetails-logs): - Log [NetWeaverPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-netweaverprometheusexporter): NetWeaverPrometheusExporter [Processes](#cfn-applicationinsights-application-configurationdetails-processes): - Process [SQLServerPrometheusExporter](#cfn-applicationinsights-application-configurationdetails-sqlserverprometheusexporter): SQLServerPrometheusExporter [WindowsEvents](#cfn-applicationinsights-application-configurationdetails-windowsevents): - WindowsEvent ``` ## Properties `AlarmMetrics` A list of metrics to monitor for the component. All component types can use `AlarmMetrics`. *Required*: No *Type*: Array of [AlarmMetric](aws-properties-applicationinsights-application-alarmmetric.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Alarms` A list of alarms to monitor for the component. All component types can use `Alarm`. *Required*: No *Type*: Array of [Alarm](aws-properties-applicationinsights-application-alarm.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HAClusterPrometheusExporter` The HA cluster Prometheus Exporter settings. *Required*: No *Type*: [HAClusterPrometheusExporter](aws-properties-applicationinsights-application-haclusterprometheusexporter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HANAPrometheusExporter` The HANA DB Prometheus Exporter settings. *Required*: No *Type*: [HANAPrometheusExporter](aws-properties-applicationinsights-application-hanaprometheusexporter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JMXPrometheusExporter` A list of Java metrics to monitor for the component. *Required*: No *Type*: [JMXPrometheusExporter](aws-properties-applicationinsights-application-jmxprometheusexporter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Logs` A list of logs to monitor for the component. Only Amazon EC2 instances can use `Logs`. *Required*: No *Type*: Array of [Log](aws-properties-applicationinsights-application-log.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NetWeaverPrometheusExporter` Property description not available. *Required*: No *Type*: [NetWeaverPrometheusExporter](aws-properties-applicationinsights-application-netweaverprometheusexporter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Processes` Property description not available. *Required*: No *Type*: Array of [Process](aws-properties-applicationinsights-application-process.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SQLServerPrometheusExporter` Property description not available. *Required*: No *Type*: [SQLServerPrometheusExporter](aws-properties-applicationinsights-application-sqlserverprometheusexporter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WindowsEvents` A list of Windows Events to monitor for the component. Only Amazon EC2 instances running on Windows can use `WindowsEvents`. *Required*: No *Type*: Array of [WindowsEvent](aws-properties-applicationinsights-application-windowsevent.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application CustomComponent The `AWS::ApplicationInsights::Application CustomComponent` property type describes a custom component by grouping similar standalone instances to monitor. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ComponentName](#cfn-applicationinsights-application-customcomponent-componentname)" : String, "[ResourceList](#cfn-applicationinsights-application-customcomponent-resourcelist)" : [ String, ... ] } ``` ### YAML ``` [ComponentName](#cfn-applicationinsights-application-customcomponent-componentname): String [ResourceList](#cfn-applicationinsights-application-customcomponent-resourcelist): - String ``` ## Properties `ComponentName` The name of the component. *Required*: Yes *Type*: String *Pattern*: `^[\d\w\-_.+]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResourceList` The list of resource ARNs that belong to the component. *Required*: Yes *Type*: Array of String *Maximum*: `300` *Minimum*: `20 | 1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application HAClusterPrometheusExporter The `AWS::ApplicationInsights::Application HAClusterPrometheusExporter` property type defines the HA cluster Prometheus Exporter settings. For more information, see the [component configuration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config-sections.html#component-configuration-prometheus) in the CloudWatch Application Insights documentation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PrometheusPort](#cfn-applicationinsights-application-haclusterprometheusexporter-prometheusport)" : String } ``` ### YAML ``` [PrometheusPort](#cfn-applicationinsights-application-haclusterprometheusexporter-prometheusport): String ``` ## Properties `PrometheusPort` The target port to which Prometheus sends metrics. If not specified, the default port 9668 is used. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application HANAPrometheusExporter The `AWS::ApplicationInsights::Application HANAPrometheusExporter` property type defines the HANA DB Prometheus Exporter settings. For more information, see the [component configuration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config-sections.html#component-configuration-prometheus) in the CloudWatch Application Insights documentation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AgreeToInstallHANADBClient](#cfn-applicationinsights-application-hanaprometheusexporter-agreetoinstallhanadbclient)" : Boolean, "[HANAPort](#cfn-applicationinsights-application-hanaprometheusexporter-hanaport)" : String, "[HANASecretName](#cfn-applicationinsights-application-hanaprometheusexporter-hanasecretname)" : String, "[HANASID](#cfn-applicationinsights-application-hanaprometheusexporter-hanasid)" : String, "[PrometheusPort](#cfn-applicationinsights-application-hanaprometheusexporter-prometheusport)" : String } ``` ### YAML ``` [AgreeToInstallHANADBClient](#cfn-applicationinsights-application-hanaprometheusexporter-agreetoinstallhanadbclient): Boolean [HANAPort](#cfn-applicationinsights-application-hanaprometheusexporter-hanaport): String [HANASecretName](#cfn-applicationinsights-application-hanaprometheusexporter-hanasecretname): String [HANASID](#cfn-applicationinsights-application-hanaprometheusexporter-hanasid): String [PrometheusPort](#cfn-applicationinsights-application-hanaprometheusexporter-prometheusport): String ``` ## Properties `AgreeToInstallHANADBClient` Designates whether you agree to install the HANA DB client. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HANAPort` The HANA database port by which the exporter will query HANA metrics. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HANASecretName` The AWS Secrets Manager secret that stores HANA monitoring user credentials. The HANA Prometheus exporter uses these credentials to connect to the database and query HANA metrics. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HANASID` The three-character SAP system ID (SID) of the SAP HANA system. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrometheusPort` The target port to which Prometheus sends metrics. If not specified, the default port 9668 is used. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application JMXPrometheusExporter The `AWS::ApplicationInsights::Application JMXPrometheusExporter` property type defines the JMXPrometheus Exporter configuration. For more information, see the [component configuration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config-sections.html#component-configuration-prometheus) in the CloudWatch Application Insights documentation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[HostPort](#cfn-applicationinsights-application-jmxprometheusexporter-hostport)" : String, "[JMXURL](#cfn-applicationinsights-application-jmxprometheusexporter-jmxurl)" : String, "[PrometheusPort](#cfn-applicationinsights-application-jmxprometheusexporter-prometheusport)" : String } ``` ### YAML ``` [HostPort](#cfn-applicationinsights-application-jmxprometheusexporter-hostport): String [JMXURL](#cfn-applicationinsights-application-jmxprometheusexporter-jmxurl): String [PrometheusPort](#cfn-applicationinsights-application-jmxprometheusexporter-prometheusport): String ``` ## Properties `HostPort` The host and port to connect to through remote JMX. Only one of `jmxURL` and `hostPort` can be specified. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JMXURL` The complete JMX URL to connect to. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrometheusPort` The target port to send Prometheus metrics to. If not specified, the default port `9404` is used. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application Log The `AWS::ApplicationInsights::Application Log` property type specifies a log to monitor for the component. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Encoding](#cfn-applicationinsights-application-log-encoding)" : String, "[LogGroupName](#cfn-applicationinsights-application-log-loggroupname)" : String, "[LogPath](#cfn-applicationinsights-application-log-logpath)" : String, "[LogType](#cfn-applicationinsights-application-log-logtype)" : String, "[PatternSet](#cfn-applicationinsights-application-log-patternset)" : String } ``` ### YAML ``` [Encoding](#cfn-applicationinsights-application-log-encoding): String [LogGroupName](#cfn-applicationinsights-application-log-loggroupname): String [LogPath](#cfn-applicationinsights-application-log-logpath): String [LogType](#cfn-applicationinsights-application-log-logtype): String [PatternSet](#cfn-applicationinsights-application-log-patternset): String ``` ## Properties `Encoding` The type of encoding of the logs to be monitored. The specified encoding should be included in the list of CloudWatch agent supported encodings. If not provided, CloudWatch Application Insights uses the default encoding type for the log type: + `APPLICATION/DEFAULT`: utf-8 encoding + `SQL_SERVER`: utf-16 encoding + `IIS`: ascii encoding *Required*: No *Type*: String *Allowed values*: `utf-8 | utf-16 | ascii` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogGroupName` The CloudWatch log group name to be associated with the monitored log. *Required*: No *Type*: String *Pattern*: `[\.\-_/#A-Za-z0-9]+` *Minimum*: `1` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogPath` The path of the logs to be monitored. The log path must be an absolute Windows or Linux system file path. For more information, see [CloudWatch Agent Configuration File: Logs Section](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html#CloudWatch-Agent-Configuration-File-Logssection). *Required*: No *Type*: String *Pattern*: `^([a-zA-Z]:\\[\\\S|*\S]?.*|/[^"']*)$` *Minimum*: `1` *Maximum*: `260` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogType` The log type decides the log patterns against which Application Insights analyzes the log. The log type is selected from the following: `SQL_SERVER`, `MYSQL`, `MYSQL_SLOW_QUERY`, `POSTGRESQL`, `ORACLE_ALERT`, `ORACLE_LISTENER`, `IIS`, `APPLICATION`, `WINDOWS_EVENTS`, `WINDOWS_EVENTS_ACTIVE_DIRECTORY`, `WINDOWS_EVENTS_DNS `, `WINDOWS_EVENTS_IIS `, `WINDOWS_EVENTS_SHAREPOINT`, `SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP`, `SQL_SERVER_FAILOVER_CLUSTER_INSTANCE`, `STEP_FUNCTION`, `API_GATEWAY_ACCESS`, `API_GATEWAY_EXECUTION`, `SAP_HANA_LOGS`, `SAP_HANA_TRACE`, `SAP_HANA_HIGH_AVAILABILITY`, and `DEFAULT`. *Required*: Yes *Type*: String *Pattern*: `^[A-Z][A-Z_]*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PatternSet` The log pattern set. *Required*: No *Type*: String *Pattern*: `[a-zA-Z0-9.-_]*` *Minimum*: `1` *Maximum*: `30` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application LogPattern The `AWS::ApplicationInsights::Application LogPattern` property type specifies an object that defines the log patterns that belong to a `LogPatternSet`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Pattern](#cfn-applicationinsights-application-logpattern-pattern)" : String, "[PatternName](#cfn-applicationinsights-application-logpattern-patternname)" : String, "[Rank](#cfn-applicationinsights-application-logpattern-rank)" : Integer } ``` ### YAML ``` [Pattern](#cfn-applicationinsights-application-logpattern-pattern): String [PatternName](#cfn-applicationinsights-application-logpattern-patternname): String [Rank](#cfn-applicationinsights-application-logpattern-rank): Integer ``` ## Properties `Pattern` A regular expression that defines the log pattern. A log pattern can contain up to 50 characters, and it cannot be empty. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PatternName` The name of the log pattern. A log pattern name can contain up to 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9.-_]*` *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Rank` The rank of the log pattern. *Required*: Yes *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application LogPatternSet The `AWS::ApplicationInsights::Application LogPatternSet` property type specifies the log pattern set. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LogPatterns](#cfn-applicationinsights-application-logpatternset-logpatterns)" : [ LogPattern, ... ], "[PatternSetName](#cfn-applicationinsights-application-logpatternset-patternsetname)" : String } ``` ### YAML ``` [LogPatterns](#cfn-applicationinsights-application-logpatternset-logpatterns): - LogPattern [PatternSetName](#cfn-applicationinsights-application-logpatternset-patternsetname): String ``` ## Properties `LogPatterns` A list of objects that define the log patterns that belong to `LogPatternSet`. *Required*: Yes *Type*: Array of [LogPattern](aws-properties-applicationinsights-application-logpattern.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PatternSetName` The name of the log pattern. A log pattern name can contain up to 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9.-_]*` *Minimum*: `1` *Maximum*: `30` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application NetWeaverPrometheusExporter The `NetWeaverPrometheusExporter` property type specifies Property description not available. for an [AWS::ApplicationInsights::Application](aws-resource-applicationinsights-application.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceNumbers](#cfn-applicationinsights-application-netweaverprometheusexporter-instancenumbers)" : [ String, ... ], "[PrometheusPort](#cfn-applicationinsights-application-netweaverprometheusexporter-prometheusport)" : String, "[SAPSID](#cfn-applicationinsights-application-netweaverprometheusexporter-sapsid)" : String } ``` ### YAML ``` [InstanceNumbers](#cfn-applicationinsights-application-netweaverprometheusexporter-instancenumbers): - String [PrometheusPort](#cfn-applicationinsights-application-netweaverprometheusexporter-prometheusport): String [SAPSID](#cfn-applicationinsights-application-netweaverprometheusexporter-sapsid): String ``` ## Properties `InstanceNumbers` Property description not available. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrometheusPort` Property description not available. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SAPSID` Property description not available. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application Process The `Process` property type specifies Property description not available. for an [AWS::ApplicationInsights::Application](aws-resource-applicationinsights-application.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AlarmMetrics](#cfn-applicationinsights-application-process-alarmmetrics)" : [ AlarmMetric, ... ], "[ProcessName](#cfn-applicationinsights-application-process-processname)" : String } ``` ### YAML ``` [AlarmMetrics](#cfn-applicationinsights-application-process-alarmmetrics): - AlarmMetric [ProcessName](#cfn-applicationinsights-application-process-processname): String ``` ## Properties `AlarmMetrics` Property description not available. *Required*: Yes *Type*: Array of [AlarmMetric](aws-properties-applicationinsights-application-alarmmetric.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProcessName` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_,-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application SQLServerPrometheusExporter The `SQLServerPrometheusExporter` property type specifies Property description not available. for an [AWS::ApplicationInsights::Application](aws-resource-applicationinsights-application.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PrometheusPort](#cfn-applicationinsights-application-sqlserverprometheusexporter-prometheusport)" : String, "[SQLSecretName](#cfn-applicationinsights-application-sqlserverprometheusexporter-sqlsecretname)" : String } ``` ### YAML ``` [PrometheusPort](#cfn-applicationinsights-application-sqlserverprometheusexporter-prometheusport): String [SQLSecretName](#cfn-applicationinsights-application-sqlserverprometheusexporter-sqlsecretname): String ``` ## Properties `PrometheusPort` Property description not available. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SQLSecretName` Property description not available. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application SubComponentConfigurationDetails The `AWS::ApplicationInsights::Application SubComponentConfigurationDetails` property type specifies the configuration settings of the sub-components. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AlarmMetrics](#cfn-applicationinsights-application-subcomponentconfigurationdetails-alarmmetrics)" : [ AlarmMetric, ... ], "[Logs](#cfn-applicationinsights-application-subcomponentconfigurationdetails-logs)" : [ Log, ... ], "[Processes](#cfn-applicationinsights-application-subcomponentconfigurationdetails-processes)" : [ Process, ... ], "[WindowsEvents](#cfn-applicationinsights-application-subcomponentconfigurationdetails-windowsevents)" : [ WindowsEvent, ... ] } ``` ### YAML ``` [AlarmMetrics](#cfn-applicationinsights-application-subcomponentconfigurationdetails-alarmmetrics): - AlarmMetric [Logs](#cfn-applicationinsights-application-subcomponentconfigurationdetails-logs): - Log [Processes](#cfn-applicationinsights-application-subcomponentconfigurationdetails-processes): - Process [WindowsEvents](#cfn-applicationinsights-application-subcomponentconfigurationdetails-windowsevents): - WindowsEvent ``` ## Properties `AlarmMetrics` A list of metrics to monitor for the component. All component types can use `AlarmMetrics`. *Required*: No *Type*: Array of [AlarmMetric](aws-properties-applicationinsights-application-alarmmetric.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Logs` A list of logs to monitor for the component. Only Amazon EC2 instances can use `Logs`. *Required*: No *Type*: Array of [Log](aws-properties-applicationinsights-application-log.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Processes` Property description not available. *Required*: No *Type*: Array of [Process](aws-properties-applicationinsights-application-process.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WindowsEvents` A list of Windows Events to monitor for the component. Only Amazon EC2 instances running on Windows can use `WindowsEvents`. *Required*: No *Type*: Array of [WindowsEvent](aws-properties-applicationinsights-application-windowsevent.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application SubComponentTypeConfiguration The `AWS::ApplicationInsights::Application SubComponentTypeConfiguration` property type specifies the sub-component configurations for a component. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SubComponentConfigurationDetails](#cfn-applicationinsights-application-subcomponenttypeconfiguration-subcomponentconfigurationdetails)" : SubComponentConfigurationDetails, "[SubComponentType](#cfn-applicationinsights-application-subcomponenttypeconfiguration-subcomponenttype)" : String } ``` ### YAML ``` [SubComponentConfigurationDetails](#cfn-applicationinsights-application-subcomponenttypeconfiguration-subcomponentconfigurationdetails): SubComponentConfigurationDetails [SubComponentType](#cfn-applicationinsights-application-subcomponenttypeconfiguration-subcomponenttype): String ``` ## Properties `SubComponentConfigurationDetails` The configuration settings of the sub-components. *Required*: Yes *Type*: [SubComponentConfigurationDetails](aws-properties-applicationinsights-application-subcomponentconfigurationdetails.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubComponentType` The sub-component type. *Required*: Yes *Type*: String *Allowed values*: `AWS::EC2::Instance | AWS::EC2::Volume` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application Tag An object that defines the tags associated with an application. A *tag* is a label that you optionally define and associate with an application. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a required *tag key* and an associated *tag value*, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: \$1 . : / = \$1 -. The following additional restrictions apply to tags: + Tag keys and values are case sensitive. + For each associated resource, each tag key must be unique and it can have only one value. + The `aws:` prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-applicationinsights-application-tag-key)" : String, "[Value](#cfn-applicationinsights-application-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-applicationinsights-application-tag-key): String [Value](#cfn-applicationinsights-application-tag-value): String ``` ## Properties `Key` One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value, don't specify a value for this parameter. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::ApplicationInsights::Application WindowsEvent The `AWS::ApplicationInsights::Application WindowsEvent` property type specifies a Windows Event to monitor for the component. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EventLevels](#cfn-applicationinsights-application-windowsevent-eventlevels)" : [ String, ... ], "[EventName](#cfn-applicationinsights-application-windowsevent-eventname)" : String, "[LogGroupName](#cfn-applicationinsights-application-windowsevent-loggroupname)" : String, "[PatternSet](#cfn-applicationinsights-application-windowsevent-patternset)" : String } ``` ### YAML ``` [EventLevels](#cfn-applicationinsights-application-windowsevent-eventlevels): - String [EventName](#cfn-applicationinsights-application-windowsevent-eventname): String [LogGroupName](#cfn-applicationinsights-application-windowsevent-loggroupname): String [PatternSet](#cfn-applicationinsights-application-windowsevent-patternset): String ``` ## Properties `EventLevels` The levels of event to log. You must specify each level to log. Possible values include `INFORMATION`, `WARNING`, `ERROR`, `CRITICAL`, and `VERBOSE`. This field is required for each type of Windows Event to log. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EventName` The type of Windows Events to log, equivalent to the Windows Event log channel name. For example, System, Security, CustomEventName, and so on. This field is required for each type of Windows event to log. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_ \\/-]+$` *Minimum*: `1` *Maximum*: `260` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogGroupName` The CloudWatch log group name to be associated with the monitored log. *Required*: Yes *Type*: String *Pattern*: `[\.\-_/#A-Za-z0-9]+` *Minimum*: `1` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PatternSet` The log pattern set. *Required*: No *Type*: String *Pattern*: `[a-zA-Z0-9.-_]*` *Minimum*: `1` *Maximum*: `30` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)