CfnApplication

class aws_cdk.aws_applicationinsights.CfnApplication(scope, id, *, resource_group_name, attach_missing_permission=None, 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: CfnResource

The AWS::ApplicationInsights::Application resource adds an application that is created from a resource group.

See:

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

CloudformationResource:

AWS::ApplicationInsights::Application

ExampleMetadata:

fixture=_generated

Example:

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

cfn_application = applicationinsights.CfnApplication(self, "MyCfnApplication",
    resource_group_name="resourceGroupName",

    # the properties below are optional
    attach_missing_permission=False,
    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"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

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

  • attach_missing_permission (Union[bool, IResolvable, None]) – If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.

  • 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 .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ApplicationInsights::Application'
attach_missing_permission

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

attr_application_arn

Returns the Amazon Resource Name (ARN) of the application, such as arn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/my_resource_group .

CloudformationAttribute:

ApplicationARN

auto_configuration_enabled

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

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

component_monitoring_settings

The monitoring settings of the components.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

custom_components

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

cwe_monitor_enabled

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

grouping_type

Application Insights can create applications based on a resource group or on an account.

log_pattern_sets

The log pattern sets.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ops_center_enabled

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

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.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

resource_group_name

The name of the resource group used for the application.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

An array of Tags .

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AlarmMetricProperty

class CfnApplication.AlarmMetricProperty(*, alarm_metric_name)

Bases: object

The AWS::ApplicationInsights::Application AlarmMetric property type defines a metric to monitor for the component.

Parameters:

alarm_metric_name (str) – The name of the metric to be monitored for the component. For metrics supported by Application Insights, see Logs and metrics supported by Amazon CloudWatch Application Insights .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

alarm_metric_property = applicationinsights.CfnApplication.AlarmMetricProperty(
    alarm_metric_name="alarmMetricName"
)

Attributes

alarm_metric_name

The name of the metric to be monitored for the component.

For metrics supported by Application Insights, see Logs and metrics supported by Amazon CloudWatch Application Insights .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-alarmmetric.html#cfn-applicationinsights-application-alarmmetric-alarmmetricname

AlarmProperty

class CfnApplication.AlarmProperty(*, alarm_name, severity=None)

Bases: object

The AWS::ApplicationInsights::Application Alarm property type defines a CloudWatch alarm to be monitored for the component.

Parameters:

  • alarm_name (str) – The name of the CloudWatch alarm to be monitored for the component.

  • severity (Optional[str]) – Indicates the degree of outage when the alarm goes off.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

alarm_property = applicationinsights.CfnApplication.AlarmProperty(
    alarm_name="alarmName",

    # the properties below are optional
    severity="severity"
)

Attributes

alarm_name

The name of the CloudWatch alarm to be monitored for the component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-alarm.html#cfn-applicationinsights-application-alarm-alarmname

severity

Indicates the degree of outage when the alarm goes off.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-alarm.html#cfn-applicationinsights-application-alarm-severity

ComponentConfigurationProperty

class CfnApplication.ComponentConfigurationProperty(*, configuration_details=None, sub_component_type_configurations=None)

Bases: object

The AWS::ApplicationInsights::Application ComponentConfiguration property type defines the configuration settings of the component.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

component_configuration_property = 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"
    )]
)

Attributes

configuration_details

The configuration settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentconfiguration.html#cfn-applicationinsights-application-componentconfiguration-configurationdetails

sub_component_type_configurations

Sub-component configurations of the component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentconfiguration.html#cfn-applicationinsights-application-componentconfiguration-subcomponenttypeconfigurations

ComponentMonitoringSettingProperty

class CfnApplication.ComponentMonitoringSettingProperty(*, component_configuration_mode, tier, component_arn=None, component_name=None, custom_component_configuration=None, default_overwrite_component_configuration=None)

Bases: object

The AWS::ApplicationInsights::Application ComponentMonitoringSetting property type defines the monitoring setting of the component.

