Package software.amazon.awscdk.services.applicationinsights

Interface CfnApplication.HANAPrometheusExporterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplication.HANAPrometheusExporterProperty.Jsii$Proxy

Enclosing class:

CfnApplication

@Stability(Stable)
public static interface CfnApplication.HANAPrometheusExporterProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.applicationinsights.*;
 HANAPrometheusExporterProperty hANAPrometheusExporterProperty = HANAPrometheusExporterProperty.builder()
         .agreeToInstallHanadbClient(false)
         .hanaPort("hanaPort")
         .hanaSecretName("hanaSecretName")
         .hanasid("hanasid")
         // the properties below are optional
         .prometheusPort("prometheusPort")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplication.HANAPrometheusExporterProperty.Builder	A builder for CfnApplication.HANAPrometheusExporterProperty
static final class	CfnApplication.HANAPrometheusExporterProperty.Jsii$Proxy	An implementation for CfnApplication.HANAPrometheusExporterProperty

Method Summary

Modifier and Type	Method	Description
static CfnApplication.HANAPrometheusExporterProperty.Builder	builder()
Object	getAgreeToInstallHanadbClient()	Designates whether you agree to install the HANA DB client.
String	getHanaPort()	The HANA database port by which the exporter will query HANA metrics.
String	getHanaSecretName()	The AWS Secrets Manager secret that stores HANA monitoring user credentials.
String	getHanasid()	The three-character SAP system ID (SID) of the SAP HANA system.
default String	getPrometheusPort()	The target port to which Prometheus sends metrics.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAgreeToInstallHanadbClient

@Stability(Stable)
@NotNull
Object getAgreeToInstallHanadbClient()

Designates whether you agree to install the HANA DB client.

Returns union: either Boolean or IResolvable

See Also:

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

getHanaPort

@Stability(Stable)
@NotNull
String getHanaPort()

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

See Also:

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

getHanaSecretName

@Stability(Stable)
@NotNull
String getHanaSecretName()

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 Also:

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

getHanasid

@Stability(Stable)
@NotNull
String getHanasid()

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

See Also:

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

getPrometheusPort

@Stability(Stable)
@Nullable
default String getPrometheusPort()

The target port to which Prometheus sends metrics.

If not specified, the default port 9668 is used.

See Also:

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

builder

@Stability(Stable)
static CfnApplication.HANAPrometheusExporterProperty.Builder builder()

Returns:

a CfnApplication.HANAPrometheusExporterProperty.Builder of CfnApplication.HANAPrometheusExporterProperty