Class: AWSCDK::LookoutMetrics::CfnAnomalyDetector

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSLookoutmetrics::IAnomalyDetectorRef
Defined in:
lookout_metrics/cfn_anomaly_detector.rb

Overview

End of support notice: On Oct 9, 2025, AWS will end support for Amazon Lookout for Metrics.

After Oct 9, 2025, you will no longer be able to access the Amazon Lookout for Metrics console or Amazon Lookout for Metrics resources. For more information, see Amazon Lookout for Metrics end of support .

The AWS::LookoutMetrics::AnomalyDetector type creates an anomaly detector.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAnomalyDetector

Create a new AWS::LookoutMetrics::AnomalyDetector.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::LookoutMetrics::CfnAnomalyDetectorProps) —

    Resource properties.



21
22
23
24
25
26
27
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 21

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::LookoutMetrics::CfnAnomalyDetectorProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbG9va291dG1ldHJpY3MuQ2ZuQW5vbWFseURldGVjdG9yUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_anomaly_detector(resource) ⇒ String

Parameters:

Returns:

  • (String) 


78
79
80
81
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 78

def self.arn_for_anomaly_detector(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sb29rb3V0bWV0cmljcy5JQW5vbWFseURldGVjdG9yUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lookoutmetrics.CfnAnomalyDetector", "arnForAnomalyDetector", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


185
186
187
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 185

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_lookoutmetrics.CfnAnomalyDetector", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_anomaly_detector(x) ⇒ Boolean

Checks whether the given object is a CfnAnomalyDetector.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


87
88
89
90
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 87

def self.is_cfn_anomaly_detector(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lookoutmetrics.CfnAnomalyDetector", "isCfnAnomalyDetector", [x])
end

.jsii_overridable_methods ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 29

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :anomaly_detector_ref => { kind: :property, name: "anomalyDetectorRef", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :anomaly_detector_config => { kind: :property, name: "anomalyDetectorConfig", is_optional: false },
    :metric_set_list => { kind: :property, name: "metricSetList", is_optional: false },
    :anomaly_detector_description => { kind: :property, name: "anomalyDetectorDescription", is_optional: true },
    :anomaly_detector_name => { kind: :property, name: "anomalyDetectorName", is_optional: true },
    :kms_key_arn => { kind: :property, name: "kmsKeyArn", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



302
303
304
305
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 302

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



314
315
316
317
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 314

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



324
325
326
327
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 324

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



335
336
337
338
339
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 335

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


392
393
394
395
396
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 392

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



402
403
404
405
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 402

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



414
415
416
417
418
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 414

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#anomaly_detector_config ⇒ AWSCDK::IResolvable, AWSCDK::LookoutMetrics::CfnAnomalyDetector::AnomalyDetectorConfigProperty

Contains information about the configuration of the anomaly detector.

Returns:



208
209
210
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 208

def anomaly_detector_config()
  jsii_get_property("anomalyDetectorConfig")
end

#anomaly_detector_config=(value) ⇒ Object 



212
213
214
215
216
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 212

def anomaly_detector_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::LookoutMetrics::CfnAnomalyDetector::AnomalyDetectorConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sb29rb3V0bWV0cmljcy5DZm5Bbm9tYWx5RGV0ZWN0b3IuQW5vbWFseURldGVjdG9yQ29uZmlnUHJvcGVydHkifV19fQ==")), "anomalyDetectorConfig")
  jsii_set_property("anomalyDetectorConfig", value)
end

#anomaly_detector_description ⇒ String?

A description of the detector.

Returns:

  • (String, nil) 


233
234
235
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 233

def anomaly_detector_description()
  jsii_get_property("anomalyDetectorDescription")
end

#anomaly_detector_description=(value) ⇒ Object 



237
238
239
240
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 237

def anomaly_detector_description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "anomalyDetectorDescription") unless value.nil?
  jsii_set_property("anomalyDetectorDescription", value)
end

#anomaly_detector_name ⇒ String?

The name of the detector.

Returns:

  • (String, nil) 


245
246
247
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 245

def anomaly_detector_name()
  jsii_get_property("anomalyDetectorName")
end

#anomaly_detector_name=(value) ⇒ Object 



249
250
251
252
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 249

def anomaly_detector_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "anomalyDetectorName") unless value.nil?
  jsii_set_property("anomalyDetectorName", value)
end

#anomaly_detector_ref ⇒ AWSCDK::Interfaces::AWSLookoutmetrics::AnomalyDetectorReference

A reference to a AnomalyDetector resource.

Returns:



192
193
194
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 192

def anomaly_detector_ref()
  jsii_get_property("anomalyDetectorRef")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



427
428
429
430
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 427

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



449
450
451
452
453
454
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 449

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the detector.

For example, arn:aws:lookoutmetrics:us-east-2:123456789012:AnomalyDetector:my-detector

Returns:

  • (String) 


201
202
203
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 201

def attr_arn()
  jsii_get_property("attrArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



138
139
140
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 138

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


143
144
145
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 143

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


458
459
460
461
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 458

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


148
149
150
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 148

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


155
156
157
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 155

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


100
101
102
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 100

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



160
161
162
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 160

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



471
472
473
474
475
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 471

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



482
483
484
485
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 482

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



552
553
554
555
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 552

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_arn ⇒ String?

The ARN of the KMS key to use to encrypt your data.

Returns:

  • (String, nil) 


257
258
259
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 257

def kms_key_arn()
  jsii_get_property("kmsKeyArn")
end

#kms_key_arn=(value) ⇒ Object 



261
262
263
264
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 261

def kms_key_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyArn") unless value.nil?
  jsii_set_property("kmsKeyArn", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


112
113
114
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 112

def logical_id()
  jsii_get_property("logicalId")
end

#metric_set_list ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::LookoutMetrics::CfnAnomalyDetector::MetricSetProperty>

The detector's dataset.

Returns:



221
222
223
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 221

def metric_set_list()
  jsii_get_property("metricSetList")
end

#metric_set_list=(value) ⇒ Object 



225
226
227
228
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 225

def metric_set_list=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbG9va291dG1ldHJpY3MuQ2ZuQW5vbWFseURldGVjdG9yLk1ldHJpY1NldFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "metricSetList")
  jsii_set_property("metricSetList", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


95
96
97
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 95

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



493
494
495
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 493

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



500
501
502
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 500

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



293
294
295
296
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 293

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


131
132
133
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 131

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



511
512
513
514
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 511

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


518
519
520
521
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 518

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



528
529
530
531
532
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 528

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



537
538
539
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 537

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



121
122
123
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 121

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



269
270
271
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 269

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


168
169
170
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 168

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


178
179
180
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 178

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


543
544
545
546
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 543

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


282
283
284
285
286
287
 
# File 'lookout_metrics/cfn_anomaly_detector.rb', line 282

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end