Package software.amazon.awscdk.services.applicationinsights

Interface CfnApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:12.395Z")
@Stability(Stable)
public interface CfnApplicationProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.applicationinsights.*;
 CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
         .resourceGroupName("resourceGroupName")
         // the properties below are optional
         .attachMissingPermission(false)
         .autoConfigurationEnabled(false)
         .componentMonitoringSettings(List.of(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()))
         .customComponents(List.of(CustomComponentProperty.builder()
                 .componentName("componentName")
                 .resourceList(List.of("resourceList"))
                 .build()))
         .cweMonitorEnabled(false)
         .groupingType("groupingType")
         .logPatternSets(List.of(LogPatternSetProperty.builder()
                 .logPatterns(List.of(LogPatternProperty.builder()
                         .pattern("pattern")
                         .patternName("patternName")
                         .rank(123)
                         .build()))
                 .patternSetName("patternSetName")
                 .build()))
         .opsCenterEnabled(false)
         .opsItemSnsTopicArn("opsItemSnsTopicArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplicationProps.Builder	builder()
default Object	getAttachMissingPermission()	If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.
default Object	getAutoConfigurationEnabled()	If set to true , the application components will be configured with the monitoring configuration recommended by Application Insights.
default Object	getComponentMonitoringSettings()	The monitoring settings of the components.
default Object	getCustomComponents()	Describes a custom component by grouping similar standalone instances to monitor.
default Object	getCweMonitorEnabled()	Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.
default String	getGroupingType()	Application Insights can create applications based on a resource group or on an account.
default Object	getLogPatternSets()	The log pattern sets.
default Object	getOpsCenterEnabled()	Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
default String	getOpsItemSnsTopicArn()	The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.
String	getResourceGroupName()	The name of the resource group used for the application.
default List<CfnTag>	getTags()	An array of Tags .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResourceGroupName

@Stability(Stable)
@NotNull
String getResourceGroupName()

The name of the resource group used for the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-resourcegroupname

getAttachMissingPermission

@Stability(Stable)
@Nullable
default Object getAttachMissingPermission()

If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-attachmissingpermission

getAutoConfigurationEnabled

@Stability(Stable)
@Nullable
default Object getAutoConfigurationEnabled()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-autoconfigurationenabled

getComponentMonitoringSettings

@Stability(Stable)
@Nullable
default Object getComponentMonitoringSettings()

The monitoring settings of the components.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-componentmonitoringsettings

getCustomComponents

@Stability(Stable)
@Nullable
default Object getCustomComponents()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-customcomponents

getCweMonitorEnabled

@Stability(Stable)
@Nullable
default Object getCweMonitorEnabled()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-cwemonitorenabled

getGroupingType

@Stability(Stable)
@Nullable
default String getGroupingType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-groupingtype

getLogPatternSets

@Stability(Stable)
@Nullable
default Object getLogPatternSets()

The log pattern sets.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-logpatternsets

getOpsCenterEnabled

@Stability(Stable)
@Nullable
default Object getOpsCenterEnabled()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-opscenterenabled

getOpsItemSnsTopicArn

@Stability(Stable)
@Nullable
default String getOpsItemSnsTopicArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-opsitemsnstopicarn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of Tags .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationinsights-application.html#cfn-applicationinsights-application-tags

builder

@Stability(Stable)
static CfnApplicationProps.Builder builder()

Returns:

a CfnApplicationProps.Builder of CfnApplicationProps