software.amazon.awscdk.services.applicationinsights

Interface CfnApplication.ComponentMonitoringSettingProperty

All Known Implementing Classes:

CfnApplication.ComponentMonitoringSettingProperty.Jsii$Proxy

Enclosing class:

CfnApplication

public static interface CfnApplication.ComponentMonitoringSettingProperty

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.applicationinsights.*;
 ComponentMonitoringSettingProperty componentMonitoringSettingProperty = ComponentMonitoringSettingProperty.builder()
         .componentConfigurationMode("componentConfigurationMode")
         .tier("tier")
         // the properties below are optional
         .componentArn("componentArn")
         .componentName("componentName")
         .customComponentConfiguration(ComponentConfigurationProperty.builder()
                 .configurationDetails(ConfigurationDetailsProperty.builder()
                         .alarmMetrics(List.of(AlarmMetricProperty.builder()
                                 .alarmMetricName("alarmMetricName")
                                 .build()))
                         .alarms(List.of(AlarmProperty.builder()
                                 .alarmName("alarmName")
                                 // the properties below are optional
                                 .severity("severity")
                                 .build()))
                         .haClusterPrometheusExporter(HAClusterPrometheusExporterProperty.builder()
                                 .prometheusPort("prometheusPort")
                                 .build())
                         .hanaPrometheusExporter(HANAPrometheusExporterProperty.builder()
                                 .agreeToInstallHanadbClient(false)
                                 .hanaPort("hanaPort")
                                 .hanaSecretName("hanaSecretName")
                                 .hanasid("hanasid")
                                 // the properties below are optional
                                 .prometheusPort("prometheusPort")
                                 .build())
                         .jmxPrometheusExporter(JMXPrometheusExporterProperty.builder()
                                 .hostPort("hostPort")
                                 .jmxurl("jmxurl")
                                 .prometheusPort("prometheusPort")
                                 .build())
                         .logs(List.of(LogProperty.builder()
                                 .logType("logType")
                                 // the properties below are optional
                                 .encoding("encoding")
                                 .logGroupName("logGroupName")
                                 .logPath("logPath")
                                 .patternSet("patternSet")
                                 .build()))
                         .windowsEvents(List.of(WindowsEventProperty.builder()
                                 .eventLevels(List.of("eventLevels"))
                                 .eventName("eventName")
                                 .logGroupName("logGroupName")
                                 // the properties below are optional
                                 .patternSet("patternSet")
                                 .build()))
                         .build())
                 .subComponentTypeConfigurations(List.of(SubComponentTypeConfigurationProperty.builder()
                         .subComponentConfigurationDetails(SubComponentConfigurationDetailsProperty.builder()
                                 .alarmMetrics(List.of(AlarmMetricProperty.builder()
                                         .alarmMetricName("alarmMetricName")
                                         .build()))
                                 .logs(List.of(LogProperty.builder()
                                         .logType("logType")
                                         // the properties below are optional
                                         .encoding("encoding")
                                         .logGroupName("logGroupName")
                                         .logPath("logPath")
                                         .patternSet("patternSet")
                                         .build()))
                                 .windowsEvents(List.of(WindowsEventProperty.builder()
                                         .eventLevels(List.of("eventLevels"))
                                         .eventName("eventName")
                                         .logGroupName("logGroupName")
                                         // the properties below are optional
                                         .patternSet("patternSet")
                                         .build()))
                                 .build())
                         .subComponentType("subComponentType")
                         .build()))
                 .build())
         .defaultOverwriteComponentConfiguration(ComponentConfigurationProperty.builder()
                 .configurationDetails(ConfigurationDetailsProperty.builder()
                         .alarmMetrics(List.of(AlarmMetricProperty.builder()
                                 .alarmMetricName("alarmMetricName")
                                 .build()))
                         .alarms(List.of(AlarmProperty.builder()
                                 .alarmName("alarmName")
                                 // the properties below are optional
                                 .severity("severity")
                                 .build()))
                         .haClusterPrometheusExporter(HAClusterPrometheusExporterProperty.builder()
                                 .prometheusPort("prometheusPort")
                                 .build())
                         .hanaPrometheusExporter(HANAPrometheusExporterProperty.builder()
                                 .agreeToInstallHanadbClient(false)
                                 .hanaPort("hanaPort")
                                 .hanaSecretName("hanaSecretName")
                                 .hanasid("hanasid")
                                 // the properties below are optional
                                 .prometheusPort("prometheusPort")
                                 .build())
                         .jmxPrometheusExporter(JMXPrometheusExporterProperty.builder()
                                 .hostPort("hostPort")
                                 .jmxurl("jmxurl")
                                 .prometheusPort("prometheusPort")
                                 .build())
                         .logs(List.of(LogProperty.builder()
                                 .logType("logType")
                                 // the properties below are optional
                                 .encoding("encoding")
                                 .logGroupName("logGroupName")
                                 .logPath("logPath")
                                 .patternSet("patternSet")
                                 .build()))
                         .windowsEvents(List.of(WindowsEventProperty.builder()
                                 .eventLevels(List.of("eventLevels"))
                                 .eventName("eventName")
                                 .logGroupName("logGroupName")
                                 // the properties below are optional
                                 .patternSet("patternSet")
                                 .build()))
                         .build())
                 .subComponentTypeConfigurations(List.of(SubComponentTypeConfigurationProperty.builder()
                         .subComponentConfigurationDetails(SubComponentConfigurationDetailsProperty.builder()
                                 .alarmMetrics(List.of(AlarmMetricProperty.builder()
                                         .alarmMetricName("alarmMetricName")
                                         .build()))
                                 .logs(List.of(LogProperty.builder()
                                         .logType("logType")
                                         // the properties below are optional
                                         .encoding("encoding")
                                         .logGroupName("logGroupName")
                                         .logPath("logPath")
                                         .patternSet("patternSet")
                                         .build()))
                                 .windowsEvents(List.of(WindowsEventProperty.builder()
                                         .eventLevels(List.of("eventLevels"))
                                         .eventName("eventName")
                                         .logGroupName("logGroupName")
                                         // the properties below are optional
                                         .patternSet("patternSet")
                                         .build()))
                                 .build())
                         .subComponentType("subComponentType")
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnApplication.ComponentMonitoringSettingProperty.Builder A builder for CfnApplication.ComponentMonitoringSettingProperty
static class	CfnApplication.ComponentMonitoringSettingProperty.Jsii$Proxy An implementation for CfnApplication.ComponentMonitoringSettingProperty

Method Summary

Modifier and Type	Method and Description
static CfnApplication.ComponentMonitoringSettingProperty.Builder	builder()
default java.lang.String	getComponentArn() The ARN of the component.
java.lang.String	getComponentConfigurationMode() Component monitoring can be configured in one of the following three modes:.
default java.lang.String	getComponentName() The name of the component.
default java.lang.Object	getCustomComponentConfiguration() Customized monitoring settings.
default java.lang.Object	getDefaultOverwriteComponentConfiguration() Customized overwrite monitoring settings.
java.lang.String	getTier() The tier of the application component.

Method Detail

getComponentConfigurationMode

java.lang.String getComponentConfigurationMode()

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.

getTier

java.lang.String getTier()

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 .

getComponentArn

default java.lang.String getComponentArn()

The ARN of the component.

getComponentName

default java.lang.String getComponentName()

The name of the component.

getCustomComponentConfiguration

default java.lang.Object getCustomComponentConfiguration()

Customized monitoring settings.

Required if CUSTOM mode is configured in ComponentConfigurationMode .

getDefaultOverwriteComponentConfiguration

default java.lang.Object getDefaultOverwriteComponentConfiguration()

Customized overwrite monitoring settings.

Required if CUSTOM mode is configured in ComponentConfigurationMode .

builder

static CfnApplication.ComponentMonitoringSettingProperty.Builder builder()

Returns:

a CfnApplication.ComponentMonitoringSettingProperty.Builder of CfnApplication.ComponentMonitoringSettingProperty