Skip to content
v2.278.0

ConfigurationDetailsProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_applicationinsights as applicationinsights } from 'aws-cdk-lib';
const configurationDetailsProperty: applicationinsights.CfnApplication.ConfigurationDetailsProperty = {
  alarmMetrics: [{
    alarmMetricName: 'alarmMetricName',
  }],
  alarms: [{
    alarmName: 'alarmName',

    // the properties below are optional
    severity: 'severity',
  }],
  haClusterPrometheusExporter: {
    prometheusPort: 'prometheusPort',
  },
  hanaPrometheusExporter: {
    agreeToInstallHanadbClient: false,
    hanaPort: 'hanaPort',
    hanaSecretName: 'hanaSecretName',
    hanasid: 'hanasid',

    // the properties below are optional
    prometheusPort: 'prometheusPort',
  },
  jmxPrometheusExporter: {
    hostPort: 'hostPort',
    jmxurl: 'jmxurl',
    prometheusPort: 'prometheusPort',
  },
  logs: [{
    logType: 'logType',

    // the properties below are optional
    encoding: 'encoding',
    logGroupName: 'logGroupName',
    logPath: 'logPath',
    patternSet: 'patternSet',
  }],
  netWeaverPrometheusExporter: {
    instanceNumbers: ['instanceNumbers'],
    sapsid: 'sapsid',

    // the properties below are optional
    prometheusPort: 'prometheusPort',
  },
  processes: [{
    alarmMetrics: [{
      alarmMetricName: 'alarmMetricName',
    }],
    processName: 'processName',
  }],
  sqlServerPrometheusExporter: {
    prometheusPort: 'prometheusPort',
    sqlSecretName: 'sqlSecretName',
  },
  windowsEvents: [{
    eventLevels: ['eventLevels'],
    eventName: 'eventName',
    logGroupName: 'logGroupName',

    // the properties below are optional
    patternSet: 'patternSet',
  }],
};
python
# 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"
    )],
    net_weaver_prometheus_exporter=applicationinsights.CfnApplication.NetWeaverPrometheusExporterProperty(
        instance_numbers=["instanceNumbers"],
        sapsid="sapsid",

        # the properties below are optional
        prometheus_port="prometheusPort"
    ),
    processes=[applicationinsights.CfnApplication.ProcessProperty(
        alarm_metrics=[applicationinsights.CfnApplication.AlarmMetricProperty(
            alarm_metric_name="alarmMetricName"
        )],
        process_name="processName"
    )],
    sql_server_prometheus_exporter=applicationinsights.CfnApplication.SQLServerPrometheusExporterProperty(
        prometheus_port="prometheusPort",
        sql_secret_name="sqlSecretName"
    ),
    windows_events=[applicationinsights.CfnApplication.WindowsEventProperty(
        event_levels=["eventLevels"],
        event_name="eventName",
        log_group_name="logGroupName",

        # the properties below are optional
        pattern_set="patternSet"
    )]
)
java
// 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.*;

