CfnApplication

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.applicationinsights.CfnApplication

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:14.495Z")
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApplicationInsights::Application`.

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
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnApplication.AlarmMetricProperty` The `AWS::ApplicationInsights::Application AlarmMetric` property type defines a metric to monitor for the component.
`static interface`	`CfnApplication.AlarmProperty` The `AWS::ApplicationInsights::Application Alarm` property type defines a CloudWatch alarm to be monitored for the component.
`static class`	`CfnApplication.Builder` A fluent builder for `CfnApplication`.
`static interface`	`CfnApplication.ComponentConfigurationProperty` The `AWS::ApplicationInsights::Application ComponentConfiguration` property type defines the configuration settings of the component.
`static interface`	`CfnApplication.ComponentMonitoringSettingProperty` The `AWS::ApplicationInsights::Application ComponentMonitoringSetting` property type defines the monitoring setting of the component.
`static interface`	`CfnApplication.ConfigurationDetailsProperty` The `AWS::ApplicationInsights::Application ConfigurationDetails` property type specifies the configuration settings.
`static interface`	`CfnApplication.CustomComponentProperty` The `AWS::ApplicationInsights::Application CustomComponent` property type describes a custom component by grouping similar standalone instances to monitor.
`static interface`	`CfnApplication.HAClusterPrometheusExporterProperty` The `AWS::ApplicationInsights::Application HAClusterPrometheusExporter` property type defines the HA cluster Prometheus Exporter settings.
`static interface`	`CfnApplication.HANAPrometheusExporterProperty` The `AWS::ApplicationInsights::Application HANAPrometheusExporter` property type defines the HANA DB Prometheus Exporter settings.
`static interface`	`CfnApplication.JMXPrometheusExporterProperty` The `AWS::ApplicationInsights::Application JMXPrometheusExporter` property type defines the JMXPrometheus Exporter configuration.
`static interface`	`CfnApplication.LogPatternProperty` The `AWS::ApplicationInsights::Application LogPattern` property type specifies an object that defines the log patterns that belong to a `LogPatternSet` .
`static interface`	`CfnApplication.LogPatternSetProperty` The `AWS::ApplicationInsights::Application LogPatternSet` property type specifies the log pattern set.
`static interface`	`CfnApplication.LogProperty` The `AWS::ApplicationInsights::Application Log` property type specifies a log to monitor for the component.
`static interface`	`CfnApplication.SubComponentConfigurationDetailsProperty` The `AWS::ApplicationInsights::Application SubComponentConfigurationDetails` property type specifies the configuration settings of the sub-components.
`static interface`	`CfnApplication.SubComponentTypeConfigurationProperty` The `AWS::ApplicationInsights::Application SubComponentTypeConfiguration` property type specifies the sub-component configurations for a component.
`static interface`	`CfnApplication.WindowsEventProperty` The `AWS::ApplicationInsights::Application WindowsEvent` property type specifies a Windows Event to monitor for the component.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnApplication(Construct scope, java.lang.String id, CfnApplicationProps props)` Create a new `AWS::ApplicationInsights::Application`.
`protected`	`CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrApplicationArn()` Returns the Amazon Resource Name (ARN) of the application, such as `arn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group` .
`java.lang.Object`	`getAutoConfigurationEnabled()` If set to `true` , the application components will be configured with the monitoring configuration recommended by Application Insights.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getComponentMonitoringSettings()` The monitoring settings of the components.
`java.lang.Object`	`getCustomComponents()` Describes a custom component by grouping similar standalone instances to monitor.
`java.lang.Object`	`getCweMonitorEnabled()` Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as `instance terminated` , `failed deployment` , and others.
`java.lang.String`	`getGroupingType()` Application Insights can create applications based on a resource group or on an account.
`java.lang.Object`	`getLogPatternSets()` The log pattern sets.
`java.lang.Object`	`getOpsCenterEnabled()` Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
`java.lang.String`	`getOpsItemSnsTopicArn()` The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.
`java.lang.String`	`getResourceGroupName()` The name of the resource group used for the application.
`TagManager`	`getTags()` An array of `Tags` .
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAutoConfigurationEnabled(java.lang.Boolean value)` If set to `true` , the application components will be configured with the monitoring configuration recommended by Application Insights.
`void`	`setAutoConfigurationEnabled(IResolvable value)` If set to `true` , the application components will be configured with the monitoring configuration recommended by Application Insights.
`void`	`setComponentMonitoringSettings(IResolvable value)` The monitoring settings of the components.
`void`	`setComponentMonitoringSettings(java.util.List<java.lang.Object> value)` The monitoring settings of the components.
`void`	`setCustomComponents(IResolvable value)` Describes a custom component by grouping similar standalone instances to monitor.
`void`	`setCustomComponents(java.util.List<java.lang.Object> value)` Describes a custom component by grouping similar standalone instances to monitor.
`void`	`setCweMonitorEnabled(java.lang.Boolean value)` Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as `instance terminated` , `failed deployment` , and others.
`void`	`setCweMonitorEnabled(IResolvable value)` Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as `instance terminated` , `failed deployment` , and others.
`void`	`setGroupingType(java.lang.String value)` Application Insights can create applications based on a resource group or on an account.
`void`	`setLogPatternSets(IResolvable value)` The log pattern sets.
`void`	`setLogPatternSets(java.util.List<java.lang.Object> value)` The log pattern sets.
`void`	`setOpsCenterEnabled(java.lang.Boolean value)` Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
`void`	`setOpsCenterEnabled(IResolvable value)` Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
`void`	`setOpsItemSnsTopicArn(java.lang.String value)` The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.
`void`	`setResourceGroupName(java.lang.String value)` The name of the resource group used for the application.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnApplication
```
protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnApplication
```
protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnApplication
```
public CfnApplication(Construct scope,
                      java.lang.String id,
                      CfnApplicationProps props)
