CfnInferenceSchedulerProps

class aws_cdk.aws_lookoutequipment.CfnInferenceSchedulerProps(*, data_input_configuration, data_output_configuration, data_upload_frequency, model_name, role_arn, data_delay_offset_in_minutes=None, inference_scheduler_name=None, server_side_kms_key_id=None, tags=None)

Bases: object

Properties for defining a CfnInferenceScheduler.

Parameters:
  • data_input_configuration (Any) – Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

  • data_output_configuration (Any) – Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.

  • data_upload_frequency (str) – 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.

  • model_name (str) – The name of the machine learning model used for the inference scheduler.

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

  • data_delay_offset_in_minutes (Union[int, float, None]) – 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.

  • inference_scheduler_name (Optional[str]) – The name of the inference scheduler.

  • server_side_kms_key_id (Optional[str]) – Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Any tags associated with the inference scheduler. For more information, see Tag .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lookoutequipment as lookoutequipment

# data_input_configuration: Any
# data_output_configuration: Any

cfn_inference_scheduler_props = lookoutequipment.CfnInferenceSchedulerProps(
    data_input_configuration=data_input_configuration,
    data_output_configuration=data_output_configuration,
    data_upload_frequency="dataUploadFrequency",
    model_name="modelName",
    role_arn="roleArn",

    # the properties below are optional
    data_delay_offset_in_minutes=123,
    inference_scheduler_name="inferenceSchedulerName",
    server_side_kms_key_id="serverSideKmsKeyId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

data_delay_offset_in_minutes

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:

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

data_input_configuration

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

See:

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

data_output_configuration

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

See:

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

data_upload_frequency

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:

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

inference_scheduler_name

The name of the inference scheduler.

See:

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

model_name

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

See:

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

role_arn

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

See:

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

server_side_kms_key_id

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

See:

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

tags

Any tags associated with the inference scheduler.

For more information, see Tag .

See:

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