Parameters:

  • component_configuration_mode (str) – Component monitoring can be configured in one of the following three modes:. - DEFAULT : The component will be configured with the recommended default monitoring settings of the selected Tier . - CUSTOM : The component will be configured with the customized monitoring settings that are specified in CustomComponentConfiguration . If used, CustomComponentConfiguration must be provided. - DEFAULT_WITH_OVERWRITE : The component will be configured with the recommended default monitoring settings of the selected Tier , and merged with customized overwrite settings that are specified in DefaultOverwriteComponentConfiguration . If used, DefaultOverwriteComponentConfiguration must be provided.

  • tier (str) – The tier of the application component. Supported tiers include DOT_NET_CORE , DOT_NET_WORKER , DOT_NET_WEB , SQL_SERVER , SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP , SQL_SERVER_FAILOVER_CLUSTER_INSTANCE , MYSQL , POSTGRESQL , JAVA_JMX , ORACLE , SAP_HANA_MULTI_NODE , SAP_HANA_SINGLE_NODE , SAP_HANA_HIGH_AVAILABILITY , SHAREPOINT . ACTIVE_DIRECTORY , and DEFAULT .

  • component_arn (Optional[str]) – The ARN of the component.

  • component_name (Optional[str]) – The name of the component.

  • custom_component_configuration (Union[IResolvable, ComponentConfigurationProperty, Dict[str, Any], None]) – Customized monitoring settings. Required if CUSTOM mode is configured in ComponentConfigurationMode .

  • default_overwrite_component_configuration (Union[IResolvable, ComponentConfigurationProperty, Dict[str, Any], None]) – Customized overwrite monitoring settings. Required if CUSTOM mode is configured in ComponentConfigurationMode .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

component_monitoring_setting_property = 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"
        )]
    )
)

Attributes

component_arn

The ARN of the component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentarn

component_configuration_mode

.

  • DEFAULT : The component will be configured with the recommended default monitoring settings of the selected Tier .

  • CUSTOM : The component will be configured with the customized monitoring settings that are specified in CustomComponentConfiguration . If used, CustomComponentConfiguration must be provided.

  • DEFAULT_WITH_OVERWRITE : The component will be configured with the recommended default monitoring settings of the selected Tier , and merged with customized overwrite settings that are specified in DefaultOverwriteComponentConfiguration . If used, DefaultOverwriteComponentConfiguration must be provided.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentconfigurationmode

Type:

Component monitoring can be configured in one of the following three modes

component_name

The name of the component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-componentname

custom_component_configuration

Customized monitoring settings.

Required if CUSTOM mode is configured in ComponentConfigurationMode .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-customcomponentconfiguration

default_overwrite_component_configuration

Customized overwrite monitoring settings.

Required if CUSTOM mode is configured in ComponentConfigurationMode .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-defaultoverwritecomponentconfiguration

tier

The tier of the application component.

Supported tiers include DOT_NET_CORE , DOT_NET_WORKER , DOT_NET_WEB , SQL_SERVER , SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP , SQL_SERVER_FAILOVER_CLUSTER_INSTANCE , MYSQL , POSTGRESQL , JAVA_JMX , ORACLE , SAP_HANA_MULTI_NODE , SAP_HANA_SINGLE_NODE , SAP_HANA_HIGH_AVAILABILITY , SHAREPOINT . ACTIVE_DIRECTORY , and DEFAULT .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-componentmonitoringsetting.html#cfn-applicationinsights-application-componentmonitoringsetting-tier

ConfigurationDetailsProperty

class CfnApplication.ConfigurationDetailsProperty(*, alarm_metrics=None, alarms=None, ha_cluster_prometheus_exporter=None, hana_prometheus_exporter=None, jmx_prometheus_exporter=None, logs=None, windows_events=None)

Bases: object

The AWS::ApplicationInsights::Application ConfigurationDetails property type specifies the configuration settings.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

configuration_details_property = 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"
    )]
)

Attributes

alarm_metrics

A list of metrics to monitor for the component.

All component types can use AlarmMetrics .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-alarmmetrics

