CfnInferenceSchedulerPropsMixin

class aws_cdk.mixins_preview.aws_lookoutequipment.mixins.CfnInferenceSchedulerPropsMixin(props, *, strategy=None)

Bases: Mixin

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. .. epigraph:

Updating some properties below (for example, InferenceSchedulerName and ServerSideKmsKeyId) triggers a resource replacement, which requires a new model. To replace such a property using 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lookoutequipment-inferencescheduler.html
CloudformationResource:: AWS::LookoutEquipment::InferenceScheduler
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_lookoutequipment import mixins as lookoutequipment_mixins

# data_input_configuration: Any
# data_output_configuration: Any

cfn_inference_scheduler_props_mixin = lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin(lookoutequipment_mixins.CfnInferenceSchedulerMixinProps(
    data_delay_offset_in_minutes=123,
    data_input_configuration=data_input_configuration,
    data_output_configuration=data_output_configuration,
    data_upload_frequency="dataUploadFrequency",
    inference_scheduler_name="inferenceSchedulerName",
    model_name="modelName",
    role_arn="roleArn",
    server_side_kms_key_id="serverSideKmsKeyId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::LookoutEquipment::InferenceScheduler.

Parameters:

props (Union[CfnInferenceSchedulerMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['dataDelayOffsetInMinutes', 'dataInputConfiguration', 'dataOutputConfiguration', 'dataUploadFrequency', 'inferenceSchedulerName', 'modelName', 'roleArn', 'serverSideKmsKeyId', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DataInputConfigurationProperty

class CfnInferenceSchedulerPropsMixin.DataInputConfigurationProperty(*, inference_input_name_configuration=None, input_time_zone_offset=None, s3_input_configuration=None)

Bases: object

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

Parameters:

inference_input_name_configuration (Union[IResolvable, InputNameConfigurationProperty, Dict[str, Any], None]) – Specifies configuration information for the input data for the inference, including timestamp format and delimiter.
input_time_zone_offset (Optional[str]) – Indicates the difference between your time zone and Greenwich Mean Time (GMT).
s3_input_configuration (Union[IResolvable, S3InputConfigurationProperty, Dict[str, Any], None]) – Specifies configuration information for the input data for the inference, including input data S3 location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-datainputconfiguration.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.mixins_preview.aws_lookoutequipment import mixins as lookoutequipment_mixins

data_input_configuration_property = lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin.DataInputConfigurationProperty(
    inference_input_name_configuration=lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin.InputNameConfigurationProperty(
        component_timestamp_delimiter="componentTimestampDelimiter",
        timestamp_format="timestampFormat"
    ),
    input_time_zone_offset="inputTimeZoneOffset",
    s3_input_configuration=lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin.S3InputConfigurationProperty(
        bucket="bucket",
        prefix="prefix"
    )
)

Attributes

inference_input_name_configuration

Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

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

input_time_zone_offset

Indicates the difference between your time zone and Greenwich Mean Time (GMT).

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

s3_input_configuration

Specifies configuration information for the input data for the inference, including input data S3 location.

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

DataOutputConfigurationProperty

class CfnInferenceSchedulerPropsMixin.DataOutputConfigurationProperty(*, kms_key_id=None, s3_output_configuration=None)

Bases: object

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

Parameters:

kms_key_id (Optional[str]) – The ID number for the AWS KMS key used to encrypt the inference output.
s3_output_configuration (Union[IResolvable, S3OutputConfigurationProperty, Dict[str, Any], None]) – Specifies configuration information for the output results from the inference, including output S3 location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-dataoutputconfiguration.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.mixins_preview.aws_lookoutequipment import mixins as lookoutequipment_mixins

data_output_configuration_property = lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin.DataOutputConfigurationProperty(
    kms_key_id="kmsKeyId",
    s3_output_configuration=lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin.S3OutputConfigurationProperty(
        bucket="bucket",
        prefix="prefix"
    )
)

Attributes

kms_key_id

The ID number for the AWS KMS key used to encrypt the inference output.

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

s3_output_configuration

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

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

InputNameConfigurationProperty

class CfnInferenceSchedulerPropsMixin.InputNameConfigurationProperty(*, component_timestamp_delimiter=None, timestamp_format=None)

Bases: object

Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

Parameters:

component_timestamp_delimiter (Optional[str]) – Indicates the delimiter character used between items in the data.
timestamp_format (Optional[str]) – The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-inputnameconfiguration.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.mixins_preview.aws_lookoutequipment import mixins as lookoutequipment_mixins

input_name_configuration_property = lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin.InputNameConfigurationProperty(
    component_timestamp_delimiter="componentTimestampDelimiter",
    timestamp_format="timestampFormat"
)

Attributes

component_timestamp_delimiter

Indicates the delimiter character used between items in the data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-inputnameconfiguration.html#cfn-lookoutequipment-inferencescheduler-inputnameconfiguration-componenttimestampdelimiter

timestamp_format

The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-inputnameconfiguration.html#cfn-lookoutequipment-inferencescheduler-inputnameconfiguration-timestampformat

S3InputConfigurationProperty

class CfnInferenceSchedulerPropsMixin.S3InputConfigurationProperty(*, bucket=None, prefix=None)

Bases: object

Specifies configuration information for the input data for the inference, including input data S3 location.

Parameters:

bucket (Optional[str])
prefix (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3inputconfiguration.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.mixins_preview.aws_lookoutequipment import mixins as lookoutequipment_mixins

s3_input_configuration_property = lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin.S3InputConfigurationProperty(
    bucket="bucket",
    prefix="prefix"
)

Attributes

bucket

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3inputconfiguration.html#cfn-lookoutequipment-inferencescheduler-s3inputconfiguration-bucket

Type:: see

prefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3inputconfiguration.html#cfn-lookoutequipment-inferencescheduler-s3inputconfiguration-prefix

Type:: see

S3OutputConfigurationProperty

class CfnInferenceSchedulerPropsMixin.S3OutputConfigurationProperty(*, bucket=None, prefix=None)

Bases: object

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

Parameters:

bucket (Optional[str])
prefix (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3outputconfiguration.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.mixins_preview.aws_lookoutequipment import mixins as lookoutequipment_mixins

s3_output_configuration_property = lookoutequipment_mixins.CfnInferenceSchedulerPropsMixin.S3OutputConfigurationProperty(
    bucket="bucket",
    prefix="prefix"
)

Attributes

bucket

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3outputconfiguration.html#cfn-lookoutequipment-inferencescheduler-s3outputconfiguration-bucket

Type:: see

prefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3outputconfiguration.html#cfn-lookoutequipment-inferencescheduler-s3outputconfiguration-prefix

Type:: see