Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-applicationinsights-application.json
Parent schema serverless-framework-configuration
Type: object

Resource schema for AWS::ApplicationInsights::Application. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-applicationinsights.git

Properties

ResourceGroupName string | Aws_CF_FunctionString required

The name of the resource group.

CWEMonitorEnabled boolean

Indicates whether Application Insights can listen to CloudWatch events for the application resources.

OpsCenterEnabled boolean

When set to true, creates opsItems for any problems detected on an application.

OpsItemSNSTopicArn string | Aws_CF_FunctionString

The SNS topic provided to Application Insights that is associated to the created opsItem.

Tags Tag[]

The tags of Application Insights application.

minItems=1
CustomComponents CustomComponent[]

The custom grouped components.

minItems=1
LogPatternSets LogPatternSet[]

The log pattern sets.

minItems=1
AutoConfigurationEnabled boolean

If set to true, application will be configured with recommended monitoring configuration.

ComponentMonitoringSettings ComponentMonitoringSetting[]

The monitoring settings of the components.

minItems=1
GroupingType string | Aws_CF_FunctionString

The grouping type of the application

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

CustomComponent object

The custom grouped component.

ComponentName string | Aws_CF_FunctionString required

The name of the component.

ResourceList string[] required

The list of resource ARNs that belong to the component.

minItems=1
LogPatternSet object

The log pattern set.

PatternSetName string | Aws_CF_FunctionString required

The name of the log pattern set.

LogPatterns LogPattern[] required

The log patterns of a set.

minItems=1
LogPattern object

The log pattern.

PatternName string | Aws_CF_FunctionString required

The name of the log pattern.

Pattern string | Aws_CF_FunctionString required

The log pattern.

Rank integer required

Rank of the log pattern.

ComponentMonitoringSetting object

The monitoring setting of the component.

Tier string | Aws_CF_FunctionString required

The tier of the application component.

ComponentConfigurationMode string | Aws_CF_FunctionString required

The component monitoring configuration mode.

ComponentName string | Aws_CF_FunctionString

The name of the component.

ComponentARN string | Aws_CF_FunctionString

The ARN of the compnonent.

DefaultOverwriteComponentConfiguration object

The configuration settings of the component.

2 nested properties
ConfigurationDetails object

The configuration settings.

7 nested properties
AlarmMetrics AlarmMetric[]

A list of metrics to monitor for the component.

Logs Log[]

A list of logs to monitor for the component.

WindowsEvents WindowsEvent[]

A list of Windows Events to log.

Alarms Alarm[]

A list of alarms to monitor for the component.

JMXPrometheusExporter object

The JMX Prometheus Exporter settings.

HANAPrometheusExporter object

The HANA DB Prometheus Exporter settings.

HAClusterPrometheusExporter object

The HA cluster Prometheus Exporter settings.

SubComponentTypeConfigurations SubComponentTypeConfiguration[]

Sub component configurations of the component.

minItems=1
CustomComponentConfiguration object

The configuration settings of the component.

2 nested properties
ConfigurationDetails object

The configuration settings.

7 nested properties
AlarmMetrics AlarmMetric[]

A list of metrics to monitor for the component.

Logs Log[]

A list of logs to monitor for the component.

WindowsEvents WindowsEvent[]

A list of Windows Events to log.

Alarms Alarm[]

A list of alarms to monitor for the component.

JMXPrometheusExporter object

The JMX Prometheus Exporter settings.

HANAPrometheusExporter object

The HANA DB Prometheus Exporter settings.

HAClusterPrometheusExporter object

The HA cluster Prometheus Exporter settings.

SubComponentTypeConfigurations SubComponentTypeConfiguration[]

Sub component configurations of the component.

minItems=1
ComponentConfiguration object

The configuration settings of the component.

ConfigurationDetails object

The configuration settings.

7 nested properties
AlarmMetrics AlarmMetric[]

A list of metrics to monitor for the component.

Logs Log[]

A list of logs to monitor for the component.

WindowsEvents WindowsEvent[]

A list of Windows Events to log.

Alarms Alarm[]

A list of alarms to monitor for the component.

JMXPrometheusExporter object

The JMX Prometheus Exporter settings.

3 nested properties
JMXURL string | Aws_CF_FunctionString

JMX service URL.

HostPort string | Aws_CF_FunctionString

Java agent host port

PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

HANAPrometheusExporter object

The HANA DB Prometheus Exporter settings.

5 nested properties
HANASID string | Aws_CF_FunctionString required

HANA DB SID.

HANAPort string | Aws_CF_FunctionString required

The HANA DB port.

HANASecretName string | Aws_CF_FunctionString required

