aws-cdk-lib.aws_lookoutequipment.CfnInferenceSchedulerProps

CfnInferenceSchedulerProps Struct

Properties for defining a CfnInferenceScheduler.

CfnInferenceSchedulerProps

used as props by

• CfnInferenceScheduler

Source

Generated code

Type last changed

v2.56.1 · 23 Dec 2022

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lookoutequipment as lookoutequipment } from 'aws-cdk-lib';

declare const dataInputConfiguration: any;
declare const dataOutputConfiguration: any;
const cfnInferenceSchedulerProps: lookoutequipment.CfnInferenceSchedulerProps = {
  dataInputConfiguration: dataInputConfiguration,
  dataOutputConfiguration: dataOutputConfiguration,
  dataUploadFrequency: 'dataUploadFrequency',
  modelName: 'modelName',
  roleArn: 'roleArn',

  // the properties below are optional
  dataDelayOffsetInMinutes: 123,
  inferenceSchedulerName: 'inferenceSchedulerName',
  serverSideKmsKeyId: 'serverSideKmsKeyId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

dataDelayOffsetInMinutes?optionalnumberdata_delay_offset_in_minutes?optionalint | floatdataDelayOffsetInMinutes?optionalNumberDataDelayOffsetInMinutes?optionaldoubleDataDelayOffsetInMinutes?optional*float64#

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

notes

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.

dataInputConfigurationanydata_input_configurationAnydataInputConfigurationObjectDataInputConfigurationobjectDataInputConfigurationinterface{}required#

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

dataOutputConfigurationanydata_output_configurationAnydataOutputConfigurationObjectDataOutputConfigurationobjectDataOutputConfigurationinterface{}required#

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

dataUploadFrequencystringdata_upload_frequencystrdataUploadFrequencyStringDataUploadFrequencystringDataUploadFrequency*stringrequired#

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

notes

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.

inferenceSchedulerName?optionalstringinference_scheduler_name?optionalstrinferenceSchedulerName?optionalStringInferenceSchedulerName?optionalstringInferenceSchedulerName?optional*string#

The name of the inference scheduler.

modelNamestringmodel_namestrmodelNameStringModelNamestringModelName*stringrequired#

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

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

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

serverSideKmsKeyId?optionalstringserver_side_kms_key_id?optionalstrserverSideKmsKeyId?optionalStringServerSideKmsKeyId?optionalstringServerSideKmsKeyId?optional*string#

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

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

Any tags associated with the inference scheduler.

For more information, see Tag .