CfnApplicationProps

class aws_cdk.aws_applicationinsights.CfnApplicationProps(*, resource_group_name, auto_configuration_enabled=None, component_monitoring_settings=None, custom_components=None, cwe_monitor_enabled=None, grouping_type=None, log_pattern_sets=None, ops_center_enabled=None, ops_item_sns_topic_arn=None, tags=None)

Bases: object

Properties for defining a CfnApplication.

Parameters:
  • resource_group_name (str) – The name of the resource group used for the application.

  • auto_configuration_enabled (Union[bool, IResolvable, None]) – If set to true , the application components will be configured with the monitoring configuration recommended by Application Insights.

  • component_monitoring_settings (Union[IResolvable, Sequence[Union[IResolvable, ComponentMonitoringSettingProperty, Dict[str, Any]]], None]) – The monitoring settings of the components.

  • custom_components (Union[IResolvable, Sequence[Union[IResolvable, CustomComponentProperty, Dict[str, Any]]], None]) – Describes a custom component by grouping similar standalone instances to monitor.

  • cwe_monitor_enabled (Union[bool, IResolvable, None]) – Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated , failed deployment , and others.

  • grouping_type (Optional[str]) – 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 .

  • log_pattern_sets (Union[IResolvable, Sequence[Union[IResolvable, LogPatternSetProperty, Dict[str, Any]]], None]) – The log pattern sets.

  • ops_center_enabled (Union[bool, IResolvable, None]) – Indicates whether Application Insights will create OpsItems for any problem that is detected by Application Insights for an application.

  • ops_item_sns_topic_arn (Optional[str]) – The SNS topic provided to Application Insights that is associated with the created OpsItems to receive SNS notifications for opsItem updates.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of Tags .

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_applicationinsights as applicationinsights