```
    Create a new `AWS::ApplicationInsights::Application`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrApplicationArn
```
public java.lang.String getAttrApplicationArn()
```
    Returns the Amazon Resource Name (ARN) of the application, such as `arn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An array of `Tags` .
  - getResourceGroupName
```
public java.lang.String getResourceGroupName()
```
    The name of the resource group used for the application.
  - setResourceGroupName
```
public void setResourceGroupName(java.lang.String value)
```
    The name of the resource group used for the application.
  - getAutoConfigurationEnabled
```
public java.lang.Object getAutoConfigurationEnabled()
```
    If set to `true` , the application components will be configured with the monitoring configuration recommended by Application Insights.
  - setAutoConfigurationEnabled
```
public void setAutoConfigurationEnabled(java.lang.Boolean value)
```
    If set to `true` , the application components will be configured with the monitoring configuration recommended by Application Insights.
  - setAutoConfigurationEnabled
```
public void setAutoConfigurationEnabled(IResolvable value)
```
    If set to `true` , the application components will be configured with the monitoring configuration recommended by Application Insights.
  - getComponentMonitoringSettings
```
public java.lang.Object getComponentMonitoringSettings()
```
    The monitoring settings of the components.
  - setComponentMonitoringSettings
```
public void setComponentMonitoringSettings(IResolvable value)
```
    The monitoring settings of the components.
  - setComponentMonitoringSettings
```
public void setComponentMonitoringSettings(java.util.List<java.lang.Object> value)
```
    The monitoring settings of the components.
  - getCustomComponents
```
public java.lang.Object getCustomComponents()
```
    Describes a custom component by grouping similar standalone instances to monitor.
  - setCustomComponents
```
public void setCustomComponents(IResolvable value)
```
    Describes a custom component by grouping similar standalone instances to monitor.
  - setCustomComponents
```
public void setCustomComponents(java.util.List<java.lang.Object> value)
```
    Describes a custom component by grouping similar standalone instances to monitor.
  - getCweMonitorEnabled
```
public java.lang.Object getCweMonitorEnabled()
```
    Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as `instance terminated` , `failed deployment` , and others.
  - setCweMonitorEnabled
```
public void setCweMonitorEnabled(java.lang.Boolean value)
```
    Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as `instance terminated` , `failed deployment` , and others.
  - setCweMonitorEnabled
```
public void setCweMonitorEnabled(IResolvable value)
```
    Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as `instance terminated` , `failed deployment` , and others.
  - getGroupingType
```
public java.lang.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 .
  - setGroupingType
```
public void setGroupingType(java.lang.String value)
```
    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 .
  - getLogPatternSets
```
public java.lang.Object getLogPatternSets()
```
    The log pattern sets.
  - setLogPatternSets
```
public void setLogPatternSets(IResolvable value)
```
    The log pattern sets.
  - setLogPatternSets
```
public void setLogPatternSets(java.util.List<java.lang.Object> value)
```
    The log pattern sets.
  - getOpsCenterEnabled
```
public java.lang.Object getOpsCenterEnabled()
```
    Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
  - setOpsCenterEnabled
```
public void setOpsCenterEnabled(java.lang.Boolean value)
```
    Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
  - setOpsCenterEnabled
```
public void setOpsCenterEnabled(IResolvable value)
```
    Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
  - getOpsItemSnsTopicArn
```
public java.lang.String getOpsItemSnsTopicArn()
```
    The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.
  - setOpsItemSnsTopicArn
```
public void setOpsItemSnsTopicArn(java.lang.String value)
```
    The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.

Class CfnApplication

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnApplication

CfnApplication

CfnApplication

Method Detail

inspect

renderProperties

getAttrApplicationArn

getCfnProperties

getTags

getResourceGroupName

setResourceGroupName

getAutoConfigurationEnabled

setAutoConfigurationEnabled

setAutoConfigurationEnabled

getComponentMonitoringSettings

setComponentMonitoringSettings

setComponentMonitoringSettings

getCustomComponents

setCustomComponents

setCustomComponents

getCweMonitorEnabled

setCweMonitorEnabled

setCweMonitorEnabled

getGroupingType

setGroupingType

getLogPatternSets

setLogPatternSets

setLogPatternSets

getOpsCenterEnabled

setOpsCenterEnabled

setOpsCenterEnabled

getOpsItemSnsTopicArn

setOpsItemSnsTopicArn