ConfigurationDetailsProperty configurationDetailsProperty = ConfigurationDetailsProperty.builder()
        .alarmMetrics(List.of(AlarmMetricProperty.builder()
                .alarmMetricName("alarmMetricName")
                .build()))
        .alarms(List.of(AlarmProperty.builder()
                .alarmName("alarmName")

                // the properties below are optional
                .severity("severity")
                .build()))
        .haClusterPrometheusExporter(HAClusterPrometheusExporterProperty.builder()
                .prometheusPort("prometheusPort")
                .build())
        .hanaPrometheusExporter(HANAPrometheusExporterProperty.builder()
                .agreeToInstallHanadbClient(false)
                .hanaPort("hanaPort")
                .hanaSecretName("hanaSecretName")
                .hanasid("hanasid")

                // the properties below are optional
                .prometheusPort("prometheusPort")
                .build())
        .jmxPrometheusExporter(JMXPrometheusExporterProperty.builder()
                .hostPort("hostPort")
                .jmxurl("jmxurl")
                .prometheusPort("prometheusPort")
                .build())
        .logs(List.of(LogProperty.builder()
                .logType("logType")

                // the properties below are optional
                .encoding("encoding")
                .logGroupName("logGroupName")
                .logPath("logPath")
                .patternSet("patternSet")
                .build()))
        .netWeaverPrometheusExporter(NetWeaverPrometheusExporterProperty.builder()
                .instanceNumbers(List.of("instanceNumbers"))
                .sapsid("sapsid")

                // the properties below are optional
                .prometheusPort("prometheusPort")
                .build())
        .processes(List.of(ProcessProperty.builder()
                .alarmMetrics(List.of(AlarmMetricProperty.builder()
                        .alarmMetricName("alarmMetricName")
                        .build()))
                .processName("processName")
                .build()))
        .sqlServerPrometheusExporter(SQLServerPrometheusExporterProperty.builder()
                .prometheusPort("prometheusPort")
                .sqlSecretName("sqlSecretName")
                .build())
        .windowsEvents(List.of(WindowsEventProperty.builder()
                .eventLevels(List.of("eventLevels"))
                .eventName("eventName")
                .logGroupName("logGroupName")

                // the properties below are optional
                .patternSet("patternSet")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ApplicationInsights;

var configurationDetailsProperty = new ConfigurationDetailsProperty {
    AlarmMetrics = new [] { new AlarmMetricProperty {
        AlarmMetricName = "alarmMetricName"
    } },
    Alarms = new [] { new AlarmProperty {
        AlarmName = "alarmName",

        // the properties below are optional
        Severity = "severity"
    } },
    HaClusterPrometheusExporter = new HAClusterPrometheusExporterProperty {
        PrometheusPort = "prometheusPort"
    },
    HanaPrometheusExporter = new HANAPrometheusExporterProperty {
        AgreeToInstallHanadbClient = false,
        HanaPort = "hanaPort",
        HanaSecretName = "hanaSecretName",
        Hanasid = "hanasid",

        // the properties below are optional
        PrometheusPort = "prometheusPort"
    },
    JmxPrometheusExporter = new JMXPrometheusExporterProperty {
        HostPort = "hostPort",
        Jmxurl = "jmxurl",
        PrometheusPort = "prometheusPort"
    },
    Logs = new [] { new LogProperty {
        LogType = "logType",

        // the properties below are optional
        Encoding = "encoding",
        LogGroupName = "logGroupName",
        LogPath = "logPath",
        PatternSet = "patternSet"
    } },
    NetWeaverPrometheusExporter = new NetWeaverPrometheusExporterProperty {
        InstanceNumbers = new [] { "instanceNumbers" },
        Sapsid = "sapsid",

        // the properties below are optional
        PrometheusPort = "prometheusPort"
    },
    Processes = new [] { new ProcessProperty {
        AlarmMetrics = new [] { new AlarmMetricProperty {
            AlarmMetricName = "alarmMetricName"
        } },
        ProcessName = "processName"
    } },
    SqlServerPrometheusExporter = new SQLServerPrometheusExporterProperty {
        PrometheusPort = "prometheusPort",
        SqlSecretName = "sqlSecretName"
    },
    WindowsEvents = new [] { new WindowsEventProperty {
        EventLevels = new [] { "eventLevels" },
        EventName = "eventName",
        LogGroupName = "logGroupName",

        // the properties below are optional
        PatternSet = "patternSet"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

configurationDetailsProperty := &ConfigurationDetailsProperty{
	AlarmMetrics: []interface{}{
		&AlarmMetricProperty{
			AlarmMetricName: jsii.String("alarmMetricName"),
		},
	},
	Alarms: []interface{}{
		&AlarmProperty{
			AlarmName: jsii.String("alarmName"),

			// the properties below are optional
			Severity: jsii.String("severity"),
		},
	},
	HaClusterPrometheusExporter: &HAClusterPrometheusExporterProperty{
		PrometheusPort: jsii.String("prometheusPort"),
	},
	HanaPrometheusExporter: &HANAPrometheusExporterProperty{
		AgreeToInstallHanadbClient: jsii.Boolean(false),
		HanaPort: jsii.String("hanaPort"),
		HanaSecretName: jsii.String("hanaSecretName"),
		Hanasid: jsii.String("hanasid"),

		// the properties below are optional
		PrometheusPort: jsii.String("prometheusPort"),
	},
	JmxPrometheusExporter: &JMXPrometheusExporterProperty{
		HostPort: jsii.String("hostPort"),
		Jmxurl: jsii.String("jmxurl"),
		PrometheusPort: jsii.String("prometheusPort"),
	},
	Logs: []interface{}{
		&LogProperty{
			LogType: jsii.String("logType"),

			// the properties below are optional
			Encoding: jsii.String("encoding"),
			LogGroupName: jsii.String("logGroupName"),
			LogPath: jsii.String("logPath"),
			PatternSet: jsii.String("patternSet"),
		},
	},
	NetWeaverPrometheusExporter: &NetWeaverPrometheusExporterProperty{
		InstanceNumbers: []*string{
			jsii.String("instanceNumbers"),
		},
		Sapsid: jsii.String("sapsid"),

		// the properties below are optional
		PrometheusPort: jsii.String("prometheusPort"),
	},
	Processes: []interface{}{
		&ProcessProperty{
			AlarmMetrics: []interface{}{
				&AlarmMetricProperty{
					AlarmMetricName: jsii.String("alarmMetricName"),
				},
			},
			ProcessName: jsii.String("processName"),
		},
	},
	SqlServerPrometheusExporter: &SQLServerPrometheusExporterProperty{
		PrometheusPort: jsii.String("prometheusPort"),
		SqlSecretName: jsii.String("sqlSecretName"),
	},
	WindowsEvents: []interface{}{
		&WindowsEventProperty{
			EventLevels: []*string{
				jsii.String("eventLevels"),
			},
			EventName: jsii.String("eventName"),
			LogGroupName: jsii.String("logGroupName"),

			// the properties below are optional
			PatternSet: jsii.String("patternSet"),
		},
	},
}

Properties ​

alarmMetricsoptionalIResolvable | IResolvable | CfnApplication.AlarmMetricProperty[]alarm_metricsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AlarmMetricProperty]]]alarmMetricsoptionalIResolvableAlarmMetricsoptionalIResolvableAlarmMetricsoptionalinterface{} #
A list of metrics to monitor for the component.

All component types can use AlarmMetrics .

alarmsoptionalIResolvable | IResolvable | CfnApplication.AlarmProperty[]alarmsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AlarmProperty]]]alarmsoptionalIResolvableAlarmsoptionalIResolvableAlarmsoptionalinterface{} #
A list of alarms to monitor for the component.