cfn_application_props = applicationinsights.CfnApplicationProps(
    resource_group_name="resourceGroupName",

    # the properties below are optional
    auto_configuration_enabled=False,
    component_monitoring_settings=[applicationinsights.CfnApplication.ComponentMonitoringSettingProperty(
        component_configuration_mode="componentConfigurationMode",
        tier="tier",

        # the properties below are optional
        component_arn="componentArn",
        component_name="componentName",
        custom_component_configuration=applicationinsights.CfnApplication.ComponentConfigurationProperty(
            configuration_details=applicationinsights.CfnApplication.ConfigurationDetailsProperty(
                alarm_metrics=[applicationinsights.CfnApplication.AlarmMetricProperty(
                    alarm_metric_name="alarmMetricName"
                )],
                alarms=[applicationinsights.CfnApplication.AlarmProperty(
                    alarm_name="alarmName",

                    # the properties below are optional
                    severity="severity"
                )],
                ha_cluster_prometheus_exporter=applicationinsights.CfnApplication.HAClusterPrometheusExporterProperty(
                    prometheus_port="prometheusPort"
                ),
                hana_prometheus_exporter=applicationinsights.CfnApplication.HANAPrometheusExporterProperty(
                    agree_to_install_hanadb_client=False,
                    hana_port="hanaPort",
                    hana_secret_name="hanaSecretName",
                    hanasid="hanasid",

                    # the properties below are optional
                    prometheus_port="prometheusPort"
                ),
                jmx_prometheus_exporter=applicationinsights.CfnApplication.JMXPrometheusExporterProperty(
                    host_port="hostPort",
                    jmxurl="jmxurl",
                    prometheus_port="prometheusPort"
                ),
                logs=[applicationinsights.CfnApplication.LogProperty(
                    log_type="logType",

                    # the properties below are optional
                    encoding="encoding",
                    log_group_name="logGroupName",
                    log_path="logPath",
                    pattern_set="patternSet"
                )],
                windows_events=[applicationinsights.CfnApplication.WindowsEventProperty(
                    event_levels=["eventLevels"],
                    event_name="eventName",
                    log_group_name="logGroupName",

                    # the properties below are optional
                    pattern_set="patternSet"
                )]
            ),
            sub_component_type_configurations=[applicationinsights.CfnApplication.SubComponentTypeConfigurationProperty(
                sub_component_configuration_details=applicationinsights.CfnApplication.SubComponentConfigurationDetailsProperty(
                    alarm_metrics=[applicationinsights.CfnApplication.AlarmMetricProperty(
                        alarm_metric_name="alarmMetricName"
                    )],
                    logs=[applicationinsights.CfnApplication.LogProperty(
                        log_type="logType",

                        # the properties below are optional
                        encoding="encoding",
                        log_group_name="logGroupName",
                        log_path="logPath",
                        pattern_set="patternSet"
                    )],
                    windows_events=[applicationinsights.CfnApplication.WindowsEventProperty(
                        event_levels=["eventLevels"],
                        event_name="eventName",
                        log_group_name="logGroupName",

                        # the properties below are optional
                        pattern_set="patternSet"
                    )]
                ),
                sub_component_type="subComponentType"
            )]
        ),
        default_overwrite_component_configuration=applicationinsights.CfnApplication.ComponentConfigurationProperty(
            configuration_details=applicationinsights.CfnApplication.ConfigurationDetailsProperty(
                alarm_metrics=[applicationinsights.CfnApplication.AlarmMetricProperty(
                    alarm_metric_name="alarmMetricName"
                )],
                alarms=[applicationinsights.CfnApplication.AlarmProperty(
                    alarm_name="alarmName",

                    # the properties below are optional
                    severity="severity"
                )],
                ha_cluster_prometheus_exporter=applicationinsights.CfnApplication.HAClusterPrometheusExporterProperty(
                    prometheus_port="prometheusPort"
                ),
                hana_prometheus_exporter=applicationinsights.CfnApplication.HANAPrometheusExporterProperty(
                    agree_to_install_hanadb_client=False,
                    hana_port="hanaPort",
                    hana_secret_name="hanaSecretName",
                    hanasid="hanasid",

                    # the properties below are optional
                    prometheus_port="prometheusPort"
                ),
                jmx_prometheus_exporter=applicationinsights.CfnApplication.JMXPrometheusExporterProperty(
                    host_port="hostPort",
                    jmxurl="jmxurl",
                    prometheus_port="prometheusPort"
                ),
                logs=[applicationinsights.CfnApplication.LogProperty(
                    log_type="logType",

                    # the properties below are optional
                    encoding="encoding",
                    log_group_name="logGroupName",
                    log_path="logPath",
                    pattern_set="patternSet"
                )],
                windows_events=[applicationinsights.CfnApplication.WindowsEventProperty(
                    event_levels=["eventLevels"],
                    event_name="eventName",
                    log_group_name="logGroupName",

                    # the properties below are optional
                    pattern_set="patternSet"
                )]
            ),
            sub_component_type_configurations=[applicationinsights.CfnApplication.SubComponentTypeConfigurationProperty(
                sub_component_configuration_details=applicationinsights.CfnApplication.SubComponentConfigurationDetailsProperty(
                    alarm_metrics=[applicationinsights.CfnApplication.AlarmMetricProperty(
                        alarm_metric_name="alarmMetricName"
                    )],
                    logs=[applicationinsights.CfnApplication.LogProperty(
                        log_type="logType",

                        # the properties below are optional
                        encoding="encoding",
                        log_group_name="logGroupName",
                        log_path="logPath",
                        pattern_set="patternSet"
                    )],
                    windows_events=[applicationinsights.CfnApplication.WindowsEventProperty(
                        event_levels=["eventLevels"],
                        event_name="eventName",
                        log_group_name="logGroupName",

                        # the properties below are optional
                        pattern_set="patternSet"
                    )]
                ),
                sub_component_type="subComponentType"
            )]
        )
    )],
    custom_components=[applicationinsights.CfnApplication.CustomComponentProperty(
        component_name="componentName",
        resource_list=["resourceList"]
    )],
    cwe_monitor_enabled=False,
    grouping_type="groupingType",
    log_pattern_sets=[applicationinsights.CfnApplication.LogPatternSetProperty(
        log_patterns=[applicationinsights.CfnApplication.LogPatternProperty(
            pattern="pattern",
            pattern_name="patternName",
            rank=123
        )],
        pattern_set_name="patternSetName"
    )],
    ops_center_enabled=False,
    ops_item_sns_topic_arn="opsItemSnsTopicArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

auto_configuration_enabled

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

Link:

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

component_monitoring_settings

The monitoring settings of the components.

Link:

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

custom_components

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

Link:

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

cwe_monitor_enabled

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

Link:

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

grouping_type

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 .

Link:

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

log_pattern_sets

The log pattern sets.

Link:

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

ops_center_enabled

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

Link:

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

ops_item_sns_topic_arn

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

Link:

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

resource_group_name

The name of the resource group used for the application.

Link:

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

tags

An array of Tags .

Link:

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