awslookoutequipment

Documentation

Index

• func CfnInferenceScheduler_CFN_RESOURCE_TYPE_NAME() *string
• func CfnInferenceScheduler_IsCfnElement(x interface{}) *bool
• func CfnInferenceScheduler_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnInferenceScheduler_IsConstruct(x interface{}) *bool
• func NewCfnInferenceScheduler_Override(c CfnInferenceScheduler, scope constructs.Construct, id *string, ...)
• type CfnInferenceScheduler
  • func NewCfnInferenceScheduler(scope constructs.Construct, id *string, props *CfnInferenceSchedulerProps) CfnInferenceScheduler
• type CfnInferenceSchedulerProps

Functions

func CfnInferenceScheduler_CFN_RESOURCE_TYPE_NAME

func CfnInferenceScheduler_CFN_RESOURCE_TYPE_NAME() *string

func CfnInferenceScheduler_IsCfnElement

func CfnInferenceScheduler_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnInferenceScheduler_IsCfnResource

func CfnInferenceScheduler_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnInferenceScheduler_IsConstruct

func CfnInferenceScheduler_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnInferenceScheduler_Override

func NewCfnInferenceScheduler_Override(c CfnInferenceScheduler, scope constructs.Construct, id *string, props *CfnInferenceSchedulerProps)

Create a new `AWS::LookoutEquipment::InferenceScheduler`.

Types

type CfnInferenceScheduler

type CfnInferenceScheduler interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrInferenceSchedulerArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataDelayOffsetInMinutes() *float64
	SetDataDelayOffsetInMinutes(val *float64)
	DataInputConfiguration() interface{}
	SetDataInputConfiguration(val interface{})
	DataOutputConfiguration() interface{}
	SetDataOutputConfiguration(val interface{})
	DataUploadFrequency() *string
	SetDataUploadFrequency(val *string)
	InferenceSchedulerName() *string
	SetInferenceSchedulerName(val *string)
	LogicalId() *string
	ModelName() *string
	SetModelName(val *string)
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	ServerSideKmsKeyId() *string
	SetServerSideKmsKeyId(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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.

TODO: EXAMPLE

func NewCfnInferenceScheduler

func NewCfnInferenceScheduler(scope constructs.Construct, id *string, props *CfnInferenceSchedulerProps) CfnInferenceScheduler

Create a new `AWS::LookoutEquipment::InferenceScheduler`.

type CfnInferenceSchedulerProps

type CfnInferenceSchedulerProps struct {
	// Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
	DataInputConfiguration interface{} `json:"dataInputConfiguration" yaml:"dataInputConfiguration"`
	// Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output.
	DataOutputConfiguration interface{} `json:"dataOutputConfiguration" yaml:"dataOutputConfiguration"`
	// 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.
	DataUploadFrequency *string `json:"dataUploadFrequency" yaml:"dataUploadFrequency"`
	// The name of the ML model used for the inference scheduler.
	ModelName *string `json:"modelName" yaml:"modelName"`
	// The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// 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.
	DataDelayOffsetInMinutes *float64 `json:"dataDelayOffsetInMinutes" yaml:"dataDelayOffsetInMinutes"`
	// The name of the inference scheduler.
	InferenceSchedulerName *string `json:"inferenceSchedulerName" yaml:"inferenceSchedulerName"`
	// Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment .
	ServerSideKmsKeyId *string `json:"serverSideKmsKeyId" yaml:"serverSideKmsKeyId"`
	// Any tags associated with the inference scheduler.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnInferenceScheduler`.

TODO: EXAMPLE