Class CfnApplication
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.applicationinsights.CfnApplication
- All Implemented Interfaces:
IInspectable,ITaggable,IApplicationRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-29T11:15:32.115Z")
@Stability(Stable)
public class CfnApplication
extends CfnResource
implements IInspectable, IApplicationRef, ITaggable
The
AWS::ApplicationInsights::Application resource adds an application that is created from a resource group.
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.*;
CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
.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()))
.netWeaverPrometheusExporter(NetWeaverPrometheusExporterProperty.builder()
.instanceNumbers(List.of("instanceNumbers"))
.sapsid("sapsid")
// the properties below are optional
.prometheusPort("prometheusPort")
.build())
.processes(List.of(ProcessProperty.builder()
.alarmMetrics(List.of(AlarmMetricProperty.builder()
.alarmMetricName("alarmMetricName")
.build()))
.processName("processName")
.build()))
.sqlServerPrometheusExporter(SQLServerPrometheusExporterProperty.builder()
.prometheusPort("prometheusPort")
.sqlSecretName("sqlSecretName")
.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()))
.processes(List.of(ProcessProperty.builder()
.alarmMetrics(List.of(AlarmMetricProperty.builder()
.alarmMetricName("alarmMetricName")
.build()))
.processName("processName")
.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()))
.netWeaverPrometheusExporter(NetWeaverPrometheusExporterProperty.builder()
.instanceNumbers(List.of("instanceNumbers"))
.sapsid("sapsid")
// the properties below are optional
.prometheusPort("prometheusPort")
.build())
.processes(List.of(ProcessProperty.builder()
.alarmMetrics(List.of(AlarmMetricProperty.builder()
.alarmMetricName("alarmMetricName")
.build()))
.processName("processName")
.build()))
.sqlServerPrometheusExporter(SQLServerPrometheusExporterProperty.builder()
.prometheusPort("prometheusPort")
.sqlSecretName("sqlSecretName")
.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()))
.processes(List.of(ProcessProperty.builder()
.alarmMetrics(List.of(AlarmMetricProperty.builder()
.alarmMetricName("alarmMetricName")
.build()))
.processName("processName")
.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")
.snsNotificationArn("snsNotificationArn")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceTheAWS::ApplicationInsights::Application AlarmMetricproperty type defines a metric to monitor for the component.static interfaceTheAWS::ApplicationInsights::Application Alarmproperty type defines a CloudWatch alarm to be monitored for the component.static final classA fluent builder forCfnApplication.static interfaceTheAWS::ApplicationInsights::Application ComponentConfigurationproperty type defines the configuration settings of the component.static interfaceTheAWS::ApplicationInsights::Application ComponentMonitoringSettingproperty type defines the monitoring setting of the component.static interfaceTheAWS::ApplicationInsights::Application ConfigurationDetailsproperty type specifies the configuration settings.static interfaceTheAWS::ApplicationInsights::Application CustomComponentproperty type describes a custom component by grouping similar standalone instances to monitor.static interfaceTheAWS::ApplicationInsights::Application HAClusterPrometheusExporterproperty type defines the HA cluster Prometheus Exporter settings.static interfaceTheAWS::ApplicationInsights::Application HANAPrometheusExporterproperty type defines the HANA DB Prometheus Exporter settings.static interfaceTheAWS::ApplicationInsights::Application JMXPrometheusExporterproperty type defines the JMXPrometheus Exporter configuration.static interfaceTheAWS::ApplicationInsights::Application LogPatternproperty type specifies an object that defines the log patterns that belong to aLogPatternSet.static interfaceTheAWS::ApplicationInsights::Application LogPatternSetproperty type specifies the log pattern set.static interfaceTheAWS::ApplicationInsights::Application Logproperty type specifies a log to monitor for the component.static interfaceThe NetWeaver Prometheus Exporter Settings.static interfaceA process to be monitored for the component.static interfaceThe SQL prometheus exporter settings.static interfaceTheAWS::ApplicationInsights::Application SubComponentConfigurationDetailsproperty type specifies the configuration settings of the sub-components.static interfaceTheAWS::ApplicationInsights::Application SubComponentTypeConfigurationproperty type specifies the sub-component configurations for a component.static interfaceTheAWS::ApplicationInsights::Application WindowsEventproperty type specifies a Windows Event to monitor for the component.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.applicationinsights.IApplicationRef
IApplicationRef.Jsii$Default, IApplicationRef.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnApplication(software.amazon.jsii.JsiiObjectRef objRef) CfnApplication(software.constructs.Construct scope, String id, CfnApplicationProps props) -
Method Summary
Modifier and TypeMethodDescriptionA reference to a Application resource.If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.Returns the Amazon Resource Name (ARN) of the application, such asarn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group.If set totrue, the application components will be configured with the monitoring configuration recommended by Application Insights.The monitoring settings of the components.Describes a custom component by grouping similar standalone instances to monitor.Indicates whether Application Insights can listen to CloudWatch events for the application resources, such asinstance terminated,failed deployment, and others.Application Insights can create applications based on a resource group or on an account.The log pattern sets.Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.The name of the resource group used for the application.The SNS topic ARN that is associated with SNS notifications for updates or issues.getTags()Tag Manager which manages the tags for this resource.An array ofTags.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.voidIf set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.voidIf set totrue, the application components will be configured with the monitoring configuration recommended by Application Insights.voidIf set totrue, the application components will be configured with the monitoring configuration recommended by Application Insights.voidsetComponentMonitoringSettings(List<Object> value) The monitoring settings of the components.voidThe monitoring settings of the components.voidsetCustomComponents(List<Object> value) Describes a custom component by grouping similar standalone instances to monitor.voidsetCustomComponents(IResolvable value) Describes a custom component by grouping similar standalone instances to monitor.voidsetCweMonitorEnabled(Boolean value) Indicates whether Application Insights can listen to CloudWatch events for the application resources, such asinstance terminated,failed deployment, and others.voidsetCweMonitorEnabled(IResolvable value) Indicates whether Application Insights can listen to CloudWatch events for the application resources, such asinstance terminated,failed deployment, and others.voidsetGroupingType(String value) Application Insights can create applications based on a resource group or on an account.voidsetLogPatternSets(List<Object> value) The log pattern sets.voidsetLogPatternSets(IResolvable value) The log pattern sets.voidsetOpsCenterEnabled(Boolean value) Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.voidsetOpsCenterEnabled(IResolvable value) Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.voidsetOpsItemSnsTopicArn(String value) The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.voidsetResourceGroupName(String value) The name of the resource group used for the application.voidsetSnsNotificationArn(String value) The SNS topic ARN that is associated with SNS notifications for updates or issues.voidsetTagsRaw(List<CfnTag> value) An array ofTags.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnApplication
protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef) -
CfnApplication
protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnApplication
@Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getApplicationRef
A reference to a Application resource.- Specified by:
getApplicationRefin interfaceIApplicationRef
-
getAttrApplicationArn
Returns the Amazon Resource Name (ARN) of the application, such asarn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getResourceGroupName
The name of the resource group used for the application. -
setResourceGroupName
The name of the resource group used for the application. -
getAttachMissingPermission
If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.Returns union: either
BooleanorIResolvable -
setAttachMissingPermission
If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing. -
setAttachMissingPermission
If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing. -
getAutoConfigurationEnabled
If set totrue, the application components will be configured with the monitoring configuration recommended by Application Insights.Returns union: either
BooleanorIResolvable -
setAutoConfigurationEnabled
If set totrue, the application components will be configured with the monitoring configuration recommended by Application Insights. -
setAutoConfigurationEnabled
If set totrue, the application components will be configured with the monitoring configuration recommended by Application Insights. -
getComponentMonitoringSettings
The monitoring settings of the components.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnApplication.ComponentMonitoringSettingProperty> -
setComponentMonitoringSettings
The monitoring settings of the components. -
setComponentMonitoringSettings
The monitoring settings of the components. -
getCustomComponents
Describes a custom component by grouping similar standalone instances to monitor.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnApplication.CustomComponentProperty> -
setCustomComponents
Describes a custom component by grouping similar standalone instances to monitor. -
setCustomComponents
Describes a custom component by grouping similar standalone instances to monitor. -
getCweMonitorEnabled
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such asinstance terminated,failed deployment, and others.Returns union: either
BooleanorIResolvable -
setCweMonitorEnabled
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such asinstance terminated,failed deployment, and others. -
setCweMonitorEnabled
Indicates whether Application Insights can listen to CloudWatch events for the application resources, such asinstance terminated,failed deployment, and others. -
getGroupingType
Application Insights can create applications based on a resource group or on an account. -
setGroupingType
Application Insights can create applications based on a resource group or on an account. -
getLogPatternSets
The log pattern sets.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnApplication.LogPatternSetProperty> -
setLogPatternSets
The log pattern sets. -
setLogPatternSets
The log pattern sets. -
getOpsCenterEnabled
Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.Returns union: either
BooleanorIResolvable -
setOpsCenterEnabled
Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application. -
setOpsCenterEnabled
Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application. -
getOpsItemSnsTopicArn
The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates. -
setOpsItemSnsTopicArn
The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates. -
getSnsNotificationArn
The SNS topic ARN that is associated with SNS notifications for updates or issues. -
setSnsNotificationArn
The SNS topic ARN that is associated with SNS notifications for updates or issues. -
getTagsRaw
An array ofTags. -
setTagsRaw
An array ofTags.
-