AWS::ApplicationInsights::Application ComponentMonitoringSetting
The AWS::ApplicationInsights::Application ComponentMonitoringSetting
property type defines the monitoring setting of the component.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ComponentARN" :
String
, "ComponentConfigurationMode" :String
, "ComponentName" :String
, "CustomComponentConfiguration" :ComponentConfiguration
, "DefaultOverwriteComponentConfiguration" :ComponentConfiguration
, "Tier" :String
}
YAML
ComponentARN:
String
ComponentConfigurationMode:String
ComponentName:String
CustomComponentConfiguration:ComponentConfiguration
DefaultOverwriteComponentConfiguration:ComponentConfiguration
Tier:String
Properties
ComponentARN
-
The ARN of the component. Either the component ARN or the component name is required.
Required: No
Type: String
Pattern:
^arn:aws(-[\w]+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$
Minimum:
20
Maximum:
300
Update requires: No interruption
ComponentConfigurationMode
-
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 selectedTier
. -
CUSTOM
: The component will be configured with the customized monitoring settings that are specified inCustomComponentConfiguration
. If used,CustomComponentConfiguration
must be provided. -
DEFAULT_WITH_OVERWRITE
: The component will be configured with the recommended default monitoring settings of the selectedTier
, and merged with customized overwrite settings that are specified inDefaultOverwriteComponentConfiguration
. If used,DefaultOverwriteComponentConfiguration
must be provided.
Required: Yes
Type: String
Allowed values:
DEFAULT | DEFAULT_WITH_OVERWRITE | CUSTOM
Update requires: No interruption
-
ComponentName
-
The name of the component. Either the component ARN or the component name is required.
Required: No
Type: String
Pattern:
^[\d\w\-_.+]*$
Minimum:
1
Maximum:
128
Update requires: No interruption
CustomComponentConfiguration
-
Customized monitoring settings. Required if CUSTOM mode is configured in
ComponentConfigurationMode
.Required: No
Type: ComponentConfiguration
Update requires: No interruption
DefaultOverwriteComponentConfiguration
-
Customized overwrite monitoring settings. Required if CUSTOM mode is configured in
ComponentConfigurationMode
.Required: No
Type: ComponentConfiguration
Update requires: No interruption
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
, andDEFAULT
.Required: Yes
Type: String
Pattern:
^[A-Z][[A-Z]_]*$
Update requires: No interruption