aws-cdk-lib.aws_applicationinsights.CfnApplicationProps

interface CfnApplicationProps

LanguageType name
.NETAmazon.CDK.AWS.ApplicationInsights.CfnApplicationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapplicationinsights#CfnApplicationProps
Javasoftware.amazon.awscdk.services.applicationinsights.CfnApplicationProps
Pythonaws_cdk.aws_applicationinsights.CfnApplicationProps
TypeScript aws-cdk-lib » aws_applicationinsights » CfnApplicationProps

Properties for defining a CfnApplication.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_applicationinsights as applicationinsights } from 'aws-cdk-lib';
const cfnApplicationProps: applicationinsights.CfnApplicationProps = {
  resourceGroupName: 'resourceGroupName',

  // the properties below are optional
  autoConfigurationEnabled: false,
  componentMonitoringSettings: [{
    componentConfigurationMode: 'componentConfigurationMode',
    tier: 'tier',

    // the properties below are optional
    componentArn: 'componentArn',
    componentName: 'componentName',
    customComponentConfiguration: {
      configurationDetails: {
        alarmMetrics: [{
          alarmMetricName: 'alarmMetricName',
        }],
        alarms: [{
          alarmName: 'alarmName',

          // the properties below are optional
          severity: 'severity',
        }],
        haClusterPrometheusExporter: {
          prometheusPort: 'prometheusPort',
        },
        hanaPrometheusExporter: {
          agreeToInstallHanadbClient: false,
          hanaPort: 'hanaPort',
          hanaSecretName: 'hanaSecretName',
          hanasid: 'hanasid',

          // the properties below are optional
          prometheusPort: 'prometheusPort',
        },
        jmxPrometheusExporter: {
          hostPort: 'hostPort',
          jmxurl: 'jmxurl',
          prometheusPort: 'prometheusPort',
        },
        logs: [{
          logType: 'logType',

          // the properties below are optional
          encoding: 'encoding',
          logGroupName: 'logGroupName',
          logPath: 'logPath',
          patternSet: 'patternSet',
        }],
        windowsEvents: [{
          eventLevels: ['eventLevels'],
          eventName: 'eventName',
          logGroupName: 'logGroupName',

          // the properties below are optional
          patternSet: 'patternSet',
        }],
      },
      subComponentTypeConfigurations: [{
        subComponentConfigurationDetails: {
          alarmMetrics: [{
            alarmMetricName: 'alarmMetricName',
          }],
          logs: [{
            logType: 'logType',

            // the properties below are optional
            encoding: 'encoding',
            logGroupName: 'logGroupName',
            logPath: 'logPath',
            patternSet: 'patternSet',
          }],
          windowsEvents: [{
            eventLevels: ['eventLevels'],
            eventName: 'eventName',
            logGroupName: 'logGroupName',

            // the properties below are optional
            patternSet: 'patternSet',
          }],
        },
        subComponentType: 'subComponentType',
      }],
    },
    defaultOverwriteComponentConfiguration: {
      configurationDetails: {
        alarmMetrics: [{
          alarmMetricName: 'alarmMetricName',
        }],
        alarms: [{
          alarmName: 'alarmName',

          // the properties below are optional
          severity: 'severity',
        }],
        haClusterPrometheusExporter: {
          prometheusPort: 'prometheusPort',
        },
        hanaPrometheusExporter: {
          agreeToInstallHanadbClient: false,
          hanaPort: 'hanaPort',
          hanaSecretName: 'hanaSecretName',
          hanasid: 'hanasid',

          // the properties below are optional
          prometheusPort: 'prometheusPort',
        },
        jmxPrometheusExporter: {
          hostPort: 'hostPort',
          jmxurl: 'jmxurl',
          prometheusPort: 'prometheusPort',
        },
        logs: [{
          logType: 'logType',

          // the properties below are optional
          encoding: 'encoding',
          logGroupName: 'logGroupName',
          logPath: 'logPath',
          patternSet: 'patternSet',
        }],
        windowsEvents: [{
          eventLevels: ['eventLevels'],
          eventName: 'eventName',
          logGroupName: 'logGroupName',

          // the properties below are optional
          patternSet: 'patternSet',
        }],
      },
      subComponentTypeConfigurations: [{
        subComponentConfigurationDetails: {
          alarmMetrics: [{
            alarmMetricName: 'alarmMetricName',
          }],
          logs: [{
            logType: 'logType',

            // the properties below are optional
            encoding: 'encoding',
            logGroupName: 'logGroupName',
            logPath: 'logPath',
            patternSet: 'patternSet',
          }],
          windowsEvents: [{
            eventLevels: ['eventLevels'],
            eventName: 'eventName',
            logGroupName: 'logGroupName',

            // the properties below are optional
            patternSet: 'patternSet',
          }],
        },
        subComponentType: 'subComponentType',
      }],
    },
  }],
  customComponents: [{
    componentName: 'componentName',
    resourceList: ['resourceList'],
  }],
  cweMonitorEnabled: false,
  groupingType: 'groupingType',
  logPatternSets: [{
    logPatterns: [{
      pattern: 'pattern',
      patternName: 'patternName',
      rank: 123,
    }],
    patternSetName: 'patternSetName',
  }],
  opsCenterEnabled: false,
  opsItemSnsTopicArn: 'opsItemSnsTopicArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
resourceGroupNamestringThe name of the resource group used for the application.
autoConfigurationEnabled?boolean | IResolvableIf set to true , the application components will be configured with the monitoring configuration recommended by Application Insights.
componentMonitoringSettings?IResolvable | IResolvable | ComponentMonitoringSettingProperty[]The monitoring settings of the components.
customComponents?IResolvable | IResolvable | CustomComponentProperty[]Describes a custom component by grouping similar standalone instances to monitor.
cweMonitorEnabled?boolean | IResolvableIndicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.
groupingType?stringApplication Insights can create applications based on a resource group or on an account.
logPatternSets?IResolvable | IResolvable | LogPatternSetProperty[]The log pattern sets.
opsCenterEnabled?boolean | IResolvableIndicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
opsItemSnsTopicArn?stringThe SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.
tags?CfnTag[]An array of Tags .

resourceGroupName

Type: string

The name of the resource group used for the application.


autoConfigurationEnabled?

Type: boolean | IResolvable (optional)

If set to true , the application components will be configured with the monitoring configuration recommended by Application Insights.


componentMonitoringSettings?

Type: IResolvable | IResolvable | ComponentMonitoringSettingProperty[] (optional)

The monitoring settings of the components.


customComponents?

Type: IResolvable | IResolvable | CustomComponentProperty[] (optional)

Describes a custom component by grouping similar standalone instances to monitor.


cweMonitorEnabled?

Type: boolean | IResolvable (optional)

Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.


groupingType?

Type: string (optional)

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 .


logPatternSets?

Type: IResolvable | IResolvable | LogPatternSetProperty[] (optional)

The log pattern sets.


opsCenterEnabled?

Type: boolean | IResolvable (optional)

Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.


opsItemSnsTopicArn?

Type: string (optional)

The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.


tags?

Type: CfnTag[] (optional)

An array of Tags .