Package software.amazon.awscdk.services.applicationinsights

Interface CfnApplication.LogProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplication.LogProperty.Jsii$Proxy

Enclosing class:

CfnApplication

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

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

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.*;
 LogProperty logProperty = LogProperty.builder()
         .logType("logType")
         // the properties below are optional
         .encoding("encoding")
         .logGroupName("logGroupName")
         .logPath("logPath")
         .patternSet("patternSet")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplication.LogProperty.Builder	builder()
default String	getEncoding()	The type of encoding of the logs to be monitored.
default String	getLogGroupName()	The CloudWatch log group name to be associated with the monitored log.
default String	getLogPath()	The path of the logs to be monitored.
String	getLogType()	The log type decides the log patterns against which Application Insights analyzes the log.
default String	getPatternSet()	The log pattern set.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogType

@Stability(Stable)
@NotNull
String getLogType()

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 .

getEncoding

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

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

getLogGroupName

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

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

getLogPath

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

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 .

getPatternSet

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

The log pattern set.

builder

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

Returns:

a CfnApplication.LogProperty.Builder of CfnApplication.LogProperty