Class: MintPress::Aws::CloudWatch::AnomalyDetector

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb

Properties (Read/Write)

  • #namespace ⇒ [String]
    'Limits the results to only the anomaly detection models that are associated with the specified namespace.'
    Property Attributes
    • delete_anomaly_detector_prop ⇒ 'namespace'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "describe_anomaly_detectors"
    • orig_name ⇒ 'namespace'
    • describe_anomaly_detectors_prop ⇒ 'namespace'
    

21
22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 21

property :namespace, delete_anomaly_detector_prop: 'namespace', type: [String], disposition: :attribute, read_only: false, source: "describe_anomaly_detectors", description: 'Limits the results to only the anomaly detection models that are
associated with the specified namespace.', orig_name: 'namespace', describe_anomaly_detectors_prop: 'namespace'
  • #metric_name ⇒ [String] (Default Value: Proc.new { self.name })
    'Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they"re all returned.'
    Property Attributes
    • delete_anomaly_detector_prop ⇒ 'metric_name'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "describe_anomaly_detectors"
    • orig_name ⇒ 'metric_name'
    • describe_anomaly_detectors_prop ⇒ 'metric_name'
    • default ⇒ Proc.new { self.name }
    

23
24
25
26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 23

property :metric_name, delete_anomaly_detector_prop: 'metric_name', type: [String], disposition: :attribute, read_only: false, source: "describe_anomaly_detectors", description: 'Limits the results to only the anomaly detection models that are
associated with the specified metric name. If there are multiple
metrics with this name in different namespaces that have anomaly
detection models, they"re all returned.', orig_name: 'metric_name', describe_anomaly_detectors_prop: 'metric_name', default: Proc.new { self.name }
  • #dimensions ⇒ Hash of ⇒ [MintPress::Aws::CloudWatch::Dimension]
    'Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they"re all returned.'
    Property Attributes
    • delete_anomaly_detector_prop ⇒ 'dimensions'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "describe_anomaly_detectors"
    • orig_name ⇒ 'dimensions'
    • describe_anomaly_detectors_prop ⇒ 'dimensions'
    

27
28
29
30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 27

property :dimensions, delete_anomaly_detector_prop: 'dimensions', type: [MintPress::Aws::CloudWatch::Dimension], array: false, disposition: :attribute, read_only: false, source: "describe_anomaly_detectors", description: 'Limits the results to only the anomaly detection models that are
associated with the specified metric dimensions. If there are multiple
metrics that have these dimensions and have anomaly detection models
associated, they"re all returned.', orig_name: 'dimensions', describe_anomaly_detectors_prop: 'dimensions', hash: true
  • #stat ⇒ [String]
    'The statistic associated with the anomaly detection model.'
    Property Attributes
    • delete_anomaly_detector_prop ⇒ 'stat'
    • disposition ⇒ :attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::CloudWatch::AnomalyDetector"
    • orig_name ⇒ 'stat'
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 31

property :stat, delete_anomaly_detector_prop: 'stat', type: [String], disposition: :attribute, read_only: false, source: "MintPress::Aws::CloudWatch::AnomalyDetector", description: 'The statistic associated with the anomaly detection model.', orig_name: 'stat'
  • #configuration ⇒ [MintPress::Aws::CloudWatch::AnomalyDetectorConfiguration] (Default Value: MintPress::Aws::CloudWatch::AnomalyDetectorConfiguration.new)
    'The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::CloudWatch::AnomalyDetector"
    • orig_name ⇒ 'configuration'
    • default ⇒ MintPress::Aws::CloudWatch::AnomalyDetectorConfiguration.new
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 32

property :configuration, disposition: :attribute, description: 'The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.', source: "MintPress::Aws::CloudWatch::AnomalyDetector", orig_name: 'configuration', type: [MintPress::Aws::CloudWatch::AnomalyDetectorConfiguration], default: MintPress::Aws::CloudWatch::AnomalyDetectorConfiguration.new
  • #state_value ⇒ [String]
    'The current status of the anomaly detector"s training.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::CloudWatch::AnomalyDetector"
    • orig_name ⇒ 'state_value'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 33

property :state_value, disposition: :attribute, description: 'The current status of the anomaly detector"s training.', source: "MintPress::Aws::CloudWatch::AnomalyDetector", orig_name: 'state_value', type: [String]
  • #max_results ⇒ [Integer]
    'The maximum number of results to return in one operation. The maximum value that you can specify is 100. To retrieve the remaining results, make another call with the returned NextToken value.'
    Property Attributes
    • describe_anomaly_detectors_prop ⇒ 'max_results'
    • source ⇒ "describe_anomaly_detectors"
    

34
35
36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 34

property :max_results, describe_anomaly_detectors_prop: 'max_results', type: [Integer], source: "describe_anomaly_detectors", description: 'The maximum number of results to return in one operation. The maximum
value that you can specify is 100.

To retrieve the remaining results, make another call with the returned
NextToken value.'
  • #name ⇒ [String]

    Property Attributes 
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 39

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 43

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/anomaly_detector.rb', line 46

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ AnomalyDetector

Returns a new instance of AnomalyDetector.

Instance Method Details

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object