alarms

A list of alarms to monitor for the component.

All component types can use Alarm .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-alarms

ha_cluster_prometheus_exporter

The HA cluster Prometheus Exporter settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-haclusterprometheusexporter

hana_prometheus_exporter

The HANA DB Prometheus Exporter settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-hanaprometheusexporter

jmx_prometheus_exporter

A list of Java metrics to monitor for the component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-jmxprometheusexporter

logs

A list of logs to monitor for the component.

Only Amazon EC2 instances can use Logs .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-logs

windows_events

A list of Windows Events to monitor for the component.

Only Amazon EC2 instances running on Windows can use WindowsEvents .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-configurationdetails.html#cfn-applicationinsights-application-configurationdetails-windowsevents

CustomComponentProperty

class CfnApplication.CustomComponentProperty(*, component_name, resource_list)

Bases: object

The AWS::ApplicationInsights::Application CustomComponent property type describes a custom component by grouping similar standalone instances to monitor.

Parameters:

  • component_name (str) – The name of the component.

  • resource_list (Sequence[str]) – The list of resource ARNs that belong to the component.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

custom_component_property = applicationinsights.CfnApplication.CustomComponentProperty(
    component_name="componentName",
    resource_list=["resourceList"]
)

Attributes

component_name

The name of the component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-customcomponent.html#cfn-applicationinsights-application-customcomponent-componentname

resource_list

The list of resource ARNs that belong to the component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-customcomponent.html#cfn-applicationinsights-application-customcomponent-resourcelist

HAClusterPrometheusExporterProperty

class CfnApplication.HAClusterPrometheusExporterProperty(*, prometheus_port=None)

Bases: object

The AWS::ApplicationInsights::Application HAClusterPrometheusExporter property type defines the HA cluster Prometheus Exporter settings.

For more information, see the component configuration in the CloudWatch Application Insights documentation.

Parameters:

prometheus_port (Optional[str]) – The target port to which Prometheus sends metrics. If not specified, the default port 9668 is used.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

h_aCluster_prometheus_exporter_property = applicationinsights.CfnApplication.HAClusterPrometheusExporterProperty(
    prometheus_port="prometheusPort"
)

Attributes

prometheus_port

The target port to which Prometheus sends metrics.

If not specified, the default port 9668 is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-haclusterprometheusexporter.html#cfn-applicationinsights-application-haclusterprometheusexporter-prometheusport

HANAPrometheusExporterProperty

class CfnApplication.HANAPrometheusExporterProperty(*, agree_to_install_hanadb_client, hana_port, hana_secret_name, hanasid, prometheus_port=None)

Bases: object

The AWS::ApplicationInsights::Application HANAPrometheusExporter property type defines the HANA DB Prometheus Exporter settings.

For more information, see the component configuration in the CloudWatch Application Insights documentation.

Parameters:

  • agree_to_install_hanadb_client (Union[bool, IResolvable]) – Designates whether you agree to install the HANA DB client.

  • hana_port (str) – The HANA database port by which the exporter will query HANA metrics.

  • hana_secret_name (str) – The AWS Secrets Manager secret that stores HANA monitoring user credentials. The HANA Prometheus exporter uses these credentials to connect to the database and query HANA metrics.

  • hanasid (str) – The three-character SAP system ID (SID) of the SAP HANA system.

  • prometheus_port (Optional[str]) – The target port to which Prometheus sends metrics. If not specified, the default port 9668 is used.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

h_aNAPrometheus_exporter_property = 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"
)

Attributes

agree_to_install_hanadb_client

Designates whether you agree to install the HANA DB client.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-agreetoinstallhanadbclient

hana_port

The HANA database port by which the exporter will query HANA metrics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-hanaport

hana_secret_name

The AWS Secrets Manager secret that stores HANA monitoring user credentials.

The HANA Prometheus exporter uses these credentials to connect to the database and query HANA metrics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-hanasecretname

hanasid

The three-character SAP system ID (SID) of the SAP HANA system.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-hanasid

