Class: AWSCDK::LookoutEquipment::CfnInferenceSchedulerProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lookout_equipment/cfn_inference_scheduler_props.rb

Overview

Properties for defining a CfnInferenceScheduler.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_input_configuration:, data_output_configuration:, data_upload_frequency:, model_name:, role_arn:, data_delay_offset_in_minutes: nil, inference_scheduler_name: nil, server_side_kms_key_id: nil, tags: nil) ⇒ CfnInferenceSchedulerProps

Returns a new instance of CfnInferenceSchedulerProps.

Parameters:

  • data_input_configuration (Object) —

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

  • data_output_configuration (Object) —

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

  • data_upload_frequency (String) —

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

  • model_name (String) —

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

  • role_arn (String) —

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

  • data_delay_offset_in_minutes (Numeric, nil) (defaults to: nil) —

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

  • inference_scheduler_name (String, nil) (defaults to: nil) —

    The name of the inference scheduler.

  • server_side_kms_key_id (String, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Any tags associated with the inference scheduler.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 18

def initialize(data_input_configuration:, data_output_configuration:, data_upload_frequency:, model_name:, role_arn:, data_delay_offset_in_minutes: nil, inference_scheduler_name: nil, server_side_kms_key_id: nil, tags: nil)
  @data_input_configuration = data_input_configuration
  Jsii::Type.check_type(@data_input_configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "dataInputConfiguration")
  @data_output_configuration = data_output_configuration
  Jsii::Type.check_type(@data_output_configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "dataOutputConfiguration")
  @data_upload_frequency = data_upload_frequency
  Jsii::Type.check_type(@data_upload_frequency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataUploadFrequency")
  @model_name = model_name
  Jsii::Type.check_type(@model_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelName")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @data_delay_offset_in_minutes = data_delay_offset_in_minutes
  Jsii::Type.check_type(@data_delay_offset_in_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dataDelayOffsetInMinutes") unless @data_delay_offset_in_minutes.nil?
  @inference_scheduler_name = inference_scheduler_name
  Jsii::Type.check_type(@inference_scheduler_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inferenceSchedulerName") unless @inference_scheduler_name.nil?
  @server_side_kms_key_id = server_side_kms_key_id
  Jsii::Type.check_type(@server_side_kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverSideKmsKeyId") unless @server_side_kms_key_id.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#data_delay_offset_in_minutes ⇒ Numeric? (readonly)

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

For instance, if an offset delay time of five minutes was selected, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

Returns:

  • (Numeric, nil)

See Also:



72
73
74
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 72

def data_delay_offset_in_minutes
  @data_delay_offset_in_minutes
end

#data_input_configuration ⇒ Object (readonly)

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

Returns:

  • (Object)

See Also:



43
44
45
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 43

def data_input_configuration
  @data_input_configuration
end

#data_output_configuration ⇒ Object (readonly)

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

Returns:

  • (Object)

See Also:



48
49
50
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 48

def data_output_configuration
  @data_output_configuration
end

#data_upload_frequency ⇒ String (readonly)

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

This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

Returns:

  • (String)

See Also:



55
56
57
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 55

def data_upload_frequency
  @data_upload_frequency
end

#inference_scheduler_name ⇒ String? (readonly)

The name of the inference scheduler.

Returns:

  • (String, nil)

See Also:



77
78
79
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 77

def inference_scheduler_name
  @inference_scheduler_name
end

#model_name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



60
61
62
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 60

def model_name
  @model_name
end

#role_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



65
66
67
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 65

def role_arn
  @role_arn
end

#server_side_kms_key_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



82
83
84
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 82

def server_side_kms_key_id
  @server_side_kms_key_id
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Any tags associated with the inference scheduler.

For more information, see Tag .

Returns:

See Also:



89
90
91
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 89

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 91

def self.jsii_properties
  {
    :data_input_configuration => "dataInputConfiguration",
    :data_output_configuration => "dataOutputConfiguration",
    :data_upload_frequency => "dataUploadFrequency",
    :model_name => "modelName",
    :role_arn => "roleArn",
    :data_delay_offset_in_minutes => "dataDelayOffsetInMinutes",
    :inference_scheduler_name => "inferenceSchedulerName",
    :server_side_kms_key_id => "serverSideKmsKeyId",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lookout_equipment/cfn_inference_scheduler_props.rb', line 105

def to_jsii
  result = {}
  result.merge!({
    "dataInputConfiguration" => @data_input_configuration,
    "dataOutputConfiguration" => @data_output_configuration,
    "dataUploadFrequency" => @data_upload_frequency,
    "modelName" => @model_name,
    "roleArn" => @role_arn,
    "dataDelayOffsetInMinutes" => @data_delay_offset_in_minutes,
    "inferenceSchedulerName" => @inference_scheduler_name,
    "serverSideKmsKeyId" => @server_side_kms_key_id,
    "tags" => @tags,
  })
  result.compact
end