The secret name which manages the HANA DB credentials e.g. { "username": "<>", "password": "<>" }.

AgreeToInstallHANADBClient boolean required

A flag which indicates agreeing to install SAP HANA DB client.

PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

HAClusterPrometheusExporter object

The HA cluster Prometheus Exporter settings.

1 nested properties
PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

SubComponentTypeConfigurations SubComponentTypeConfiguration[]

Sub component configurations of the component.

minItems=1
ConfigurationDetails object

The configuration settings.

AlarmMetrics AlarmMetric[]

A list of metrics to monitor for the component.

Logs Log[]

A list of logs to monitor for the component.

WindowsEvents WindowsEvent[]

A list of Windows Events to log.

Alarms Alarm[]

A list of alarms to monitor for the component.

JMXPrometheusExporter object

The JMX Prometheus Exporter settings.

3 nested properties
JMXURL string | Aws_CF_FunctionString

JMX service URL.

HostPort string | Aws_CF_FunctionString

Java agent host port

PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

HANAPrometheusExporter object

The HANA DB Prometheus Exporter settings.

5 nested properties
HANASID string | Aws_CF_FunctionString required

HANA DB SID.

HANAPort string | Aws_CF_FunctionString required

The HANA DB port.

HANASecretName string | Aws_CF_FunctionString required

The secret name which manages the HANA DB credentials e.g. { "username": "<>", "password": "<>" }.

AgreeToInstallHANADBClient boolean required

A flag which indicates agreeing to install SAP HANA DB client.

PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

HAClusterPrometheusExporter object

The HA cluster Prometheus Exporter settings.

1 nested properties
PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

SubComponentConfigurationDetails object

The configuration settings of sub components.

AlarmMetrics AlarmMetric[]

A list of metrics to monitor for the component.

Logs Log[]

A list of logs to monitor for the component.

WindowsEvents WindowsEvent[]

A list of Windows Events to log.

JMXPrometheusExporter object

The JMX Prometheus Exporter settings.

JMXURL string | Aws_CF_FunctionString

JMX service URL.

HostPort string | Aws_CF_FunctionString

Java agent host port

PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

HANAPrometheusExporter object

The HANA DB Prometheus Exporter settings.

HANASID string | Aws_CF_FunctionString required

HANA DB SID.

HANAPort string | Aws_CF_FunctionString required

The HANA DB port.

HANASecretName string | Aws_CF_FunctionString required

The secret name which manages the HANA DB credentials e.g. { "username": "<>", "password": "<>" }.

AgreeToInstallHANADBClient boolean required

A flag which indicates agreeing to install SAP HANA DB client.

PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

HAClusterPrometheusExporter object

The HA cluster Prometheus Exporter settings.

PrometheusPort string | Aws_CF_FunctionString

Prometheus exporter port.

AlarmMetric object

A metric to be monitored for the component.

AlarmMetricName string | Aws_CF_FunctionString required

The name of the metric to be monitored for the component.

Log object

A log to be monitored for the component.

LogType string | Aws_CF_FunctionString required

The log type decides the log patterns against which Application Insights analyzes the log.

LogGroupName string | Aws_CF_FunctionString

The CloudWatch log group name to be associated to the monitored log.

LogPath string | Aws_CF_FunctionString

The path of the logs to be monitored.

Encoding string | Aws_CF_FunctionString

The type of encoding of the logs to be monitored.

PatternSet string | Aws_CF_FunctionString

The name of the log pattern set.

WindowsEvent object

A Windows Event to be monitored for the component.

LogGroupName string | Aws_CF_FunctionString required

The CloudWatch log group name to be associated to the monitored log.

EventName string | Aws_CF_FunctionString required

The type of Windows Events to log.

EventLevels EventLevel[] required

The levels of event to log.

minItems=1
PatternSet string | Aws_CF_FunctionString

The name of the log pattern set.

EventLevel string | Aws_CF_FunctionString

The level of event to log.

Alarm object

A CloudWatch alarm to be monitored for the component.

AlarmName string | Aws_CF_FunctionString required

The name of the CloudWatch alarm to be monitored for the component.

Severity string | Aws_CF_FunctionString

Indicates the degree of outage when the alarm goes off.

SubComponentTypeConfiguration object

One type sub component configurations for the component.

SubComponentType string | Aws_CF_FunctionString required

The sub component type.

SubComponentConfigurationDetails object required

The configuration settings of sub components.

3 nested properties
AlarmMetrics AlarmMetric[]

A list of metrics to monitor for the component.

Logs Log[]

A list of logs to monitor for the component.

WindowsEvents WindowsEvent[]

A list of Windows Events to log.