Class CfnInferenceScheduler
A CloudFormation AWS::LookoutEquipment::InferenceScheduler
.
Inherited Members
Namespace: Amazon.CDK.AWS.LookoutEquipment
Assembly: Amazon.CDK.AWS.LookoutEquipment.dll
Syntax (csharp)
public class CfnInferenceScheduler : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnInferenceScheduler
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::LookoutEquipment::InferenceScheduler
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.LookoutEquipment;
var dataInputConfiguration;
var dataOutputConfiguration;
var cfnInferenceScheduler = new CfnInferenceScheduler(this, "MyCfnInferenceScheduler", new CfnInferenceSchedulerProps {
DataInputConfiguration = dataInputConfiguration,
DataOutputConfiguration = dataOutputConfiguration,
DataUploadFrequency = "dataUploadFrequency",
ModelName = "modelName",
RoleArn = "roleArn",
// the properties below are optional
DataDelayOffsetInMinutes = 123,
InferenceSchedulerName = "inferenceSchedulerName",
ServerSideKmsKeyId = "serverSideKmsKeyId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnInferenceScheduler(Construct, String, ICfnInferenceSchedulerProps) | Create a new |
CfnInferenceScheduler(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnInferenceScheduler(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrInferenceSchedulerArn | The Amazon Resource Name (ARN) of the inference scheduler being created. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataDelayOffsetInMinutes | A period of time (in minutes) by which inference on the data is delayed after the data starts. |
DataInputConfiguration | Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location. |
DataOutputConfiguration | Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output. |
DataUploadFrequency | How often data is uploaded to the source S3 bucket for the input data. |
InferenceSchedulerName | The name of the inference scheduler. |
ModelName | The name of the ML model used for the inference scheduler. |
RoleArn | The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference. |
ServerSideKmsKeyId | Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment . |
Tags | Any tags associated with the inference scheduler. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnInferenceScheduler(Construct, String, ICfnInferenceSchedulerProps)
Create a new AWS::LookoutEquipment::InferenceScheduler
.
public CfnInferenceScheduler(Construct scope, string id, ICfnInferenceSchedulerProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnInferenceSchedulerProps
- resource properties.
CfnInferenceScheduler(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnInferenceScheduler(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnInferenceScheduler(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnInferenceScheduler(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrInferenceSchedulerArn
The Amazon Resource Name (ARN) of the inference scheduler being created.
public virtual string AttrInferenceSchedulerArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: InferenceSchedulerArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataDelayOffsetInMinutes
A period of time (in minutes) by which inference on the data is delayed after the data starts.
public virtual Nullable<double> DataDelayOffsetInMinutes { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
DataInputConfiguration
Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
public virtual object DataInputConfiguration { get; set; }
Property Value
System.Object
Remarks
DataOutputConfiguration
Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
public virtual object DataOutputConfiguration { get; set; }
Property Value
System.Object
Remarks
DataUploadFrequency
How often data is uploaded to the source S3 bucket for the input data.
public virtual string DataUploadFrequency { get; set; }
Property Value
System.String
Remarks
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
The name of the inference scheduler.
public virtual string InferenceSchedulerName { get; set; }
Property Value
System.String
Remarks
ModelName
The name of the ML model used for the inference scheduler.
public virtual string ModelName { get; set; }
Property Value
System.String
Remarks
RoleArn
The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
ServerSideKmsKeyId
Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .
public virtual string ServerSideKmsKeyId { get; set; }
Property Value
System.String
Remarks
Tags
Any tags associated with the inference scheduler.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>