aws-cdk-lib.aws_lookoutequipment.CfnInferenceScheduler

class CfnInferenceScheduler (construct)

LanguageType name
.NETAmazon.CDK.AWS.LookoutEquipment.CfnInferenceScheduler
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslookoutequipment#CfnInferenceScheduler
Javasoftware.amazon.awscdk.services.lookoutequipment.CfnInferenceScheduler
Pythonaws_cdk.aws_lookoutequipment.CfnInferenceScheduler
TypeScript aws-cdk-lib » aws_lookoutequipment » CfnInferenceScheduler

Implements IConstruct, IDependable, 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 { aws_lookoutequipment as lookoutequipment } from 'aws-cdk-lib';

declare const dataInputConfiguration: any;
declare const dataOutputConfiguration: any;
const cfnInferenceScheduler = new lookoutequipment.CfnInferenceScheduler(this, 'MyCfnInferenceScheduler', {
  dataInputConfiguration: dataInputConfiguration,
  dataOutputConfiguration: dataOutputConfiguration,
  dataUploadFrequency: 'dataUploadFrequency',
  modelName: 'modelName',
  roleArn: 'roleArn',

  // the properties below are optional
  dataDelayOffsetInMinutes: 123,
  inferenceSchedulerName: 'inferenceSchedulerName',
  serverSideKmsKeyId: 'serverSideKmsKeyId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnInferenceScheduler(scope: Construct, id: string, props: CfnInferenceSchedulerProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnInferenceSchedulerProps — - resource properties.

Create a new AWS::LookoutEquipment::InferenceScheduler.

Construct Props

NameTypeDescription
dataInputConfigurationanySpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
dataOutputConfigurationanySpecifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
dataUploadFrequencystringHow often data is uploaded to the source S3 bucket for the input data.
modelNamestringThe name of the ML model used for the inference scheduler.
roleArnstringThe Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
dataDelayOffsetInMinutes?numberA period of time (in minutes) by which inference on the data is delayed after the data starts.
inferenceSchedulerName?stringThe name of the inference scheduler.
serverSideKmsKeyId?stringProvides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .
tags?CfnTag[]Any tags associated with the inference scheduler.

dataInputConfiguration

Type: any

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


dataOutputConfiguration

Type: any

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


dataUploadFrequency

Type: string

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.


modelName

Type: string

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


roleArn

Type: string

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


dataDelayOffsetInMinutes?

Type: number (optional)

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.


inferenceSchedulerName?

Type: string (optional)

The name of the inference scheduler.


serverSideKmsKeyId?

Type: string (optional)

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


tags?

Type: CfnTag[] (optional)

Any tags associated with the inference scheduler.

For more information, see Tag .

Properties

NameTypeDescription
attrInferenceSchedulerArnstringThe Amazon Resource Name (ARN) of the inference scheduler being created.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
dataInputConfigurationanySpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
dataOutputConfigurationanySpecifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
dataUploadFrequencystringHow often data is uploaded to the source S3 bucket for the input data.
logicalIdstringThe logical ID for this CloudFormation stack element.
modelNamestringThe name of the ML model used for the inference scheduler.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
roleArnstringThe Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
stackStackThe stack in which this element is defined.
tagsTagManagerAny tags associated with the inference scheduler.
dataDelayOffsetInMinutes?numberA period of time (in minutes) by which inference on the data is delayed after the data starts.
inferenceSchedulerName?stringThe name of the inference scheduler.
serverSideKmsKeyId?stringProvides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrInferenceSchedulerArn

Type: string

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


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


dataInputConfiguration

Type: any

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


dataOutputConfiguration

Type: any

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


dataUploadFrequency

Type: string

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.


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


modelName

Type: string

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


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


roleArn

Type: string

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


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

Any tags associated with the inference scheduler.

For more information, see Tag .


dataDelayOffsetInMinutes?

Type: number (optional)

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.


inferenceSchedulerName?

Type: string (optional)

The name of the inference scheduler.


serverSideKmsKeyId?

Type: string (optional)

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


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }