Package software.amazon.awscdk.services.lookoutequipment

Interface CfnInferenceSchedulerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInferenceSchedulerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.622Z")
@Stability(Stable)
public interface CfnInferenceSchedulerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnInferenceScheduler.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lookoutequipment.*;
 Object dataInputConfiguration;
 Object dataOutputConfiguration;
 CfnInferenceSchedulerProps cfnInferenceSchedulerProps = CfnInferenceSchedulerProps.builder()
         .dataInputConfiguration(dataInputConfiguration)
         .dataOutputConfiguration(dataOutputConfiguration)
         .dataUploadFrequency("dataUploadFrequency")
         .modelName("modelName")
         .roleArn("roleArn")
         // the properties below are optional
         .dataDelayOffsetInMinutes(123)
         .inferenceSchedulerName("inferenceSchedulerName")
         .serverSideKmsKeyId("serverSideKmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInferenceSchedulerProps.Builder	A builder for CfnInferenceSchedulerProps
static final class	CfnInferenceSchedulerProps.Jsii$Proxy	An implementation for CfnInferenceSchedulerProps

Method Summary

Modifier and Type	Method	Description
static CfnInferenceSchedulerProps.Builder	builder()
default Number	getDataDelayOffsetInMinutes()	A period of time (in minutes) by which inference on the data is delayed after the data starts.
Object	getDataInputConfiguration()	Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
Object	getDataOutputConfiguration()	Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
String	getDataUploadFrequency()	How often data is uploaded to the source S3 bucket for the input data.
default String	getInferenceSchedulerName()	The name of the inference scheduler.
String	getModelName()	The name of the machine learning model used for the inference scheduler.
String	getRoleArn()	The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
default String	getServerSideKmsKeyId()	Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .
default List<CfnTag>	getTags()	Any tags associated with the inference scheduler.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataInputConfiguration

@Stability(Stable)
@NotNull
Object getDataInputConfiguration()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-datainputconfiguration

getDataOutputConfiguration

@Stability(Stable)
@NotNull
Object getDataOutputConfiguration()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-dataoutputconfiguration

getDataUploadFrequency

@Stability(Stable)
@NotNull
String getDataUploadFrequency()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-datauploadfrequency

getModelName

@Stability(Stable)
@NotNull
String getModelName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-modelname

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-rolearn

getDataDelayOffsetInMinutes

@Stability(Stable)
@Nullable
default Number getDataDelayOffsetInMinutes()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-datadelayoffsetinminutes

getInferenceSchedulerName

@Stability(Stable)
@Nullable
default String getInferenceSchedulerName()

The name of the inference scheduler.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-inferenceschedulername

getServerSideKmsKeyId

@Stability(Stable)
@Nullable
default String getServerSideKmsKeyId()

Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-serversidekmskeyid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Any tags associated with the inference scheduler.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html#cfn-lookoutequipment-inferencescheduler-tags

builder

@Stability(Stable)
static CfnInferenceSchedulerProps.Builder builder()

Returns:

a CfnInferenceSchedulerProps.Builder of CfnInferenceSchedulerProps