prometheus_port

The target port to which Prometheus sends metrics.

If not specified, the default port 9668 is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-hanaprometheusexporter.html#cfn-applicationinsights-application-hanaprometheusexporter-prometheusport

JMXPrometheusExporterProperty

class CfnApplication.JMXPrometheusExporterProperty(*, host_port=None, jmxurl=None, prometheus_port=None)

Bases: object

The AWS::ApplicationInsights::Application JMXPrometheusExporter property type defines the JMXPrometheus Exporter configuration.

For more information, see the component configuration in the CloudWatch Application Insights documentation.

Parameters:

  • host_port (Optional[str]) – The host and port to connect to through remote JMX. Only one of jmxURL and hostPort can be specified.

  • jmxurl (Optional[str]) – The complete JMX URL to connect to.

  • prometheus_port (Optional[str]) – The target port to send Prometheus metrics to. If not specified, the default port 9404 is used.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

j_mXPrometheus_exporter_property = applicationinsights.CfnApplication.JMXPrometheusExporterProperty(
    host_port="hostPort",
    jmxurl="jmxurl",
    prometheus_port="prometheusPort"
)

Attributes

host_port

The host and port to connect to through remote JMX.

Only one of jmxURL and hostPort can be specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-jmxprometheusexporter.html#cfn-applicationinsights-application-jmxprometheusexporter-hostport

jmxurl

The complete JMX URL to connect to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-jmxprometheusexporter.html#cfn-applicationinsights-application-jmxprometheusexporter-jmxurl

prometheus_port

The target port to send Prometheus metrics to.

If not specified, the default port 9404 is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-jmxprometheusexporter.html#cfn-applicationinsights-application-jmxprometheusexporter-prometheusport

LogPatternProperty

class CfnApplication.LogPatternProperty(*, pattern, pattern_name, rank)

Bases: object

The AWS::ApplicationInsights::Application LogPattern property type specifies an object that defines the log patterns that belong to a LogPatternSet .

Parameters:

  • pattern (str) – A regular expression that defines the log pattern. A log pattern can contain up to 50 characters, and it cannot be empty.

  • pattern_name (str) – The name of the log pattern. A log pattern name can contain up to 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

  • rank (Union[int, float]) – The rank of the log pattern.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

log_pattern_property = applicationinsights.CfnApplication.LogPatternProperty(
    pattern="pattern",
    pattern_name="patternName",
    rank=123
)

Attributes

pattern

A regular expression that defines the log pattern.

A log pattern can contain up to 50 characters, and it cannot be empty.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpattern.html#cfn-applicationinsights-application-logpattern-pattern

pattern_name

The name of the log pattern.

A log pattern name can contain up to 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpattern.html#cfn-applicationinsights-application-logpattern-patternname

rank

The rank of the log pattern.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpattern.html#cfn-applicationinsights-application-logpattern-rank

LogPatternSetProperty

class CfnApplication.LogPatternSetProperty(*, log_patterns, pattern_set_name)

Bases: object

The AWS::ApplicationInsights::Application LogPatternSet property type specifies the log pattern set.

Parameters:

  • log_patterns (Union[IResolvable, Sequence[Union[IResolvable, LogPatternProperty, Dict[str, Any]]]]) – A list of objects that define the log patterns that belong to LogPatternSet .

  • pattern_set_name (str) – The name of the log pattern. A log pattern name can contain up to 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

log_pattern_set_property = applicationinsights.CfnApplication.LogPatternSetProperty(
    log_patterns=[applicationinsights.CfnApplication.LogPatternProperty(
        pattern="pattern",
        pattern_name="patternName",
        rank=123
    )],
    pattern_set_name="patternSetName"
)

Attributes

log_patterns

A list of objects that define the log patterns that belong to LogPatternSet .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpatternset.html#cfn-applicationinsights-application-logpatternset-logpatterns

pattern_set_name

The name of the log pattern.

