@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:17.584Z") public class CfnInferenceScheduler extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnInferenceScheduler.Builder
A fluent builder for
CfnInferenceScheduler . |
static interface |
CfnInferenceScheduler.DataInputConfigurationProperty
Example:
|
static interface |
CfnInferenceScheduler.DataOutputConfigurationProperty
Example:
|
static interface |
CfnInferenceScheduler.InputNameConfigurationProperty
Example:
|
static interface |
CfnInferenceScheduler.S3InputConfigurationProperty
Example:
|
static interface |
CfnInferenceScheduler.S3OutputConfigurationProperty
Example:
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnInferenceScheduler(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrInferenceSchedulerArn()
The Amazon Resource Name (ARN) of the inference scheduler being created.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Number |
getDataDelayOffsetInMinutes()
A period of time (in minutes) by which inference on the data is delayed after the data starts.
|
java.lang.Object |
getDataInputConfiguration()
Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
|
java.lang.Object |
getDataOutputConfiguration()
Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
|
java.lang.String |
getDataUploadFrequency()
How often data is uploaded to the source S3 bucket for the input data.
|
java.lang.String |
getInferenceSchedulerName()
The name of the inference scheduler.
|
java.lang.String |
getModelName()
The name of the ML model used for the inference scheduler.
|
java.lang.String |
getRoleArn()
The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDataDelayOffsetInMinutes(java.lang.Number value)
A period of time (in minutes) by which inference on the data is delayed after the data starts.
|
void |
setDataInputConfiguration(java.lang.Object value)
Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
|
void |
setDataOutputConfiguration(java.lang.Object value)
Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
|
void |
setDataUploadFrequency(java.lang.String value)
How often data is uploaded to the source S3 bucket for the input data.
|
void |
setInferenceSchedulerName(java.lang.String value)
The name of the inference scheduler.
|
void |
setModelName(java.lang.String value)
The name of the ML model used for the inference scheduler.
|
void |
setRoleArn(java.lang.String value)
The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
|
void |
setServerSideKmsKeyId(java.lang.String value)
Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnInferenceScheduler(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnInferenceScheduler(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnInferenceScheduler(Construct scope, java.lang.String id, CfnInferenceSchedulerProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrInferenceSchedulerArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.Object getDataInputConfiguration()
public void setDataInputConfiguration(java.lang.Object value)
public java.lang.Object getDataOutputConfiguration()
public void setDataOutputConfiguration(java.lang.Object value)
public java.lang.String getDataUploadFrequency()
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.
public void setDataUploadFrequency(java.lang.String value)
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.
public java.lang.String getModelName()
public void setModelName(java.lang.String value)
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)
public java.lang.Number getDataDelayOffsetInMinutes()
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.
public void setDataDelayOffsetInMinutes(java.lang.Number value)
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.
public java.lang.String getInferenceSchedulerName()
public void setInferenceSchedulerName(java.lang.String value)
public java.lang.String getServerSideKmsKeyId()
public void setServerSideKmsKeyId(java.lang.String value)