Class: AWSCDK::ApplicationInsights::CfnApplication::HANAPrometheusExporterProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
application_insights/cfn_application.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(agree_to_install_hanadb_client:, hana_port:, hana_secret_name:, hanasid:, prometheus_port: nil) ⇒ HANAPrometheusExporterProperty

Returns a new instance of HANAPrometheusExporterProperty.

Parameters:

  • agree_to_install_hanadb_client (Boolean, AWSCDK::IResolvable) —

    Designates whether you agree to install the HANA DB client.

  • hana_port (String) —

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

  • hana_secret_name (String) —

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

  • hanasid (String) —

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

  • prometheus_port (String, nil) (defaults to: nil) —

    The target port to which Prometheus sends metrics.



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'application_insights/cfn_application.rb', line 1097

def initialize(agree_to_install_hanadb_client:, hana_port:, hana_secret_name:, hanasid:, prometheus_port: nil)
  @agree_to_install_hanadb_client = agree_to_install_hanadb_client
  Jsii::Type.check_type(@agree_to_install_hanadb_client, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "agreeToInstallHanadbClient")
  @hana_port = hana_port
  Jsii::Type.check_type(@hana_port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hanaPort")
  @hana_secret_name = hana_secret_name
  Jsii::Type.check_type(@hana_secret_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hanaSecretName")
  @hanasid = hanasid
  Jsii::Type.check_type(@hanasid, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hanasid")
  @prometheus_port = prometheus_port
  Jsii::Type.check_type(@prometheus_port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prometheusPort") unless @prometheus_port.nil?
end

Instance Attribute Details

#agree_to_install_hanadb_client ⇒ Boolean, AWSCDK::IResolvable (readonly)

Designates whether you agree to install the HANA DB client.

Returns:

See Also:



1114
1115
1116
 
# File 'application_insights/cfn_application.rb', line 1114

def agree_to_install_hanadb_client
  @agree_to_install_hanadb_client
end

#hana_port ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1119
1120
1121
 
# File 'application_insights/cfn_application.rb', line 1119

def hana_port
  @hana_port
end

#hana_secret_name ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



1126
1127
1128
 
# File 'application_insights/cfn_application.rb', line 1126

def hana_secret_name
  @hana_secret_name
end

#hanasid ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1131
1132
1133
 
# File 'application_insights/cfn_application.rb', line 1131

def hanasid
  @hanasid
end

#prometheus_port ⇒ String? (readonly)

The target port to which Prometheus sends metrics.

If not specified, the default port 9668 is used.

Returns:

  • (String, nil)

See Also:



1138
1139
1140
 
# File 'application_insights/cfn_application.rb', line 1138

def prometheus_port
  @prometheus_port
end

Class Method Details

.jsii_properties ⇒ Object 



1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'application_insights/cfn_application.rb', line 1140

def self.jsii_properties
  {
    :agree_to_install_hanadb_client => "agreeToInstallHanadbClient",
    :hana_port => "hanaPort",
    :hana_secret_name => "hanaSecretName",
    :hanasid => "hanasid",
    :prometheus_port => "prometheusPort",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
 
# File 'application_insights/cfn_application.rb', line 1150

def to_jsii
  result = {}
  result.merge!({
    "agreeToInstallHanadbClient" => @agree_to_install_hanadb_client,
    "hanaPort" => @hana_port,
    "hanaSecretName" => @hana_secret_name,
    "hanasid" => @hanasid,
    "prometheusPort" => @prometheus_port,
  })
  result.compact
end