A log pattern name can contain up to 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-logpatternset.html#cfn-applicationinsights-application-logpatternset-patternsetname

LogProperty

class CfnApplication.LogProperty(*, log_type, encoding=None, log_group_name=None, log_path=None, pattern_set=None)

Bases: object

The AWS::ApplicationInsights::Application Log property type specifies a log to monitor for the component.

Parameters:

  • log_type (str) – The log type decides the log patterns against which Application Insights analyzes the log. The log type is selected from the following: SQL_SERVER , MYSQL , MYSQL_SLOW_QUERY , POSTGRESQL , ORACLE_ALERT , ORACLE_LISTENER , IIS , APPLICATION , WINDOWS_EVENTS , WINDOWS_EVENTS_ACTIVE_DIRECTORY , WINDOWS_EVENTS_DNS , WINDOWS_EVENTS_IIS , WINDOWS_EVENTS_SHAREPOINT , SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP , SQL_SERVER_FAILOVER_CLUSTER_INSTANCE , STEP_FUNCTION , API_GATEWAY_ACCESS , API_GATEWAY_EXECUTION , SAP_HANA_LOGS , SAP_HANA_TRACE , SAP_HANA_HIGH_AVAILABILITY , and DEFAULT .

  • encoding (Optional[str]) – The type of encoding of the logs to be monitored. The specified encoding should be included in the list of CloudWatch agent supported encodings. If not provided, CloudWatch Application Insights uses the default encoding type for the log type: - APPLICATION/DEFAULT : utf-8 encoding - SQL_SERVER : utf-16 encoding - IIS : ascii encoding

  • log_group_name (Optional[str]) – The CloudWatch log group name to be associated with the monitored log.

  • log_path (Optional[str]) – The path of the logs to be monitored. The log path must be an absolute Windows or Linux system file path. For more information, see CloudWatch Agent Configuration File: Logs Section .

  • pattern_set (Optional[str]) – The log pattern set.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

log_property = applicationinsights.CfnApplication.LogProperty(
    log_type="logType",

    # the properties below are optional
    encoding="encoding",
    log_group_name="logGroupName",
    log_path="logPath",
    pattern_set="patternSet"
)

Attributes

encoding

The type of encoding of the logs to be monitored.

The specified encoding should be included in the list of CloudWatch agent supported encodings. If not provided, CloudWatch Application Insights uses the default encoding type for the log type:

  • APPLICATION/DEFAULT : utf-8 encoding

  • SQL_SERVER : utf-16 encoding

  • IIS : ascii encoding

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-encoding

log_group_name

The CloudWatch log group name to be associated with the monitored log.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-loggroupname

log_path

The path of the logs to be monitored.

The log path must be an absolute Windows or Linux system file path. For more information, see CloudWatch Agent Configuration File: Logs Section .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-logpath

log_type

The log type decides the log patterns against which Application Insights analyzes the log.

The log type is selected from the following: SQL_SERVER , MYSQL , MYSQL_SLOW_QUERY , POSTGRESQL , ORACLE_ALERT , ORACLE_LISTENER , IIS , APPLICATION , WINDOWS_EVENTS , WINDOWS_EVENTS_ACTIVE_DIRECTORY , WINDOWS_EVENTS_DNS , WINDOWS_EVENTS_IIS , WINDOWS_EVENTS_SHAREPOINT , SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP , SQL_SERVER_FAILOVER_CLUSTER_INSTANCE , STEP_FUNCTION , API_GATEWAY_ACCESS , API_GATEWAY_EXECUTION , SAP_HANA_LOGS , SAP_HANA_TRACE , SAP_HANA_HIGH_AVAILABILITY , and DEFAULT .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-logtype

pattern_set

The log pattern set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-log.html#cfn-applicationinsights-application-log-patternset

SubComponentConfigurationDetailsProperty

class CfnApplication.SubComponentConfigurationDetailsProperty(*, alarm_metrics=None, logs=None, windows_events=None)

Bases: object

The AWS::ApplicationInsights::Application SubComponentConfigurationDetails property type specifies the configuration settings of the sub-components.

