Class: AWSCDK::LookoutEquipment::CfnInferenceScheduler

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSLookoutequipment::IInferenceSchedulerRef
Defined in:
lookout_equipment/cfn_inference_scheduler.rb

Overview

Creates a scheduled inference.

Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an Amazon S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an Amazon S3 bucket location for the output data.

Updating some properties below (for example, InferenceSchedulerName and ServerSideKmsKeyId) triggers a resource replacement, which requires a new model. To replace such a property using CloudFormation , but without creating a completely new stack, you must replace ModelName. If you need to replace the property, but want to use the same model, delete the current stack and create a new one with the updated properties.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnInferenceScheduler

Create a new AWS::LookoutEquipment::InferenceScheduler.

Parameters:



22
23
24
25
26
27
28
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::LookoutEquipment::CfnInferenceSchedulerProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbG9va291dGVxdWlwbWVudC5DZm5JbmZlcmVuY2VTY2hlZHVsZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_inference_scheduler(resource) ⇒ String

Parameters:

Returns:

  • (String)


84
85
86
87
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 84

def self.arn_for_inference_scheduler(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sb29rb3V0ZXF1aXBtZW50LklJbmZlcmVuY2VTY2hlZHVsZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lookoutequipment.CfnInferenceScheduler", "arnForInferenceScheduler", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


191
192
193
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 191

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

.is_cfn_inference_scheduler(x) ⇒ Boolean

Checks whether the given object is a CfnInferenceScheduler.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


93
94
95
96
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 93

def self.is_cfn_inference_scheduler(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lookoutequipment.CfnInferenceScheduler", "isCfnInferenceScheduler", [x])
end

.jsii_overridable_methodsObject



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
75
76
77
78
79
80
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 30

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 },
    :attr_inference_scheduler_arn => { kind: :property, name: "attrInferenceSchedulerArn", is_optional: false },
    :inference_scheduler_ref => { kind: :property, name: "inferenceSchedulerRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :data_input_configuration => { kind: :property, name: "dataInputConfiguration", is_optional: false },
    :data_output_configuration => { kind: :property, name: "dataOutputConfiguration", is_optional: false },
    :data_upload_frequency => { kind: :property, name: "dataUploadFrequency", is_optional: false },
    :model_name => { kind: :property, name: "modelName", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :data_delay_offset_in_minutes => { kind: :property, name: "dataDelayOffsetInMinutes", is_optional: true },
    :inference_scheduler_name => { kind: :property, name: "inferenceSchedulerName", is_optional: true },
    :server_side_kms_key_id => { kind: :property, name: "serverSideKmsKeyId", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



361
362
363
364
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 361

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:



373
374
375
376
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 373

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:



383
384
385
386
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 383

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.



394
395
396
397
398
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 394

def (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.


451
452
453
454
455
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 451

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.



461
462
463
464
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 461

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.



473
474
475
476
477
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 473

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

#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:



486
487
488
489
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 486

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:



508
509
510
511
512
513
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 508

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_inference_scheduler_arnString

The Amazon Resource Name (ARN) of the inference scheduler being created.

Returns:

  • (String)


198
199
200
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 198

def attr_inference_scheduler_arn()
  jsii_get_property("attrInferenceSchedulerArn")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



144
145
146
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 144

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


149
150
151
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 149

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


517
518
519
520
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 517

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


154
155
156
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 154

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


161
162
163
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 161

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


106
107
108
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 106

def creation_stack()
  jsii_get_property("creationStack")
end

#data_delay_offset_in_minutesNumeric?

A period of time (in minutes) by which inference on the data is delayed after the data starts.

Returns:

  • (Numeric, nil)


279
280
281
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 279

def data_delay_offset_in_minutes()
  jsii_get_property("dataDelayOffsetInMinutes")
end

#data_delay_offset_in_minutes=(value) ⇒ Object



283
284
285
286
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 283

def data_delay_offset_in_minutes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dataDelayOffsetInMinutes") unless value.nil?
  jsii_set_property("dataDelayOffsetInMinutes", value)
end

#data_input_configurationObject

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

Returns:

  • (Object)


219
220
221
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 219

def data_input_configuration()
  jsii_get_property("dataInputConfiguration")
end

#data_input_configuration=(value) ⇒ Object



223
224
225
226
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 223

def data_input_configuration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "dataInputConfiguration")
  jsii_set_property("dataInputConfiguration", value)
end

#data_output_configurationObject

Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.

Returns:

  • (Object)


231
232
233
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 231

def data_output_configuration()
  jsii_get_property("dataOutputConfiguration")
end

#data_output_configuration=(value) ⇒ Object



235
236
237
238
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 235

def data_output_configuration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "dataOutputConfiguration")
  jsii_set_property("dataOutputConfiguration", value)
end

#data_upload_frequencyString

How often data is uploaded to the source S3 bucket for the input data.

Returns:

  • (String)


243
244
245
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 243

def data_upload_frequency()
  jsii_get_property("dataUploadFrequency")
end

#data_upload_frequency=(value) ⇒ Object



247
248
249
250
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 247

def data_upload_frequency=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataUploadFrequency")
  jsii_set_property("dataUploadFrequency", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



166
167
168
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 166

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:



530
531
532
533
534
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 530

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.



541
542
543
544
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 541

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

#inference_scheduler_nameString?

The name of the inference scheduler.

Returns:

  • (String, nil)


291
292
293
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 291

def inference_scheduler_name()
  jsii_get_property("inferenceSchedulerName")
end

#inference_scheduler_name=(value) ⇒ Object



295
296
297
298
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 295

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

#inference_scheduler_refAWSCDK::Interfaces::AWSLookoutequipment::InferenceSchedulerReference

A reference to a InferenceScheduler resource.



205
206
207
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 205

def inference_scheduler_ref()
  jsii_get_property("inferenceSchedulerRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



611
612
613
614
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 611

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

#logical_idString

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)


118
119
120
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 118

def logical_id()
  jsii_get_property("logicalId")
end

#model_nameString

The name of the machine learning model used for the inference scheduler.

Returns:

  • (String)


255
256
257
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 255

def model_name()
  jsii_get_property("modelName")
end

#model_name=(value) ⇒ Object



259
260
261
262
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 259

def model_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelName")
  jsii_set_property("modelName", value)
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


101
102
103
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 101

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



552
553
554
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 552

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



559
560
561
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 559

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.



352
353
354
355
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 352

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

#refString

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)


137
138
139
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 137

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:



570
571
572
573
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 570

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})


577
578
579
580
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 577

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:



587
588
589
590
591
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 587

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

#role_arnString

The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.

Returns:

  • (String)


267
268
269
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 267

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object



271
272
273
274
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 271

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", value)
end

#server_side_kms_key_idString?

Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by .

Returns:

  • (String, nil)


303
304
305
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 303

def server_side_kms_key_id()
  jsii_get_property("serverSideKmsKeyId")
end

#server_side_kms_key_id=(value) ⇒ Object



307
308
309
310
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 307

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

#should_synthesizeBoolean

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.



596
597
598
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 596

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



127
128
129
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 127

def stack()
  jsii_get_property("stack")
end

#tagsAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



212
213
214
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 212

def tags()
  jsii_get_property("tags")
end

#tags_rawArray<AWSCDK::CfnTag>?

Any tags associated with the inference scheduler.

Returns:



315
316
317
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 315

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object



319
320
321
322
323
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 319

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



328
329
330
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 328

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

#updated_properitesHash{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})


174
175
176
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 174

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


184
185
186
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 184

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


602
603
604
605
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 602

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)


341
342
343
344
345
346
# File 'lookout_equipment/cfn_inference_scheduler.rb', line 341

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