Class: AWSCDK::ApplicationInsights::CfnApplication::ComponentMonitoringSettingProperty

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

Overview

The AWS::ApplicationInsights::Application ComponentMonitoringSetting property type defines the monitoring setting of the component.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(component_configuration_mode:, tier:, component_arn: nil, component_name: nil, custom_component_configuration: nil, default_overwrite_component_configuration: nil) ⇒ ComponentMonitoringSettingProperty

Returns a new instance of ComponentMonitoringSettingProperty.

Parameters:



786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'application_insights/cfn_application.rb', line 786

def initialize(component_configuration_mode:, tier:, component_arn: nil, component_name: nil, custom_component_configuration: nil, default_overwrite_component_configuration: nil)
  @component_configuration_mode = component_configuration_mode
  Jsii::Type.check_type(@component_configuration_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "componentConfigurationMode")
  @tier = tier
  Jsii::Type.check_type(@tier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tier")
  @component_arn = component_arn
  Jsii::Type.check_type(@component_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "componentArn") unless @component_arn.nil?
  @component_name = component_name
  Jsii::Type.check_type(@component_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "componentName") unless @component_name.nil?
  @custom_component_configuration = custom_component_configuration.is_a?(Hash) ? ::AWSCDK::ApplicationInsights::CfnApplication::ComponentConfigurationProperty.new(**custom_component_configuration.transform_keys(&:to_sym)) : custom_component_configuration
  Jsii::Type.check_type(@custom_component_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBsaWNhdGlvbmluc2lnaHRzLkNmbkFwcGxpY2F0aW9uLkNvbXBvbmVudENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "customComponentConfiguration") unless @custom_component_configuration.nil?
  @default_overwrite_component_configuration = default_overwrite_component_configuration.is_a?(Hash) ? ::AWSCDK::ApplicationInsights::CfnApplication::ComponentConfigurationProperty.new(**default_overwrite_component_configuration.transform_keys(&:to_sym)) : default_overwrite_component_configuration
  Jsii::Type.check_type(@default_overwrite_component_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBsaWNhdGlvbmluc2lnaHRzLkNmbkFwcGxpY2F0aW9uLkNvbXBvbmVudENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "defaultOverwriteComponentConfiguration") unless @default_overwrite_component_configuration.nil?
end

Instance Attribute Details

#component_arn ⇒ String? (readonly)

The ARN of the component.

Either the component ARN or the component name is required.

Returns:

  • (String, nil)

See Also:



823
824
825
 
# File 'application_insights/cfn_application.rb', line 823

def component_arn
  @component_arn
end

#component_configuration_mode ⇒ String (readonly)

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 selected Tier .
  • CUSTOM : The component will be configured with the customized monitoring settings that are specified in CustomComponentConfiguration . If used, CustomComponentConfiguration must be provided.
  • DEFAULT_WITH_OVERWRITE : The component will be configured with the recommended default monitoring settings of the selected Tier , and merged with customized overwrite settings that are specified in DefaultOverwriteComponentConfiguration . If used, DefaultOverwriteComponentConfiguration must be provided.

Returns:

  • (String)

See Also:



809
810
811
 
# File 'application_insights/cfn_application.rb', line 809

def component_configuration_mode
  @component_configuration_mode
end

#component_name ⇒ String? (readonly)

The name of the component.

Either the component ARN or the component name is required.

Returns:

  • (String, nil)

See Also:



830
831
832
 
# File 'application_insights/cfn_application.rb', line 830

def component_name
  @component_name
end

#custom_component_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Customized monitoring settings.

Required if CUSTOM mode is configured in ComponentConfigurationMode .

Returns:

See Also:



837
838
839
 
# File 'application_insights/cfn_application.rb', line 837

def custom_component_configuration
  @custom_component_configuration
end

#default_overwrite_component_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Customized overwrite monitoring settings.

Required if CUSTOM mode is configured in ComponentConfigurationMode .

Returns:

See Also:



844
845
846
 
# File 'application_insights/cfn_application.rb', line 844

def default_overwrite_component_configuration
  @default_overwrite_component_configuration
end

#tier ⇒ String (readonly)

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 , and DEFAULT .

Returns:

  • (String)

See Also:



816
817
818
 
# File 'application_insights/cfn_application.rb', line 816

def tier
  @tier
end

Class Method Details

.jsii_properties ⇒ Object 



846
847
848
849
850
851
852
853
854
855
 
# File 'application_insights/cfn_application.rb', line 846

def self.jsii_properties
  {
    :component_configuration_mode => "componentConfigurationMode",
    :tier => "tier",
    :component_arn => "componentArn",
    :component_name => "componentName",
    :custom_component_configuration => "customComponentConfiguration",
    :default_overwrite_component_configuration => "defaultOverwriteComponentConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'application_insights/cfn_application.rb', line 857

def to_jsii
  result = {}
  result.merge!({
    "componentConfigurationMode" => @component_configuration_mode,
    "tier" => @tier,
    "componentArn" => @component_arn,
    "componentName" => @component_name,
    "customComponentConfiguration" => @custom_component_configuration,
    "defaultOverwriteComponentConfiguration" => @default_overwrite_component_configuration,
  })
  result.compact
end