All component types can use Alarm .

haClusterPrometheusExporteroptionalIResolvable | CfnApplication.HAClusterPrometheusExporterPropertyha_cluster_prometheus_exporteroptionaltyping.Union[IResolvable, HAClusterPrometheusExporterProperty]haClusterPrometheusExporteroptionalIResolvableHaClusterPrometheusExporteroptionalIResolvableHaClusterPrometheusExporteroptionalinterface{} #
The HA cluster Prometheus Exporter settings.
hanaPrometheusExporteroptionalIResolvable | CfnApplication.HANAPrometheusExporterPropertyhana_prometheus_exporteroptionaltyping.Union[IResolvable, HANAPrometheusExporterProperty]hanaPrometheusExporteroptionalIResolvableHanaPrometheusExporteroptionalIResolvableHanaPrometheusExporteroptionalinterface{} #
The HANA DB Prometheus Exporter settings.
jmxPrometheusExporteroptionalIResolvable | CfnApplication.JMXPrometheusExporterPropertyjmx_prometheus_exporteroptionaltyping.Union[IResolvable, JMXPrometheusExporterProperty]jmxPrometheusExporteroptionalIResolvableJmxPrometheusExporteroptionalIResolvableJmxPrometheusExporteroptionalinterface{} #
A list of Java metrics to monitor for the component.
logsoptionalIResolvable | IResolvable | CfnApplication.LogProperty[]logsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LogProperty]]]logsoptionalIResolvableLogsoptionalIResolvableLogsoptionalinterface{} #
A list of logs to monitor for the component.

Only Amazon EC2 instances can use Logs .

netWeaverPrometheusExporteroptionalIResolvable | CfnApplication.NetWeaverPrometheusExporterPropertynet_weaver_prometheus_exporteroptionaltyping.Union[IResolvable, NetWeaverPrometheusExporterProperty]netWeaverPrometheusExporteroptionalIResolvableNetWeaverPrometheusExporteroptionalIResolvableNetWeaverPrometheusExporteroptionalinterface{} #
The NetWeaver Prometheus Exporter Settings.
processesoptionalIResolvable | IResolvable | CfnApplication.ProcessProperty[]processesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ProcessProperty]]]processesoptionalIResolvableProcessesoptionalIResolvableProcessesoptionalinterface{} #
A list of processes to monitor for the component.

Only Windows EC2 instances can have a processes section.

sqlServerPrometheusExporteroptionalIResolvable | CfnApplication.SQLServerPrometheusExporterPropertysql_server_prometheus_exporteroptionaltyping.Union[IResolvable, SQLServerPrometheusExporterProperty]sqlServerPrometheusExporteroptionalIResolvableSqlServerPrometheusExporteroptionalIResolvableSqlServerPrometheusExporteroptionalinterface{} #
The SQL prometheus exporter settings.
windowsEventsoptionalIResolvable | IResolvable | CfnApplication.WindowsEventProperty[]windows_eventsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, WindowsEventProperty]]]windowsEventsoptionalIResolvableWindowsEventsoptionalIResolvableWindowsEventsoptionalinterface{} #
A list of Windows Events to monitor for the component.

Only Amazon EC2 instances running on Windows can use WindowsEvents .