Parameters:

  • alarm_metrics (Union[IResolvable, Sequence[Union[IResolvable, AlarmMetricProperty, Dict[str, Any]]], None]) – A list of metrics to monitor for the component. All component types can use AlarmMetrics .

  • logs (Union[IResolvable, Sequence[Union[IResolvable, LogProperty, Dict[str, Any]]], None]) – A list of logs to monitor for the component. Only Amazon EC2 instances can use Logs .

  • windows_events (Union[IResolvable, Sequence[Union[IResolvable, WindowsEventProperty, Dict[str, Any]]], None]) – A list of Windows Events to monitor for the component. Only Amazon EC2 instances running on Windows can use WindowsEvents .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

sub_component_configuration_details_property = 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"
    )]
)

Attributes

alarm_metrics

A list of metrics to monitor for the component.

All component types can use AlarmMetrics .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html#cfn-applicationinsights-application-subcomponentconfigurationdetails-alarmmetrics

logs

A list of logs to monitor for the component.

Only Amazon EC2 instances can use Logs .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html#cfn-applicationinsights-application-subcomponentconfigurationdetails-logs

windows_events

A list of Windows Events to monitor for the component.

Only Amazon EC2 instances running on Windows can use WindowsEvents .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponentconfigurationdetails.html#cfn-applicationinsights-application-subcomponentconfigurationdetails-windowsevents

SubComponentTypeConfigurationProperty

class CfnApplication.SubComponentTypeConfigurationProperty(*, sub_component_configuration_details, sub_component_type)

Bases: object

The AWS::ApplicationInsights::Application SubComponentTypeConfiguration property type specifies the sub-component configurations for a component.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

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

sub_component_type_configuration_property = 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"
)

Attributes

sub_component_configuration_details

The configuration settings of the sub-components.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponenttypeconfiguration.html#cfn-applicationinsights-application-subcomponenttypeconfiguration-subcomponentconfigurationdetails

sub_component_type

The sub-component type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-subcomponenttypeconfiguration.html#cfn-applicationinsights-application-subcomponenttypeconfiguration-subcomponenttype

WindowsEventProperty

class CfnApplication.WindowsEventProperty(*, event_levels, event_name, log_group_name, pattern_set=None)

Bases: object

The AWS::ApplicationInsights::Application WindowsEvent property type specifies a Windows Event to monitor for the component.

Parameters:

  • event_levels (Sequence[str]) – The levels of event to log. You must specify each level to log. Possible values include INFORMATION , WARNING , ERROR , CRITICAL , and VERBOSE . This field is required for each type of Windows Event to log.

  • event_name (str) – The type of Windows Events to log, equivalent to the Windows Event log channel name. For example, System, Security, CustomEventName, and so on. This field is required for each type of Windows event to log.

  • log_group_name (str) – The CloudWatch log group name to be associated with the monitored log.

  • pattern_set (Optional[str]) – The log pattern set.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

windows_event_property = applicationinsights.CfnApplication.WindowsEventProperty(
    event_levels=["eventLevels"],
    event_name="eventName",
    log_group_name="logGroupName",

    # the properties below are optional
    pattern_set="patternSet"
)

Attributes

event_levels

The levels of event to log.

You must specify each level to log. Possible values include INFORMATION , WARNING , ERROR , CRITICAL , and VERBOSE . This field is required for each type of Windows Event to log.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html#cfn-applicationinsights-application-windowsevent-eventlevels

event_name

The type of Windows Events to log, equivalent to the Windows Event log channel name.

For example, System, Security, CustomEventName, and so on. This field is required for each type of Windows event to log.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html#cfn-applicationinsights-application-windowsevent-eventname

log_group_name

The CloudWatch log group name to be associated with the monitored log.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html#cfn-applicationinsights-application-windowsevent-loggroupname

pattern_set

The log pattern set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationinsights-application-windowsevent.html#cfn-applicationinsights-application-windowsevent-patternset