Package software.amazon.awscdk.services.applicationinsights

Class CfnApplication

java.lang.Object

software.amazon.jsii.JsiiObject

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.645Z")
@Stability(Stable)
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	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 final 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnApplication(Construct scope, 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

Modifier and Type	Method	Description
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 .
Object	getAutoConfigurationEnabled()	If set to true , the application components will be configured with the monitoring configuration recommended by Application Insights.
protected Map<String,Object>	getCfnProperties()
Object	getComponentMonitoringSettings()	The monitoring settings of the components.
Object	getCustomComponents()	Describes a custom component by grouping similar standalone instances to monitor.
Object	getCweMonitorEnabled()	Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.
String	getGroupingType()	Application Insights can create applications based on a resource group or on an account.
Object	getLogPatternSets()	The log pattern sets.
Object	getOpsCenterEnabled()	Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.
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.
TagManager	getTags()	An array of Tags .
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoConfigurationEnabled(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(List<Object> value)	The monitoring settings of the components.
void	setComponentMonitoringSettings(IResolvable value)	The monitoring settings of the components.
void	setCustomComponents(List<Object> value)	Describes a custom component by grouping similar standalone instances to monitor.
void	setCustomComponents(IResolvable value)	Describes a custom component by grouping similar standalone instances to monitor.
void	setCweMonitorEnabled(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(String value)	Application Insights can create applications based on a resource group or on an account.
void	setLogPatternSets(List<Object> value)	The log pattern sets.
void	setLogPatternSets(IResolvable value)	The log pattern sets.
void	setOpsCenterEnabled(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(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(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 software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String 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
 Construct scope,
 @NotNull
 String id,
 @NotNull
 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 Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 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

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApplicationArn

@Stability(Stable)
@NotNull
public 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

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

An array of Tags .

getResourceGroupName

@Stability(Stable)
@NotNull
public String getResourceGroupName()

The name of the resource group used for the application.

setResourceGroupName

@Stability(Stable)
public void setResourceGroupName(@NotNull
 String value)

The name of the resource group used for the application.

getAutoConfigurationEnabled

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

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

setAutoConfigurationEnabled

@Stability(Stable)
public void setAutoConfigurationEnabled(@Nullable
 Boolean value)

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

setAutoConfigurationEnabled

@Stability(Stable)
public void setAutoConfigurationEnabled(@Nullable
 IResolvable value)

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

getComponentMonitoringSettings

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

The monitoring settings of the components.

setComponentMonitoringSettings

@Stability(Stable)
public void setComponentMonitoringSettings(@Nullable
 IResolvable value)

The monitoring settings of the components.

setComponentMonitoringSettings

@Stability(Stable)
public void setComponentMonitoringSettings(@Nullable
 List<Object> value)

The monitoring settings of the components.

getCustomComponents

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

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

setCustomComponents

@Stability(Stable)
public void setCustomComponents(@Nullable
 IResolvable value)

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

setCustomComponents

@Stability(Stable)
public void setCustomComponents(@Nullable
 List<Object> value)

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

getCweMonitorEnabled

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

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

setCweMonitorEnabled

@Stability(Stable)
public void setCweMonitorEnabled(@Nullable
 Boolean value)

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

setCweMonitorEnabled

@Stability(Stable)
public void setCweMonitorEnabled(@Nullable
 IResolvable value)

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

getGroupingType

@Stability(Stable)
@Nullable
public 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

@Stability(Stable)
public void setGroupingType(@Nullable
 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

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

The log pattern sets.

setLogPatternSets

@Stability(Stable)
public void setLogPatternSets(@Nullable
 IResolvable value)

The log pattern sets.

setLogPatternSets

@Stability(Stable)
public void setLogPatternSets(@Nullable
 List<Object> value)

The log pattern sets.

getOpsCenterEnabled

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

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

setOpsCenterEnabled

@Stability(Stable)
public void setOpsCenterEnabled(@Nullable
 Boolean value)

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

setOpsCenterEnabled

@Stability(Stable)
public void setOpsCenterEnabled(@Nullable
 IResolvable value)

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

getOpsItemSnsTopicArn

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

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

setOpsItemSnsTopicArn

@Stability(Stable)
public void setOpsItemSnsTopicArn(@Nullable
 String value)

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