interface ComponentMonitoringSettingProperty

Language	Type name
.NET	Amazon.CDK.AWS.ApplicationInsights.CfnApplication.ComponentMonitoringSettingProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapplicationinsights#CfnApplication_ComponentMonitoringSettingProperty
Java	software.amazon.awscdk.services.applicationinsights.CfnApplication.ComponentMonitoringSettingProperty
Python	aws_cdk.aws_applicationinsights.CfnApplication.ComponentMonitoringSettingProperty
TypeScript	aws-cdk-lib » aws_applicationinsights » CfnApplication » ComponentMonitoringSettingProperty

The AWS::ApplicationInsights::Application ComponentMonitoringSetting property type defines the monitoring setting of the component.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html

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 componentMonitoringSettingProperty: applicationinsights.CfnApplication.ComponentMonitoringSettingProperty = {
  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',
      }],
      netWeaverPrometheusExporter: {
        instanceNumbers: ['instanceNumbers'],
        sapsid: 'sapsid',

        // the properties below are optional
        prometheusPort: 'prometheusPort',
      },
      processes: [{
        alarmMetrics: [{
          alarmMetricName: 'alarmMetricName',
        }],
        processName: 'processName',
      }],
      sqlServerPrometheusExporter: {
        prometheusPort: 'prometheusPort',
        sqlSecretName: 'sqlSecretName',
      },
      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',
        }],
        processes: [{
          alarmMetrics: [{
            alarmMetricName: 'alarmMetricName',
          }],
          processName: 'processName',
        }],
        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',
      }],
      netWeaverPrometheusExporter: {
        instanceNumbers: ['instanceNumbers'],
        sapsid: 'sapsid',

        // the properties below are optional
        prometheusPort: 'prometheusPort',
      },
      processes: [{
        alarmMetrics: [{
          alarmMetricName: 'alarmMetricName',
        }],
        processName: 'processName',
      }],
      sqlServerPrometheusExporter: {
        prometheusPort: 'prometheusPort',
        sqlSecretName: 'sqlSecretName',
      },
      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',
        }],
        processes: [{
          alarmMetrics: [{
            alarmMetricName: 'alarmMetricName',
          }],
          processName: 'processName',
        }],
        windowsEvents: [{
          eventLevels: ['eventLevels'],
          eventName: 'eventName',
          logGroupName: 'logGroupName',

          // the properties below are optional
          patternSet: 'patternSet',
        }],
      },
      subComponentType: 'subComponentType',
    }],
  },
};

Properties

Name	Type	Description
componentConfigurationMode	string	Component monitoring can be configured in one of the following three modes:.
tier	string	The tier of the application component.
componentArn?	string	The ARN of the component.
componentName?	string	The name of the component.
customComponentConfiguration?	IResolvable | ComponentConfigurationProperty	Customized monitoring settings.
defaultOverwriteComponentConfiguration?	IResolvable | ComponentConfigurationProperty	Customized overwrite monitoring settings.

---

componentConfigurationMode

Type: string

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentconfigurationmode

---

tier

Type: string

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-tier

---

componentArn?

Type: string (optional)

The ARN of the component.

Either the component ARN or the component name is required.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentarn

---

componentName?

Type: string (optional)

The name of the component.

Either the component ARN or the component name is required.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentname

---

customComponentConfiguration?

Type: IResolvable | ComponentConfigurationProperty (optional)

Customized monitoring settings.

Required if CUSTOM mode is configured in ComponentConfigurationMode .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-customcomponentconfiguration

---

defaultOverwriteComponentConfiguration?

Type: IResolvable | ComponentConfigurationProperty (optional)

Customized overwrite monitoring settings.

Required if CUSTOM mode is configured in ComponentConfigurationMode .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-defaultoverwritecomponentconfiguration