software.amazon.awscdk.services.lookoutequipment

Class CfnInferenceScheduler

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lookoutequipment.CfnInferenceScheduler

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.729Z")
 @Stability(value=Stable)
public class CfnInferenceScheduler
extends CfnResource
implements IInspectable

A CloudFormation `AWS::LookoutEquipment::InferenceScheduler`.

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 AWS 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.

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;
 CfnInferenceScheduler cfnInferenceScheduler = CfnInferenceScheduler.Builder.create(this, "MyCfnInferenceScheduler")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnInferenceScheduler.Builder A fluent builder for CfnInferenceScheduler.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnInferenceScheduler(software.constructs.Construct scope, String id, CfnInferenceSchedulerProps props) Create a new `AWS::LookoutEquipment::InferenceScheduler`.
protected	CfnInferenceScheduler(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInferenceScheduler(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrInferenceSchedulerArn() The Amazon Resource Name (ARN) of the inference scheduler being created.
protected Map<String,Object>	getCfnProperties()
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.
String	getInferenceSchedulerName() The name of the inference scheduler.
String	getModelName() The name of the ML 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.
String	getServerSideKmsKeyId() Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .
TagManager	getTags() Any tags associated with the inference scheduler.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataDelayOffsetInMinutes(Number value) A period of time (in minutes) by which inference on the data is delayed after the data starts.
void	setDataInputConfiguration(Object value) Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
void	setDataOutputConfiguration(Object value) Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
void	setDataUploadFrequency(String value) How often data is uploaded to the source S3 bucket for the input data.
void	setInferenceSchedulerName(String value) The name of the inference scheduler.
void	setModelName(String value) The name of the ML model used for the inference scheduler.
void	setRoleArn(String value) The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
void	setServerSideKmsKeyId(String value) Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnInferenceScheduler

protected CfnInferenceScheduler(software.amazon.jsii.JsiiObjectRef objRef)

CfnInferenceScheduler

protected CfnInferenceScheduler(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnInferenceScheduler

@Stability(value=Stable)
public CfnInferenceScheduler(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      CfnInferenceSchedulerProps props)

Create a new `AWS::LookoutEquipment::InferenceScheduler`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrInferenceSchedulerArn

@Stability(value=Stable)
 @NotNull
public String getAttrInferenceSchedulerArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Any tags associated with the inference scheduler.

For more information, see Tag .

getDataInputConfiguration

@Stability(value=Stable)
 @NotNull
public Object getDataInputConfiguration()

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

setDataInputConfiguration

@Stability(value=Stable)
public void setDataInputConfiguration(@NotNull
                                                               Object value)

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

getDataOutputConfiguration

@Stability(value=Stable)
 @NotNull
public Object getDataOutputConfiguration()

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

setDataOutputConfiguration

@Stability(value=Stable)
public void setDataOutputConfiguration(@NotNull
                                                                Object value)

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

getDataUploadFrequency

@Stability(value=Stable)
 @NotNull
public 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.

setDataUploadFrequency

@Stability(value=Stable)
public void setDataUploadFrequency(@NotNull
                                                            String value)

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.

getModelName

@Stability(value=Stable)
 @NotNull
public String getModelName()

The name of the ML model used for the inference scheduler.

setModelName

@Stability(value=Stable)
public void setModelName(@NotNull
                                                  String value)

The name of the ML model used for the inference scheduler.

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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

getDataDelayOffsetInMinutes

@Stability(value=Stable)
 @Nullable
public 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.

setDataDelayOffsetInMinutes

@Stability(value=Stable)
public void setDataDelayOffsetInMinutes(@Nullable
                                                                 Number value)

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.

getInferenceSchedulerName

@Stability(value=Stable)
 @Nullable
public String getInferenceSchedulerName()

The name of the inference scheduler.

setInferenceSchedulerName

@Stability(value=Stable)
public void setInferenceSchedulerName(@Nullable
                                                               String value)

The name of the inference scheduler.

getServerSideKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getServerSideKmsKeyId()

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

setServerSideKmsKeyId

@Stability(value=Stable)
public void setServerSideKmsKeyId(@Nullable
                                                           String value)

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