Package software.amazon.awscdk.services.lookoutequipment

Class CfnInferenceScheduler.Builder

java.lang.Object

software.amazon.awscdk.services.lookoutequipment.CfnInferenceScheduler.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInferenceScheduler>

Enclosing class:

CfnInferenceScheduler

@Stability(Stable)
public static final class CfnInferenceScheduler.Builder
extends Object
implements software.amazon.jsii.Builder<CfnInferenceScheduler>

A fluent builder for CfnInferenceScheduler.

Method Summary

Modifier and Type	Method	Description
CfnInferenceScheduler	build()
static CfnInferenceScheduler.Builder	create(software.constructs.Construct scope, String id)
CfnInferenceScheduler.Builder	dataDelayOffsetInMinutes(Number dataDelayOffsetInMinutes)	A period of time (in minutes) by which inference on the data is delayed after the data starts.
CfnInferenceScheduler.Builder	dataInputConfiguration(Object dataInputConfiguration)	Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
CfnInferenceScheduler.Builder	dataOutputConfiguration(Object dataOutputConfiguration)	Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
CfnInferenceScheduler.Builder	dataUploadFrequency(String dataUploadFrequency)	How often data is uploaded to the source S3 bucket for the input data.
CfnInferenceScheduler.Builder	inferenceSchedulerName(String inferenceSchedulerName)	The name of the inference scheduler.
CfnInferenceScheduler.Builder	modelName(String modelName)	The name of the machine learning model used for the inference scheduler.
CfnInferenceScheduler.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
CfnInferenceScheduler.Builder	serverSideKmsKeyId(String serverSideKmsKeyId)	Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .
CfnInferenceScheduler.Builder	tags(List<? extends CfnTag> tags)	Any tags associated with the inference scheduler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnInferenceScheduler.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnInferenceScheduler.Builder.

dataInputConfiguration

@Stability(Stable)
public CfnInferenceScheduler.Builder dataInputConfiguration(Object dataInputConfiguration)

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

Parameters:

dataInputConfiguration - Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location. This parameter is required.

Returns:

this

See Also:

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

dataOutputConfiguration

@Stability(Stable)
public CfnInferenceScheduler.Builder dataOutputConfiguration(Object dataOutputConfiguration)

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

Parameters:

dataOutputConfiguration - Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output. This parameter is required.

Returns:

this

See Also:

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

dataUploadFrequency

@Stability(Stable)
public CfnInferenceScheduler.Builder dataUploadFrequency(String dataUploadFrequency)

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.

Parameters:

dataUploadFrequency - How often data is uploaded to the source S3 bucket for the input data. This parameter is required.

Returns:

this

See Also:

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

modelName

@Stability(Stable)
public CfnInferenceScheduler.Builder modelName(String modelName)

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

Parameters:

modelName - The name of the machine learning model used for the inference scheduler. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnInferenceScheduler.Builder roleArn(String roleArn)

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

Parameters:

roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference. This parameter is required.

Returns:

this

See Also:

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

dataDelayOffsetInMinutes

@Stability(Stable)
public CfnInferenceScheduler.Builder dataDelayOffsetInMinutes(Number dataDelayOffsetInMinutes)

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.

Parameters:

dataDelayOffsetInMinutes - A period of time (in minutes) by which inference on the data is delayed after the data starts. This parameter is required.

Returns:

this

See Also:

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

inferenceSchedulerName

@Stability(Stable)
public CfnInferenceScheduler.Builder inferenceSchedulerName(String inferenceSchedulerName)

The name of the inference scheduler.

Parameters:

inferenceSchedulerName - The name of the inference scheduler. This parameter is required.

Returns:

this

See Also:

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

serverSideKmsKeyId

@Stability(Stable)
public CfnInferenceScheduler.Builder serverSideKmsKeyId(String serverSideKmsKeyId)

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

Parameters:

serverSideKmsKeyId - Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment . This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnInferenceScheduler.Builder tags(List<? extends CfnTag> tags)

Any tags associated with the inference scheduler.

For more information, see Tag .

Parameters:

tags - Any tags associated with the inference scheduler. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnInferenceScheduler build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnInferenceScheduler>

Returns:

a newly built instance of CfnInferenceScheduler.