Documentation ¶
Index ¶
- func CfnAlarmModel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAlarmModel_IsCfnElement(x interface{}) *bool
- func CfnAlarmModel_IsCfnResource(x interface{}) *bool
- func CfnAlarmModel_IsConstruct(x interface{}) *bool
- func CfnDetectorModel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDetectorModel_IsCfnElement(x interface{}) *bool
- func CfnDetectorModel_IsCfnResource(x interface{}) *bool
- func CfnDetectorModel_IsConstruct(x interface{}) *bool
- func CfnInput_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInput_IsCfnElement(x interface{}) *bool
- func CfnInput_IsCfnResource(x interface{}) *bool
- func CfnInput_IsConstruct(x interface{}) *bool
- func NewCfnAlarmModel_Override(c CfnAlarmModel, scope constructs.Construct, id *string, ...)
- func NewCfnDetectorModel_Override(c CfnDetectorModel, scope constructs.Construct, id *string, ...)
- func NewCfnInput_Override(c CfnInput, scope constructs.Construct, id *string, props *CfnInputProps)
- type CfnAlarmModel
- type CfnAlarmModelProps
- type CfnAlarmModel_AcknowledgeFlowProperty
- type CfnAlarmModel_AlarmActionProperty
- type CfnAlarmModel_AlarmCapabilitiesProperty
- type CfnAlarmModel_AlarmEventActionsProperty
- type CfnAlarmModel_AlarmRuleProperty
- type CfnAlarmModel_AssetPropertyTimestampProperty
- type CfnAlarmModel_AssetPropertyValueProperty
- type CfnAlarmModel_AssetPropertyVariantProperty
- type CfnAlarmModel_DynamoDBProperty
- type CfnAlarmModel_DynamoDBv2Property
- type CfnAlarmModel_FirehoseProperty
- type CfnAlarmModel_InitializationConfigurationProperty
- type CfnAlarmModel_IotEventsProperty
- type CfnAlarmModel_IotSiteWiseProperty
- type CfnAlarmModel_IotTopicPublishProperty
- type CfnAlarmModel_LambdaProperty
- type CfnAlarmModel_PayloadProperty
- type CfnAlarmModel_SimpleRuleProperty
- type CfnAlarmModel_SnsProperty
- type CfnAlarmModel_SqsProperty
- type CfnDetectorModel
- type CfnDetectorModelProps
- type CfnDetectorModel_ActionProperty
- type CfnDetectorModel_AssetPropertyTimestampProperty
- type CfnDetectorModel_AssetPropertyValueProperty
- type CfnDetectorModel_AssetPropertyVariantProperty
- type CfnDetectorModel_ClearTimerProperty
- type CfnDetectorModel_DetectorModelDefinitionProperty
- type CfnDetectorModel_DynamoDBProperty
- type CfnDetectorModel_DynamoDBv2Property
- type CfnDetectorModel_EventProperty
- type CfnDetectorModel_FirehoseProperty
- type CfnDetectorModel_IotEventsProperty
- type CfnDetectorModel_IotSiteWiseProperty
- type CfnDetectorModel_IotTopicPublishProperty
- type CfnDetectorModel_LambdaProperty
- type CfnDetectorModel_OnEnterProperty
- type CfnDetectorModel_OnExitProperty
- type CfnDetectorModel_OnInputProperty
- type CfnDetectorModel_PayloadProperty
- type CfnDetectorModel_ResetTimerProperty
- type CfnDetectorModel_SetTimerProperty
- type CfnDetectorModel_SetVariableProperty
- type CfnDetectorModel_SnsProperty
- type CfnDetectorModel_SqsProperty
- type CfnDetectorModel_StateProperty
- type CfnDetectorModel_TransitionEventProperty
- type CfnInput
- type CfnInputProps
- type CfnInput_AttributeProperty
- type CfnInput_InputDefinitionProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAlarmModel_CFN_RESOURCE_TYPE_NAME ¶ added in v2.18.0
func CfnAlarmModel_CFN_RESOURCE_TYPE_NAME() *string
func CfnAlarmModel_IsCfnElement ¶ added in v2.18.0
func CfnAlarmModel_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 CfnAlarmModel_IsCfnResource ¶ added in v2.18.0
func CfnAlarmModel_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAlarmModel_IsConstruct ¶ added in v2.18.0
func CfnAlarmModel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnDetectorModel_CFN_RESOURCE_TYPE_NAME ¶
func CfnDetectorModel_CFN_RESOURCE_TYPE_NAME() *string
func CfnDetectorModel_IsCfnElement ¶
func CfnDetectorModel_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 CfnDetectorModel_IsCfnResource ¶
func CfnDetectorModel_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDetectorModel_IsConstruct ¶
func CfnDetectorModel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnInput_CFN_RESOURCE_TYPE_NAME ¶
func CfnInput_CFN_RESOURCE_TYPE_NAME() *string
func CfnInput_IsCfnElement ¶
func CfnInput_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 CfnInput_IsCfnResource ¶
func CfnInput_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInput_IsConstruct ¶
func CfnInput_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnAlarmModel_Override ¶ added in v2.18.0
func NewCfnAlarmModel_Override(c CfnAlarmModel, scope constructs.Construct, id *string, props *CfnAlarmModelProps)
func NewCfnDetectorModel_Override ¶
func NewCfnDetectorModel_Override(c CfnDetectorModel, scope constructs.Construct, id *string, props *CfnDetectorModelProps)
func NewCfnInput_Override ¶
func NewCfnInput_Override(c CfnInput, scope constructs.Construct, id *string, props *CfnInputProps)
Types ¶
type CfnAlarmModel ¶ added in v2.18.0
type CfnAlarmModel interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Contains the configuration information of alarm state changes. AlarmCapabilities() interface{} SetAlarmCapabilities(val interface{}) // Contains information about one or more alarm actions. AlarmEventActions() interface{} SetAlarmEventActions(val interface{}) // The description of the alarm model. AlarmModelDescription() *string SetAlarmModelDescription(val *string) // The name of the alarm model. AlarmModelName() *string SetAlarmModelName(val *string) // Defines when your alarm is invoked. AlarmRule() interface{} SetAlarmRule(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // An input attribute used as a key to create an alarm. Key() *string SetKey(val *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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. RoleArn() *string SetRoleArn(val *string) // A non-negative integer that reflects the severity level of the alarm. Severity() *float64 SetSeverity(val *float64) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of key-value pairs that contain metadata for the alarm model. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Represents an alarm model to monitor an AWS IoT Events input attribute.
You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *AWS IoT Events Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAlarmModel := awscdk.Aws_iotevents.NewCfnAlarmModel(this, jsii.String("MyCfnAlarmModel"), &CfnAlarmModelProps{ AlarmRule: &AlarmRuleProperty{ SimpleRule: &SimpleRuleProperty{ ComparisonOperator: jsii.String("comparisonOperator"), InputProperty: jsii.String("inputProperty"), Threshold: jsii.String("threshold"), }, }, RoleArn: jsii.String("roleArn"), // the properties below are optional AlarmCapabilities: &AlarmCapabilitiesProperty{ AcknowledgeFlow: &AcknowledgeFlowProperty{ Enabled: jsii.Boolean(false), }, InitializationConfiguration: &InitializationConfigurationProperty{ DisabledOnInitialization: jsii.Boolean(false), }, }, AlarmEventActions: &AlarmEventActionsProperty{ AlarmActions: []interface{}{ &AlarmActionProperty{ DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, }, AlarmModelDescription: jsii.String("alarmModelDescription"), AlarmModelName: jsii.String("alarmModelName"), Key: jsii.String("key"), Severity: jsii.Number(123), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html
func NewCfnAlarmModel ¶ added in v2.18.0
func NewCfnAlarmModel(scope constructs.Construct, id *string, props *CfnAlarmModelProps) CfnAlarmModel
type CfnAlarmModelProps ¶ added in v2.18.0
type CfnAlarmModelProps struct { // Defines when your alarm is invoked. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmrule // AlarmRule interface{} `field:"required" json:"alarmRule" yaml:"alarmRule"` // The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. // // For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // Contains the configuration information of alarm state changes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmcapabilities // AlarmCapabilities interface{} `field:"optional" json:"alarmCapabilities" yaml:"alarmCapabilities"` // Contains information about one or more alarm actions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmeventactions // AlarmEventActions interface{} `field:"optional" json:"alarmEventActions" yaml:"alarmEventActions"` // The description of the alarm model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmmodeldescription // AlarmModelDescription *string `field:"optional" json:"alarmModelDescription" yaml:"alarmModelDescription"` // The name of the alarm model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmmodelname // AlarmModelName *string `field:"optional" json:"alarmModelName" yaml:"alarmModelName"` // An input attribute used as a key to create an alarm. // // AWS IoT Events routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-key // Key *string `field:"optional" json:"key" yaml:"key"` // A non-negative integer that reflects the severity level of the alarm. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-severity // Severity *float64 `field:"optional" json:"severity" yaml:"severity"` // A list of key-value pairs that contain metadata for the alarm model. // // The tags help you manage the alarm model. For more information, see [Tagging your AWS IoT Events resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *AWS IoT Events Developer Guide* . // // You can create up to 50 tags for one alarm model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnAlarmModel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAlarmModelProps := &CfnAlarmModelProps{ AlarmRule: &AlarmRuleProperty{ SimpleRule: &SimpleRuleProperty{ ComparisonOperator: jsii.String("comparisonOperator"), InputProperty: jsii.String("inputProperty"), Threshold: jsii.String("threshold"), }, }, RoleArn: jsii.String("roleArn"), // the properties below are optional AlarmCapabilities: &AlarmCapabilitiesProperty{ AcknowledgeFlow: &AcknowledgeFlowProperty{ Enabled: jsii.Boolean(false), }, InitializationConfiguration: &InitializationConfigurationProperty{ DisabledOnInitialization: jsii.Boolean(false), }, }, AlarmEventActions: &AlarmEventActionsProperty{ AlarmActions: []interface{}{ &AlarmActionProperty{ DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, }, AlarmModelDescription: jsii.String("alarmModelDescription"), AlarmModelName: jsii.String("alarmModelName"), Key: jsii.String("key"), Severity: jsii.Number(123), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html
type CfnAlarmModel_AcknowledgeFlowProperty ¶ added in v2.18.0
type CfnAlarmModel_AcknowledgeFlowProperty struct { // The value must be `TRUE` or `FALSE` . // // If `TRUE` , you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to `NORMAL` . If `FALSE` , you won't receive notifications. The alarm automatically changes to the `NORMAL` state when the input property value returns to the specified range. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html#cfn-iotevents-alarmmodel-acknowledgeflow-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` }
Specifies whether to get notified for alarm state changes.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" acknowledgeFlowProperty := &AcknowledgeFlowProperty{ Enabled: jsii.Boolean(false), }
type CfnAlarmModel_AlarmActionProperty ¶ added in v2.18.0
type CfnAlarmModel_AlarmActionProperty struct { // Defines an action to write to the Amazon DynamoDB table that you created. // // The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. // // You must use expressions for all parameters in `DynamoDBAction` . The expressions accept literals, operators, functions, references, and substitution templates. // // **Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `hashKeyType` parameter can be `'STRING'` . // - For references, you must specify either variables or input values. For example, the value for the `hashKeyField` parameter can be `$input.GreenhouseInput.name` . // - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. // // In the following example, the value for the `hashKeyValue` parameter uses a substitution template. // // `'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'` // - For a string concatenation, you must use `+` . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. // // In the following example, the value for the `tableName` parameter uses a string concatenation. // // `'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date` // // For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* . // // If the defined payload type is a string, `DynamoDBAction` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the `payloadField` parameter is `<payload-field>_raw` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-dynamodb // DynamoDb interface{} `field:"optional" json:"dynamoDb" yaml:"dynamoDb"` // Defines an action to write to the Amazon DynamoDB table that you created. // // The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. // // You must use expressions for all parameters in `DynamoDBv2Action` . The expressions accept literals, operators, functions, references, and substitution templates. // // **Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `tableName` parameter can be `'GreenhouseTemperatureTable'` . // - For references, you must specify either variables or input values. For example, the value for the `tableName` parameter can be `$variable.ddbtableName` . // - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. // // In the following example, the value for the `contentExpression` parameter in `Payload` uses a substitution template. // // `'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'` // - For a string concatenation, you must use `+` . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. // // In the following example, the value for the `tableName` parameter uses a string concatenation. // // `'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date` // // For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* . // // The value for the `type` parameter in `Payload` must be `JSON` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-dynamodbv2 // DynamoDBv2 interface{} `field:"optional" json:"dynamoDBv2" yaml:"dynamoDBv2"` // Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-firehose // Firehose interface{} `field:"optional" json:"firehose" yaml:"firehose"` // Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iotevents // IotEvents interface{} `field:"optional" json:"iotEvents" yaml:"iotEvents"` // Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise . // // You must use expressions for all parameters in `IotSiteWiseAction` . The expressions accept literals, operators, functions, references, and substitutions templates. // // **Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `propertyAlias` parameter can be `'/company/windfarm/3/turbine/7/temperature'` . // - For references, you must specify either variables or input values. For example, the value for the `assetId` parameter can be `$input.TurbineInput.assetId1` . // - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. // // In the following example, the value for the `propertyAlias` parameter uses a substitution template. // // `'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'` // // You must specify either `propertyAlias` or both `assetId` and `propertyId` to identify the target asset property in AWS IoT SiteWise . // // For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iotsitewise // IotSiteWise interface{} `field:"optional" json:"iotSiteWise" yaml:"iotSiteWise"` // Information required to publish the MQTT message through the AWS IoT message broker. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iottopicpublish // IotTopicPublish interface{} `field:"optional" json:"iotTopicPublish" yaml:"iotTopicPublish"` // Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-lambda // Lambda interface{} `field:"optional" json:"lambda" yaml:"lambda"` // Information required to publish the Amazon SNS message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sns // Sns interface{} `field:"optional" json:"sns" yaml:"sns"` // Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sqs // Sqs interface{} `field:"optional" json:"sqs" yaml:"sqs"` }
Specifies one of the following actions to receive notifications when the alarm state changes.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" alarmActionProperty := &AlarmActionProperty{ DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }
type CfnAlarmModel_AlarmCapabilitiesProperty ¶ added in v2.18.0
type CfnAlarmModel_AlarmCapabilitiesProperty struct { // Specifies whether to get notified for alarm state changes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html#cfn-iotevents-alarmmodel-alarmcapabilities-acknowledgeflow // AcknowledgeFlow interface{} `field:"optional" json:"acknowledgeFlow" yaml:"acknowledgeFlow"` // Specifies the default alarm state. // // The configuration applies to all alarms that were created based on this alarm model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html#cfn-iotevents-alarmmodel-alarmcapabilities-initializationconfiguration // InitializationConfiguration interface{} `field:"optional" json:"initializationConfiguration" yaml:"initializationConfiguration"` }
Contains the configuration information of alarm state changes.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" alarmCapabilitiesProperty := &AlarmCapabilitiesProperty{ AcknowledgeFlow: &AcknowledgeFlowProperty{ Enabled: jsii.Boolean(false), }, InitializationConfiguration: &InitializationConfigurationProperty{ DisabledOnInitialization: jsii.Boolean(false), }, }
type CfnAlarmModel_AlarmEventActionsProperty ¶ added in v2.18.0
type CfnAlarmModel_AlarmEventActionsProperty struct { // Specifies one or more supported actions to receive notifications when the alarm state changes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.html#cfn-iotevents-alarmmodel-alarmeventactions-alarmactions // AlarmActions interface{} `field:"optional" json:"alarmActions" yaml:"alarmActions"` }
Contains information about one or more alarm actions.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" alarmEventActionsProperty := &AlarmEventActionsProperty{ AlarmActions: []interface{}{ &AlarmActionProperty{ DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, }
type CfnAlarmModel_AlarmRuleProperty ¶ added in v2.18.0
type CfnAlarmModel_AlarmRuleProperty struct { // A rule that compares an input property value to a threshold value with a comparison operator. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.html#cfn-iotevents-alarmmodel-alarmrule-simplerule // SimpleRule interface{} `field:"optional" json:"simpleRule" yaml:"simpleRule"` }
Defines when your alarm is invoked.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" alarmRuleProperty := &AlarmRuleProperty{ SimpleRule: &SimpleRuleProperty{ ComparisonOperator: jsii.String("comparisonOperator"), InputProperty: jsii.String("inputProperty"), Threshold: jsii.String("threshold"), }, }
type CfnAlarmModel_AssetPropertyTimestampProperty ¶ added in v2.18.0
type CfnAlarmModel_AssetPropertyTimestampProperty struct { // The timestamp, in seconds, in the Unix epoch format. // // The valid range is between 1-31556889864403199. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html#cfn-iotevents-alarmmodel-assetpropertytimestamp-timeinseconds // TimeInSeconds *string `field:"required" json:"timeInSeconds" yaml:"timeInSeconds"` // The nanosecond offset converted from `timeInSeconds` . // // The valid range is between 0-999999999. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html#cfn-iotevents-alarmmodel-assetpropertytimestamp-offsetinnanos // OffsetInNanos *string `field:"optional" json:"offsetInNanos" yaml:"offsetInNanos"` }
A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference* .
You must use expressions for all parameters in `AssetPropertyTimestamp` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `timeInSeconds` parameter can be `'1586400675'` . - For references, you must specify either variables or input values. For example, the value for the `offsetInNanos` parameter can be `$variable.time` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `timeInSeconds` parameter uses a substitution template.
`'${$input.TemperatureInput.sensorData.timestamp / 1000}'`
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" assetPropertyTimestampProperty := &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }
type CfnAlarmModel_AssetPropertyValueProperty ¶ added in v2.18.0
type CfnAlarmModel_AssetPropertyValueProperty struct { // The value to send to an asset property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-value // Value interface{} `field:"required" json:"value" yaml:"value"` // The quality of the asset property value. // // The value must be `'GOOD'` , `'BAD'` , or `'UNCERTAIN'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-quality // Quality *string `field:"optional" json:"quality" yaml:"quality"` // The timestamp associated with the asset property value. // // The default is the current event time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-timestamp // Timestamp interface{} `field:"optional" json:"timestamp" yaml:"timestamp"` }
A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference* .
You must use expressions for all parameters in `AssetPropertyValue` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `quality` parameter can be `'GOOD'` . - For references, you must specify either variables or input values. For example, the value for the `quality` parameter can be `$input.TemperatureInput.sensorData.quality` .
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" assetPropertyValueProperty := &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }
type CfnAlarmModel_AssetPropertyVariantProperty ¶ added in v2.18.0
type CfnAlarmModel_AssetPropertyVariantProperty struct { // The asset property value is a Boolean value that must be `'TRUE'` or `'FALSE'` . // // You must use an expression, and the evaluated result should be a Boolean value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-booleanvalue // BooleanValue *string `field:"optional" json:"booleanValue" yaml:"booleanValue"` // The asset property value is a double. // // You must use an expression, and the evaluated result should be a double. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-doublevalue // DoubleValue *string `field:"optional" json:"doubleValue" yaml:"doubleValue"` // The asset property value is an integer. // // You must use an expression, and the evaluated result should be an integer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-integervalue // IntegerValue *string `field:"optional" json:"integerValue" yaml:"integerValue"` // The asset property value is a string. // // You must use an expression, and the evaluated result should be a string. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-stringvalue // StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"` }
A structure that contains an asset property value.
For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *AWS IoT SiteWise API Reference* .
You must use expressions for all parameters in `AssetPropertyVariant` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `integerValue` parameter can be `'100'` . - For references, you must specify either variables or parameters. For example, the value for the `booleanValue` parameter can be `$variable.offline` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `doubleValue` parameter uses a substitution template.
`'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'`
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
You must specify one of the following value types, depending on the `dataType` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *AWS IoT SiteWise API Reference* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" assetPropertyVariantProperty := &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }
type CfnAlarmModel_DynamoDBProperty ¶ added in v2.18.0
type CfnAlarmModel_DynamoDBProperty struct { // The name of the hash key (also called the partition key). // // The `hashKeyField` value must match the partition key of the target DynamoDB table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeyfield // HashKeyField *string `field:"required" json:"hashKeyField" yaml:"hashKeyField"` // The value of the hash key (also called the partition key). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeyvalue // HashKeyValue *string `field:"required" json:"hashKeyValue" yaml:"hashKeyValue"` // The name of the DynamoDB table. // // The `tableName` value must match the table name of the target DynamoDB table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` // The data type for the hash key (also called the partition key). You can specify the following values:. // // - `'STRING'` - The hash key is a string. // - `'NUMBER'` - The hash key is a number. // // If you don't specify `hashKeyType` , the default value is `'STRING'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeytype // HashKeyType *string `field:"optional" json:"hashKeyType" yaml:"hashKeyType"` // The type of operation to perform. You can specify the following values:. // // - `'INSERT'` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. // - `'UPDATE'` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. // - `'DELETE'` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. // // If you don't specify this parameter, AWS IoT Events triggers the `'INSERT'` operation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-operation // Operation *string `field:"optional" json:"operation" yaml:"operation"` // Information needed to configure the payload. // // By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` // The name of the DynamoDB column that receives the action payload. // // If you don't specify this parameter, the name of the DynamoDB column is `payload` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-payloadfield // PayloadField *string `field:"optional" json:"payloadField" yaml:"payloadField"` // The name of the range key (also called the sort key). // // The `rangeKeyField` value must match the sort key of the target DynamoDB table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeyfield // RangeKeyField *string `field:"optional" json:"rangeKeyField" yaml:"rangeKeyField"` // The data type for the range key (also called the sort key), You can specify the following values:. // // - `'STRING'` - The range key is a string. // - `'NUMBER'` - The range key is number. // // If you don't specify `rangeKeyField` , the default value is `'STRING'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeytype // RangeKeyType *string `field:"optional" json:"rangeKeyType" yaml:"rangeKeyType"` // The value of the range key (also called the sort key). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeyvalue // RangeKeyValue *string `field:"optional" json:"rangeKeyValue" yaml:"rangeKeyValue"` }
Defines an action to write to the Amazon DynamoDB table that you created.
The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
You must use expressions for all parameters in `DynamoDBAction` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `hashKeyType` parameter can be `'STRING'` . - For references, you must specify either variables or input values. For example, the value for the `hashKeyField` parameter can be `$input.GreenhouseInput.name` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `hashKeyValue` parameter uses a substitution template.
`'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'` - For a string concatenation, you must use `+` . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `tableName` parameter uses a string concatenation.
`'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
If the defined payload type is a string, `DynamoDBAction` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the `payloadField` parameter is `<payload-field>_raw` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dynamoDBProperty := &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }
type CfnAlarmModel_DynamoDBv2Property ¶ added in v2.18.0
type CfnAlarmModel_DynamoDBv2Property struct { // The name of the DynamoDB table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` // Information needed to configure the payload. // // By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Defines an action to write to the Amazon DynamoDB table that you created.
The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
You must use expressions for all parameters in `DynamoDBv2Action` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `tableName` parameter can be `'GreenhouseTemperatureTable'` . - For references, you must specify either variables or input values. For example, the value for the `tableName` parameter can be `$variable.ddbtableName` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `contentExpression` parameter in `Payload` uses a substitution template.
`'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'` - For a string concatenation, you must use `+` . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `tableName` parameter uses a string concatenation.
`'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
The value for the `type` parameter in `Payload` must be `JSON` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dynamoDBv2Property := &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnAlarmModel_FirehoseProperty ¶ added in v2.18.0
type CfnAlarmModel_FirehoseProperty struct { // The name of the Kinesis Data Firehose delivery stream where the data is written. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-deliverystreamname // DeliveryStreamName *string `field:"required" json:"deliveryStreamName" yaml:"deliveryStreamName"` // You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` // A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. // // Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-separator // Separator *string `field:"optional" json:"separator" yaml:"separator"` }
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" firehoseProperty := &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }
type CfnAlarmModel_InitializationConfigurationProperty ¶ added in v2.18.0
type CfnAlarmModel_InitializationConfigurationProperty struct { // The value must be `TRUE` or `FALSE` . // // If `FALSE` , all alarm instances created based on the alarm model are activated. The default value is `TRUE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html#cfn-iotevents-alarmmodel-initializationconfiguration-disabledoninitialization // DisabledOnInitialization interface{} `field:"required" json:"disabledOnInitialization" yaml:"disabledOnInitialization"` }
Specifies the default alarm state.
The configuration applies to all alarms that were created based on this alarm model.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" initializationConfigurationProperty := &InitializationConfigurationProperty{ DisabledOnInitialization: jsii.Boolean(false), }
type CfnAlarmModel_IotEventsProperty ¶ added in v2.18.0
type CfnAlarmModel_IotEventsProperty struct { // The name of the AWS IoT Events input where the data is sent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html#cfn-iotevents-alarmmodel-iotevents-inputname // InputName *string `field:"required" json:"inputName" yaml:"inputName"` // You can configure the action payload when you send a message to an AWS IoT Events input. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html#cfn-iotevents-alarmmodel-iotevents-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iotEventsProperty := &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnAlarmModel_IotSiteWiseProperty ¶ added in v2.18.0
type CfnAlarmModel_IotSiteWiseProperty struct { // The ID of the asset that has the specified property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-assetid // AssetId *string `field:"optional" json:"assetId" yaml:"assetId"` // A unique identifier for this entry. // // You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-entryid // EntryId *string `field:"optional" json:"entryId" yaml:"entryId"` // The alias of the asset property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyalias // PropertyAlias *string `field:"optional" json:"propertyAlias" yaml:"propertyAlias"` // The ID of the asset property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyid // PropertyId *string `field:"optional" json:"propertyId" yaml:"propertyId"` // The value to send to the asset property. // // This value contains timestamp, quality, and value (TQV) information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyvalue // PropertyValue interface{} `field:"optional" json:"propertyValue" yaml:"propertyValue"` }
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
You must use expressions for all parameters in `IotSiteWiseAction` . The expressions accept literals, operators, functions, references, and substitutions templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `propertyAlias` parameter can be `'/company/windfarm/3/turbine/7/temperature'` . - For references, you must specify either variables or input values. For example, the value for the `assetId` parameter can be `$input.TurbineInput.assetId1` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `propertyAlias` parameter uses a substitution template.
`'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'`
You must specify either `propertyAlias` or both `assetId` and `propertyId` to identify the target asset property in AWS IoT SiteWise .
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iotSiteWiseProperty := &IotSiteWiseProperty{ AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, }
type CfnAlarmModel_IotTopicPublishProperty ¶ added in v2.18.0
type CfnAlarmModel_IotTopicPublishProperty struct { // The MQTT topic of the message. // // You can use a string expression that includes variables ( `$variable.<variable-name>` ) and input values ( `$input.<input-name>.<path-to-datum>` ) as the topic string. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html#cfn-iotevents-alarmmodel-iottopicpublish-mqtttopic // MqttTopic *string `field:"required" json:"mqttTopic" yaml:"mqttTopic"` // You can configure the action payload when you publish a message to an AWS IoT Core topic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html#cfn-iotevents-alarmmodel-iottopicpublish-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Information required to publish the MQTT message through the AWS IoT message broker.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iotTopicPublishProperty := &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnAlarmModel_LambdaProperty ¶ added in v2.18.0
type CfnAlarmModel_LambdaProperty struct { // The ARN of the Lambda function that is executed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html#cfn-iotevents-alarmmodel-lambda-functionarn // FunctionArn *string `field:"required" json:"functionArn" yaml:"functionArn"` // You can configure the action payload when you send a message to a Lambda function. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html#cfn-iotevents-alarmmodel-lambda-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaProperty := &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnAlarmModel_PayloadProperty ¶ added in v2.18.0
type CfnAlarmModel_PayloadProperty struct { // The content of the payload. // // You can use a string expression that includes quoted strings ( `'<string>'` ), variables ( `$variable.<variable-name>` ), input values ( `$input.<input-name>.<path-to-datum>` ), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html#cfn-iotevents-alarmmodel-payload-contentexpression // ContentExpression *string `field:"required" json:"contentExpression" yaml:"contentExpression"` // The value of the payload type can be either `STRING` or `JSON` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html#cfn-iotevents-alarmmodel-payload-type // Type *string `field:"required" json:"type" yaml:"type"` }
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" payloadProperty := &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }
type CfnAlarmModel_SimpleRuleProperty ¶ added in v2.18.0
type CfnAlarmModel_SimpleRuleProperty struct { // The comparison operator. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-comparisonoperator // ComparisonOperator *string `field:"required" json:"comparisonOperator" yaml:"comparisonOperator"` // The value on the left side of the comparison operator. // // You can specify an AWS IoT Events input attribute as an input property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-inputproperty // InputProperty *string `field:"required" json:"inputProperty" yaml:"inputProperty"` // The value on the right side of the comparison operator. // // You can enter a number or specify an AWS IoT Events input attribute. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-threshold // Threshold *string `field:"required" json:"threshold" yaml:"threshold"` }
A rule that compares an input property value to a threshold value with a comparison operator.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" simpleRuleProperty := &SimpleRuleProperty{ ComparisonOperator: jsii.String("comparisonOperator"), InputProperty: jsii.String("inputProperty"), Threshold: jsii.String("threshold"), }
type CfnAlarmModel_SnsProperty ¶ added in v2.18.0
type CfnAlarmModel_SnsProperty struct { // The ARN of the Amazon SNS target where the message is sent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html#cfn-iotevents-alarmmodel-sns-targetarn // TargetArn *string `field:"required" json:"targetArn" yaml:"targetArn"` // You can configure the action payload when you send a message as an Amazon SNS push notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html#cfn-iotevents-alarmmodel-sns-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Information required to publish the Amazon SNS message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" snsProperty := &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnAlarmModel_SqsProperty ¶ added in v2.18.0
type CfnAlarmModel_SqsProperty struct { // The URL of the SQS queue where the data is written. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-queueurl // QueueUrl *string `field:"required" json:"queueUrl" yaml:"queueUrl"` // You can configure the action payload when you send a message to an Amazon SQS queue. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` // Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. // // Otherwise, set this to FALSE. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-usebase64 // UseBase64 interface{} `field:"optional" json:"useBase64" yaml:"useBase64"` }
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sqsProperty := &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }
type CfnDetectorModel ¶
type CfnDetectorModel interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Information that defines how a detector operates. DetectorModelDefinition() interface{} SetDetectorModelDefinition(val interface{}) // A brief description of the detector model. DetectorModelDescription() *string SetDetectorModelDescription(val *string) // The name of the detector model. DetectorModelName() *string SetDetectorModelName(val *string) // Information about the order in which events are evaluated and how actions are executed. EvaluationMethod() *string SetEvaluationMethod(val *string) // The value used to identify a detector instance. Key() *string SetKey(val *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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The ARN of the role that grants permission to AWS IoT Events to perform its operations. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The AWS::IoTEvents::DetectorModel resource creates a detector model.
You create a *detector model* (a model of your equipment or process) using *states* . For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide* .
> When you successfully update a detector model (using the AWS IoT Events console, AWS IoT Events API or CLI commands, or AWS CloudFormation ) all detector instances created by the model are reset to their initial states. (The detector's `state` , and the values of any variables and timers are reset.) > > When you successfully update a detector model (using the AWS IoT Events console, AWS IoT Events API or CLI commands, or AWS CloudFormation ) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.) > > If you attempt to update a detector model using AWS CloudFormation and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset. > > Also, be aware that if you attempt to update several detector models at once using AWS CloudFormation , some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.
Example:
func NewCfnDetectorModel ¶
func NewCfnDetectorModel(scope constructs.Construct, id *string, props *CfnDetectorModelProps) CfnDetectorModel
type CfnDetectorModelProps ¶
type CfnDetectorModelProps struct { // Information that defines how a detector operates. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldefinition // DetectorModelDefinition interface{} `field:"required" json:"detectorModelDefinition" yaml:"detectorModelDefinition"` // The ARN of the role that grants permission to AWS IoT Events to perform its operations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // A brief description of the detector model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldescription // DetectorModelDescription *string `field:"optional" json:"detectorModelDescription" yaml:"detectorModelDescription"` // The name of the detector model. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodelname // DetectorModelName *string `field:"optional" json:"detectorModelName" yaml:"detectorModelName"` // Information about the order in which events are evaluated and how actions are executed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-evaluationmethod // EvaluationMethod *string `field:"optional" json:"evaluationMethod" yaml:"evaluationMethod"` // The value used to identify a detector instance. // // When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information. // // This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-key // Key *string `field:"optional" json:"key" yaml:"key"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDetectorModel`.
Example:
type CfnDetectorModel_ActionProperty ¶
type CfnDetectorModel_ActionProperty struct { // Information needed to clear the timer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-cleartimer // ClearTimer interface{} `field:"optional" json:"clearTimer" yaml:"clearTimer"` // Writes to the DynamoDB table that you created. // // The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *AWS IoT Events Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-dynamodb // DynamoDb interface{} `field:"optional" json:"dynamoDb" yaml:"dynamoDb"` // Writes to the DynamoDB table that you created. // // The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *AWS IoT Events Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-dynamodbv2 // DynamoDBv2 interface{} `field:"optional" json:"dynamoDBv2" yaml:"dynamoDBv2"` // Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-firehose // Firehose interface{} `field:"optional" json:"firehose" yaml:"firehose"` // Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iotevents // IotEvents interface{} `field:"optional" json:"iotEvents" yaml:"iotEvents"` // Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iotsitewise // IotSiteWise interface{} `field:"optional" json:"iotSiteWise" yaml:"iotSiteWise"` // Publishes an MQTT message with the given topic to the AWS IoT message broker. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-iottopicpublish // IotTopicPublish interface{} `field:"optional" json:"iotTopicPublish" yaml:"iotTopicPublish"` // Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-lambda // Lambda interface{} `field:"optional" json:"lambda" yaml:"lambda"` // Information needed to reset the timer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-resettimer // ResetTimer interface{} `field:"optional" json:"resetTimer" yaml:"resetTimer"` // Information needed to set the timer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-settimer // SetTimer interface{} `field:"optional" json:"setTimer" yaml:"setTimer"` // Sets a variable to a specified value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-setvariable // SetVariable interface{} `field:"optional" json:"setVariable" yaml:"setVariable"` // Sends an Amazon SNS message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-sns // Sns interface{} `field:"optional" json:"sns" yaml:"sns"` // Sends an Amazon SNS message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html#cfn-iotevents-detectormodel-action-sqs // Sqs interface{} `field:"optional" json:"sqs" yaml:"sqs"` }
An action to be performed when the `condition` is TRUE.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" actionProperty := &ActionProperty{ ClearTimer: &ClearTimerProperty{ TimerName: jsii.String("timerName"), }, DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, // the properties below are optional AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, ResetTimer: &ResetTimerProperty{ TimerName: jsii.String("timerName"), }, SetTimer: &SetTimerProperty{ TimerName: jsii.String("timerName"), // the properties below are optional DurationExpression: jsii.String("durationExpression"), Seconds: jsii.Number(123), }, SetVariable: &SetVariableProperty{ Value: jsii.String("value"), VariableName: jsii.String("variableName"), }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }
type CfnDetectorModel_AssetPropertyTimestampProperty ¶
type CfnDetectorModel_AssetPropertyTimestampProperty struct { // The timestamp, in seconds, in the Unix epoch format. // // The valid range is between 1-31556889864403199. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html#cfn-iotevents-detectormodel-assetpropertytimestamp-timeinseconds // TimeInSeconds *string `field:"required" json:"timeInSeconds" yaml:"timeInSeconds"` // The nanosecond offset converted from `timeInSeconds` . // // The valid range is between 0-999999999. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html#cfn-iotevents-detectormodel-assetpropertytimestamp-offsetinnanos // OffsetInNanos *string `field:"optional" json:"offsetInNanos" yaml:"offsetInNanos"` }
A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *AWS IoT SiteWise API Reference* .
You must use expressions for all parameters in `AssetPropertyTimestamp` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `timeInSeconds` parameter can be `'1586400675'` . - For references, you must specify either variables or input values. For example, the value for the `offsetInNanos` parameter can be `$variable.time` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `timeInSeconds` parameter uses a substitution template.
`'${$input.TemperatureInput.sensorData.timestamp / 1000}'`
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" assetPropertyTimestampProperty := &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }
type CfnDetectorModel_AssetPropertyValueProperty ¶
type CfnDetectorModel_AssetPropertyValueProperty struct { // The value to send to an asset property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-value // Value interface{} `field:"required" json:"value" yaml:"value"` // The quality of the asset property value. // // The value must be `'GOOD'` , `'BAD'` , or `'UNCERTAIN'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-quality // Quality *string `field:"optional" json:"quality" yaml:"quality"` // The timestamp associated with the asset property value. // // The default is the current event time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html#cfn-iotevents-detectormodel-assetpropertyvalue-timestamp // Timestamp interface{} `field:"optional" json:"timestamp" yaml:"timestamp"` }
A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *AWS IoT SiteWise API Reference* .
You must use expressions for all parameters in `AssetPropertyValue` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `quality` parameter can be `'GOOD'` . - For references, you must specify either variables or input values. For example, the value for the `quality` parameter can be `$input.TemperatureInput.sensorData.quality` .
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" assetPropertyValueProperty := &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }
type CfnDetectorModel_AssetPropertyVariantProperty ¶
type CfnDetectorModel_AssetPropertyVariantProperty struct { // The asset property value is a Boolean value that must be `'TRUE'` or `'FALSE'` . // // You must use an expression, and the evaluated result should be a Boolean value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-booleanvalue // BooleanValue *string `field:"optional" json:"booleanValue" yaml:"booleanValue"` // The asset property value is a double. // // You must use an expression, and the evaluated result should be a double. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-doublevalue // DoubleValue *string `field:"optional" json:"doubleValue" yaml:"doubleValue"` // The asset property value is an integer. // // You must use an expression, and the evaluated result should be an integer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-integervalue // IntegerValue *string `field:"optional" json:"integerValue" yaml:"integerValue"` // The asset property value is a string. // // You must use an expression, and the evaluated result should be a string. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html#cfn-iotevents-detectormodel-assetpropertyvariant-stringvalue // StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"` }
A structure that contains an asset property value.
For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *AWS IoT SiteWise API Reference* .
You must use expressions for all parameters in `AssetPropertyVariant` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `integerValue` parameter can be `'100'` . - For references, you must specify either variables or parameters. For example, the value for the `booleanValue` parameter can be `$variable.offline` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `doubleValue` parameter uses a substitution template.
`'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'`
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
You must specify one of the following value types, depending on the `dataType` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *AWS IoT SiteWise API Reference* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" assetPropertyVariantProperty := &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }
type CfnDetectorModel_ClearTimerProperty ¶
type CfnDetectorModel_ClearTimerProperty struct { // The name of the timer to clear. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-cleartimer.html#cfn-iotevents-detectormodel-cleartimer-timername // TimerName *string `field:"required" json:"timerName" yaml:"timerName"` }
Information needed to clear the timer.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" clearTimerProperty := &ClearTimerProperty{ TimerName: jsii.String("timerName"), }
type CfnDetectorModel_DetectorModelDefinitionProperty ¶
type CfnDetectorModel_DetectorModelDefinitionProperty struct { // The state that is entered at the creation of each detector (instance). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html#cfn-iotevents-detectormodel-detectormodeldefinition-initialstatename // InitialStateName *string `field:"required" json:"initialStateName" yaml:"initialStateName"` // Information about the states of the detector. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html#cfn-iotevents-detectormodel-detectormodeldefinition-states // States interface{} `field:"required" json:"states" yaml:"states"` }
Information that defines how a detector operates.
Example:
type CfnDetectorModel_DynamoDBProperty ¶
type CfnDetectorModel_DynamoDBProperty struct { // The name of the hash key (also called the partition key). // // The `hashKeyField` value must match the partition key of the target DynamoDB table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeyfield // HashKeyField *string `field:"required" json:"hashKeyField" yaml:"hashKeyField"` // The value of the hash key (also called the partition key). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeyvalue // HashKeyValue *string `field:"required" json:"hashKeyValue" yaml:"hashKeyValue"` // The name of the DynamoDB table. // // The `tableName` value must match the table name of the target DynamoDB table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` // The data type for the hash key (also called the partition key). You can specify the following values:. // // - `'STRING'` - The hash key is a string. // - `'NUMBER'` - The hash key is a number. // // If you don't specify `hashKeyType` , the default value is `'STRING'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-hashkeytype // HashKeyType *string `field:"optional" json:"hashKeyType" yaml:"hashKeyType"` // The type of operation to perform. You can specify the following values:. // // - `'INSERT'` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. // - `'UPDATE'` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. // - `'DELETE'` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. // // If you don't specify this parameter, AWS IoT Events triggers the `'INSERT'` operation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-operation // Operation *string `field:"optional" json:"operation" yaml:"operation"` // Information needed to configure the payload. // // By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` // The name of the DynamoDB column that receives the action payload. // // If you don't specify this parameter, the name of the DynamoDB column is `payload` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-payloadfield // PayloadField *string `field:"optional" json:"payloadField" yaml:"payloadField"` // The name of the range key (also called the sort key). // // The `rangeKeyField` value must match the sort key of the target DynamoDB table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeyfield // RangeKeyField *string `field:"optional" json:"rangeKeyField" yaml:"rangeKeyField"` // The data type for the range key (also called the sort key), You can specify the following values:. // // - `'STRING'` - The range key is a string. // - `'NUMBER'` - The range key is number. // // If you don't specify `rangeKeyField` , the default value is `'STRING'` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeytype // RangeKeyType *string `field:"optional" json:"rangeKeyType" yaml:"rangeKeyType"` // The value of the range key (also called the sort key). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html#cfn-iotevents-detectormodel-dynamodb-rangekeyvalue // RangeKeyValue *string `field:"optional" json:"rangeKeyValue" yaml:"rangeKeyValue"` }
Defines an action to write to the Amazon DynamoDB table that you created.
The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
You must use expressions for all parameters in `DynamoDBAction` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `hashKeyType` parameter can be `'STRING'` . - For references, you must specify either variables or input values. For example, the value for the `hashKeyField` parameter can be `$input.GreenhouseInput.name` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `hashKeyValue` parameter uses a substitution template.
`'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'` - For a string concatenation, you must use `+` . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `tableName` parameter uses a string concatenation.
`'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
If the defined payload type is a string, `DynamoDBAction` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the `payloadField` parameter is `<payload-field>_raw` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dynamoDBProperty := &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }
type CfnDetectorModel_DynamoDBv2Property ¶
type CfnDetectorModel_DynamoDBv2Property struct { // The name of the DynamoDB table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html#cfn-iotevents-detectormodel-dynamodbv2-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` // Information needed to configure the payload. // // By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html#cfn-iotevents-detectormodel-dynamodbv2-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Defines an action to write to the Amazon DynamoDB table that you created.
The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
You must use expressions for all parameters in `DynamoDBv2Action` . The expressions accept literals, operators, functions, references, and substitution templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `tableName` parameter can be `'GreenhouseTemperatureTable'` . - For references, you must specify either variables or input values. For example, the value for the `tableName` parameter can be `$variable.ddbtableName` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `contentExpression` parameter in `Payload` uses a substitution template.
`'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'` - For a string concatenation, you must use `+` . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `tableName` parameter uses a string concatenation.
`'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
The value for the `type` parameter in `Payload` must be `JSON` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dynamoDBv2Property := &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnDetectorModel_EventProperty ¶
type CfnDetectorModel_EventProperty struct { // The name of the event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-eventname // EventName *string `field:"required" json:"eventName" yaml:"eventName"` // The actions to be performed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-actions // Actions interface{} `field:"optional" json:"actions" yaml:"actions"` // Optional. // // The Boolean expression that, when TRUE, causes the `actions` to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html#cfn-iotevents-detectormodel-event-condition // Condition *string `field:"optional" json:"condition" yaml:"condition"` }
Specifies the `actions` to be performed when the `condition` evaluates to TRUE.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eventProperty := &EventProperty{ EventName: jsii.String("eventName"), // the properties below are optional Actions: []interface{}{ &ActionProperty{ ClearTimer: &ClearTimerProperty{ TimerName: jsii.String("timerName"), }, DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, // the properties below are optional AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, ResetTimer: &ResetTimerProperty{ TimerName: jsii.String("timerName"), }, SetTimer: &SetTimerProperty{ TimerName: jsii.String("timerName"), // the properties below are optional DurationExpression: jsii.String("durationExpression"), Seconds: jsii.Number(123), }, SetVariable: &SetVariableProperty{ Value: jsii.String("value"), VariableName: jsii.String("variableName"), }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, Condition: jsii.String("condition"), }
type CfnDetectorModel_FirehoseProperty ¶
type CfnDetectorModel_FirehoseProperty struct { // The name of the Kinesis Data Firehose delivery stream where the data is written. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-deliverystreamname // DeliveryStreamName *string `field:"required" json:"deliveryStreamName" yaml:"deliveryStreamName"` // You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` // A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. // // Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-firehose.html#cfn-iotevents-detectormodel-firehose-separator // Separator *string `field:"optional" json:"separator" yaml:"separator"` }
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" firehoseProperty := &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }
type CfnDetectorModel_IotEventsProperty ¶
type CfnDetectorModel_IotEventsProperty struct { // The name of the AWS IoT Events input where the data is sent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html#cfn-iotevents-detectormodel-iotevents-inputname // InputName *string `field:"required" json:"inputName" yaml:"inputName"` // You can configure the action payload when you send a message to an AWS IoT Events input. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html#cfn-iotevents-detectormodel-iotevents-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iotEventsProperty := &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnDetectorModel_IotSiteWiseProperty ¶
type CfnDetectorModel_IotSiteWiseProperty struct { // The value to send to the asset property. // // This value contains timestamp, quality, and value (TQV) information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyvalue // PropertyValue interface{} `field:"required" json:"propertyValue" yaml:"propertyValue"` // The ID of the asset that has the specified property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-assetid // AssetId *string `field:"optional" json:"assetId" yaml:"assetId"` // A unique identifier for this entry. // // You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-entryid // EntryId *string `field:"optional" json:"entryId" yaml:"entryId"` // The alias of the asset property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyalias // PropertyAlias *string `field:"optional" json:"propertyAlias" yaml:"propertyAlias"` // The ID of the asset property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html#cfn-iotevents-detectormodel-iotsitewise-propertyid // PropertyId *string `field:"optional" json:"propertyId" yaml:"propertyId"` }
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
You must use expressions for all parameters in `IotSiteWiseAction` . The expressions accept literals, operators, functions, references, and substitutions templates.
**Examples** - For literal values, the expressions must contain single quotes. For example, the value for the `propertyAlias` parameter can be `'/company/windfarm/3/turbine/7/temperature'` . - For references, you must specify either variables or input values. For example, the value for the `assetId` parameter can be `$input.TurbineInput.assetId1` . - For a substitution template, you must use `${}` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the `propertyAlias` parameter uses a substitution template.
`'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'`
You must specify either `propertyAlias` or both `assetId` and `propertyId` to identify the target asset property in AWS IoT SiteWise .
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iotSiteWiseProperty := &IotSiteWiseProperty{ PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, // the properties below are optional AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), }
type CfnDetectorModel_IotTopicPublishProperty ¶
type CfnDetectorModel_IotTopicPublishProperty struct { // The MQTT topic of the message. // // You can use a string expression that includes variables ( `$variable.<variable-name>` ) and input values ( `$input.<input-name>.<path-to-datum>` ) as the topic string. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html#cfn-iotevents-detectormodel-iottopicpublish-mqtttopic // MqttTopic *string `field:"required" json:"mqttTopic" yaml:"mqttTopic"` // You can configure the action payload when you publish a message to an AWS IoT Core topic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html#cfn-iotevents-detectormodel-iottopicpublish-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Information required to publish the MQTT message through the AWS IoT message broker.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iotTopicPublishProperty := &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnDetectorModel_LambdaProperty ¶
type CfnDetectorModel_LambdaProperty struct { // The ARN of the Lambda function that is executed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html#cfn-iotevents-detectormodel-lambda-functionarn // FunctionArn *string `field:"required" json:"functionArn" yaml:"functionArn"` // You can configure the action payload when you send a message to a Lambda function. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html#cfn-iotevents-detectormodel-lambda-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" lambdaProperty := &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnDetectorModel_OnEnterProperty ¶
type CfnDetectorModel_OnEnterProperty struct { // Specifies the actions that are performed when the state is entered and the `condition` is `TRUE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html#cfn-iotevents-detectormodel-onenter-events // Events interface{} `field:"optional" json:"events" yaml:"events"` }
When entering this state, perform these `actions` if the `condition` is TRUE.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" onEnterProperty := &OnEnterProperty{ Events: []interface{}{ &EventProperty{ EventName: jsii.String("eventName"), // the properties below are optional Actions: []interface{}{ &ActionProperty{ ClearTimer: &ClearTimerProperty{ TimerName: jsii.String("timerName"), }, DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, // the properties below are optional AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, ResetTimer: &ResetTimerProperty{ TimerName: jsii.String("timerName"), }, SetTimer: &SetTimerProperty{ TimerName: jsii.String("timerName"), // the properties below are optional DurationExpression: jsii.String("durationExpression"), Seconds: jsii.Number(123), }, SetVariable: &SetVariableProperty{ Value: jsii.String("value"), VariableName: jsii.String("variableName"), }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, Condition: jsii.String("condition"), }, }, }
type CfnDetectorModel_OnExitProperty ¶
type CfnDetectorModel_OnExitProperty struct { // Specifies the `actions` that are performed when the state is exited and the `condition` is `TRUE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html#cfn-iotevents-detectormodel-onexit-events // Events interface{} `field:"optional" json:"events" yaml:"events"` }
When exiting this state, perform these `actions` if the specified `condition` is `TRUE` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" onExitProperty := &OnExitProperty{ Events: []interface{}{ &EventProperty{ EventName: jsii.String("eventName"), // the properties below are optional Actions: []interface{}{ &ActionProperty{ ClearTimer: &ClearTimerProperty{ TimerName: jsii.String("timerName"), }, DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, // the properties below are optional AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, ResetTimer: &ResetTimerProperty{ TimerName: jsii.String("timerName"), }, SetTimer: &SetTimerProperty{ TimerName: jsii.String("timerName"), // the properties below are optional DurationExpression: jsii.String("durationExpression"), Seconds: jsii.Number(123), }, SetVariable: &SetVariableProperty{ Value: jsii.String("value"), VariableName: jsii.String("variableName"), }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, Condition: jsii.String("condition"), }, }, }
type CfnDetectorModel_OnInputProperty ¶
type CfnDetectorModel_OnInputProperty struct { // Specifies the actions performed when the `condition` evaluates to TRUE. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html#cfn-iotevents-detectormodel-oninput-events // Events interface{} `field:"optional" json:"events" yaml:"events"` // Specifies the actions performed, and the next state entered, when a `condition` evaluates to TRUE. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html#cfn-iotevents-detectormodel-oninput-transitionevents // TransitionEvents interface{} `field:"optional" json:"transitionEvents" yaml:"transitionEvents"` }
Specifies the actions performed when the `condition` evaluates to TRUE.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" onInputProperty := &OnInputProperty{ Events: []interface{}{ &EventProperty{ EventName: jsii.String("eventName"), // the properties below are optional Actions: []interface{}{ &ActionProperty{ ClearTimer: &ClearTimerProperty{ TimerName: jsii.String("timerName"), }, DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, // the properties below are optional AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, ResetTimer: &ResetTimerProperty{ TimerName: jsii.String("timerName"), }, SetTimer: &SetTimerProperty{ TimerName: jsii.String("timerName"), // the properties below are optional DurationExpression: jsii.String("durationExpression"), Seconds: jsii.Number(123), }, SetVariable: &SetVariableProperty{ Value: jsii.String("value"), VariableName: jsii.String("variableName"), }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, Condition: jsii.String("condition"), }, }, TransitionEvents: []interface{}{ &TransitionEventProperty{ Condition: jsii.String("condition"), EventName: jsii.String("eventName"), NextState: jsii.String("nextState"), // the properties below are optional Actions: []interface{}{ &ActionProperty{ ClearTimer: &ClearTimerProperty{ TimerName: jsii.String("timerName"), }, DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, // the properties below are optional AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, ResetTimer: &ResetTimerProperty{ TimerName: jsii.String("timerName"), }, SetTimer: &SetTimerProperty{ TimerName: jsii.String("timerName"), // the properties below are optional DurationExpression: jsii.String("durationExpression"), Seconds: jsii.Number(123), }, SetVariable: &SetVariableProperty{ Value: jsii.String("value"), VariableName: jsii.String("variableName"), }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, }, }, }
type CfnDetectorModel_PayloadProperty ¶
type CfnDetectorModel_PayloadProperty struct { // The content of the payload. // // You can use a string expression that includes quoted strings ( `'<string>'` ), variables ( `$variable.<variable-name>` ), input values ( `$input.<input-name>.<path-to-datum>` ), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html#cfn-iotevents-detectormodel-payload-contentexpression // ContentExpression *string `field:"required" json:"contentExpression" yaml:"contentExpression"` // The value of the payload type can be either `STRING` or `JSON` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html#cfn-iotevents-detectormodel-payload-type // Type *string `field:"required" json:"type" yaml:"type"` }
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" payloadProperty := &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }
type CfnDetectorModel_ResetTimerProperty ¶
type CfnDetectorModel_ResetTimerProperty struct { // The name of the timer to reset. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-resettimer.html#cfn-iotevents-detectormodel-resettimer-timername // TimerName *string `field:"required" json:"timerName" yaml:"timerName"` }
Information required to reset the timer.
The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" resetTimerProperty := &ResetTimerProperty{ TimerName: jsii.String("timerName"), }
type CfnDetectorModel_SetTimerProperty ¶
type CfnDetectorModel_SetTimerProperty struct { // The name of the timer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-timername // TimerName *string `field:"required" json:"timerName" yaml:"timerName"` // The duration of the timer, in seconds. // // You can use a string expression that includes numbers, variables ( `$variable.<variable-name>` ), and input values ( `$input.<input-name>.<path-to-datum>` ) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-durationexpression // DurationExpression *string `field:"optional" json:"durationExpression" yaml:"durationExpression"` // The number of seconds until the timer expires. // // The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-settimer.html#cfn-iotevents-detectormodel-settimer-seconds // Seconds *float64 `field:"optional" json:"seconds" yaml:"seconds"` }
Information needed to set the timer.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" setTimerProperty := &SetTimerProperty{ TimerName: jsii.String("timerName"), // the properties below are optional DurationExpression: jsii.String("durationExpression"), Seconds: jsii.Number(123), }
type CfnDetectorModel_SetVariableProperty ¶
type CfnDetectorModel_SetVariableProperty struct { // The new value of the variable. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html#cfn-iotevents-detectormodel-setvariable-value // Value *string `field:"required" json:"value" yaml:"value"` // The name of the variable. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-setvariable.html#cfn-iotevents-detectormodel-setvariable-variablename // VariableName *string `field:"required" json:"variableName" yaml:"variableName"` }
Information about the variable and its new value.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" setVariableProperty := &SetVariableProperty{ Value: jsii.String("value"), VariableName: jsii.String("variableName"), }
type CfnDetectorModel_SnsProperty ¶
type CfnDetectorModel_SnsProperty struct { // The ARN of the Amazon SNS target where the message is sent. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html#cfn-iotevents-detectormodel-sns-targetarn // TargetArn *string `field:"required" json:"targetArn" yaml:"targetArn"` // You can configure the action payload when you send a message as an Amazon SNS push notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sns.html#cfn-iotevents-detectormodel-sns-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` }
Information required to publish the Amazon SNS message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" snsProperty := &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }
type CfnDetectorModel_SqsProperty ¶
type CfnDetectorModel_SqsProperty struct { // The URL of the SQS queue where the data is written. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-queueurl // QueueUrl *string `field:"required" json:"queueUrl" yaml:"queueUrl"` // You can configure the action payload when you send a message to an Amazon SQS queue. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-payload // Payload interface{} `field:"optional" json:"payload" yaml:"payload"` // Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. // // Otherwise, set this to FALSE. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html#cfn-iotevents-detectormodel-sqs-usebase64 // UseBase64 interface{} `field:"optional" json:"useBase64" yaml:"useBase64"` }
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sqsProperty := &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }
type CfnDetectorModel_StateProperty ¶
type CfnDetectorModel_StateProperty struct { // The name of the state. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-statename // StateName *string `field:"required" json:"stateName" yaml:"stateName"` // When entering this state, perform these `actions` if the `condition` is TRUE. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onenter // OnEnter interface{} `field:"optional" json:"onEnter" yaml:"onEnter"` // When exiting this state, perform these `actions` if the specified `condition` is `TRUE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-onexit // OnExit interface{} `field:"optional" json:"onExit" yaml:"onExit"` // When an input is received and the `condition` is TRUE, perform the specified `actions` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-state.html#cfn-iotevents-detectormodel-state-oninput // OnInput interface{} `field:"optional" json:"onInput" yaml:"onInput"` }
Information that defines a state of a detector.
Example:
type CfnDetectorModel_TransitionEventProperty ¶
type CfnDetectorModel_TransitionEventProperty struct { // Required. // // A Boolean expression that when TRUE causes the actions to be performed and the `nextState` to be entered. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-condition // Condition *string `field:"required" json:"condition" yaml:"condition"` // The name of the transition event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-eventname // EventName *string `field:"required" json:"eventName" yaml:"eventName"` // The next state to enter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-nextstate // NextState *string `field:"required" json:"nextState" yaml:"nextState"` // The actions to be performed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html#cfn-iotevents-detectormodel-transitionevent-actions // Actions interface{} `field:"optional" json:"actions" yaml:"actions"` }
Specifies the actions performed and the next state entered when a `condition` evaluates to TRUE.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" transitionEventProperty := &TransitionEventProperty{ Condition: jsii.String("condition"), EventName: jsii.String("eventName"), NextState: jsii.String("nextState"), // the properties below are optional Actions: []interface{}{ &ActionProperty{ ClearTimer: &ClearTimerProperty{ TimerName: jsii.String("timerName"), }, DynamoDb: &DynamoDBProperty{ HashKeyField: jsii.String("hashKeyField"), HashKeyValue: jsii.String("hashKeyValue"), TableName: jsii.String("tableName"), // the properties below are optional HashKeyType: jsii.String("hashKeyType"), Operation: jsii.String("operation"), Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, PayloadField: jsii.String("payloadField"), RangeKeyField: jsii.String("rangeKeyField"), RangeKeyType: jsii.String("rangeKeyType"), RangeKeyValue: jsii.String("rangeKeyValue"), }, DynamoDBv2: &DynamoDBv2Property{ TableName: jsii.String("tableName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Firehose: &FirehoseProperty{ DeliveryStreamName: jsii.String("deliveryStreamName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, Separator: jsii.String("separator"), }, IotEvents: &IotEventsProperty{ InputName: jsii.String("inputName"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, IotSiteWise: &IotSiteWiseProperty{ PropertyValue: &AssetPropertyValueProperty{ Value: &AssetPropertyVariantProperty{ BooleanValue: jsii.String("booleanValue"), DoubleValue: jsii.String("doubleValue"), IntegerValue: jsii.String("integerValue"), StringValue: jsii.String("stringValue"), }, // the properties below are optional Quality: jsii.String("quality"), Timestamp: &AssetPropertyTimestampProperty{ TimeInSeconds: jsii.String("timeInSeconds"), // the properties below are optional OffsetInNanos: jsii.String("offsetInNanos"), }, }, // the properties below are optional AssetId: jsii.String("assetId"), EntryId: jsii.String("entryId"), PropertyAlias: jsii.String("propertyAlias"), PropertyId: jsii.String("propertyId"), }, IotTopicPublish: &IotTopicPublishProperty{ MqttTopic: jsii.String("mqttTopic"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Lambda: &LambdaProperty{ FunctionArn: jsii.String("functionArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, ResetTimer: &ResetTimerProperty{ TimerName: jsii.String("timerName"), }, SetTimer: &SetTimerProperty{ TimerName: jsii.String("timerName"), // the properties below are optional DurationExpression: jsii.String("durationExpression"), Seconds: jsii.Number(123), }, SetVariable: &SetVariableProperty{ Value: jsii.String("value"), VariableName: jsii.String("variableName"), }, Sns: &SnsProperty{ TargetArn: jsii.String("targetArn"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, }, Sqs: &SqsProperty{ QueueUrl: jsii.String("queueUrl"), // the properties below are optional Payload: &PayloadProperty{ ContentExpression: jsii.String("contentExpression"), Type: jsii.String("type"), }, UseBase64: jsii.Boolean(false), }, }, }, }
type CfnInput ¶
type CfnInput interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The definition of the input. InputDefinition() interface{} SetInputDefinition(val interface{}) // A brief description of the input. InputDescription() *string SetInputDescription(val *string) // The name of the input. InputName() *string SetInputName(val *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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The AWS::IoTEvents::Input resource creates an input.
To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events . This is done by sending messages as *inputs* to AWS IoT Events . For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInput := awscdk.Aws_iotevents.NewCfnInput(this, jsii.String("MyCfnInput"), &CfnInputProps{ InputDefinition: &InputDefinitionProperty{ Attributes: []interface{}{ &AttributeProperty{ JsonPath: jsii.String("jsonPath"), }, }, }, // the properties below are optional InputDescription: jsii.String("inputDescription"), InputName: jsii.String("inputName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html
func NewCfnInput ¶
func NewCfnInput(scope constructs.Construct, id *string, props *CfnInputProps) CfnInput
type CfnInputProps ¶
type CfnInputProps struct { // The definition of the input. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputdefinition // InputDefinition interface{} `field:"required" json:"inputDefinition" yaml:"inputDefinition"` // A brief description of the input. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputdescription // InputDescription *string `field:"optional" json:"inputDescription" yaml:"inputDescription"` // The name of the input. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-inputname // InputName *string `field:"optional" json:"inputName" yaml:"inputName"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html#cfn-iotevents-input-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnInput`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInputProps := &CfnInputProps{ InputDefinition: &InputDefinitionProperty{ Attributes: []interface{}{ &AttributeProperty{ JsonPath: jsii.String("jsonPath"), }, }, }, // the properties below are optional InputDescription: jsii.String("inputDescription"), InputName: jsii.String("inputName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html
type CfnInput_AttributeProperty ¶
type CfnInput_AttributeProperty struct { // An expression that specifies an attribute-value pair in a JSON structure. // // Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events ( `BatchPutMessage` ). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the `condition` expressions used by detectors. // // Syntax: `<field-name>.<field-name>...` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html#cfn-iotevents-input-attribute-jsonpath // JsonPath *string `field:"required" json:"jsonPath" yaml:"jsonPath"` }
The attributes from the JSON payload that are made available by the input.
Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage` . Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" attributeProperty := &AttributeProperty{ JsonPath: jsii.String("jsonPath"), }
type CfnInput_InputDefinitionProperty ¶
type CfnInput_InputDefinitionProperty struct { // The attributes from the JSON payload that are made available by the input. // // Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage` . Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-inputdefinition.html#cfn-iotevents-input-inputdefinition-attributes // Attributes interface{} `field:"required" json:"attributes" yaml:"attributes"` }
The definition of the input.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inputDefinitionProperty := &InputDefinitionProperty{ Attributes: []interface{}{ &AttributeProperty{ JsonPath: jsii.String("jsonPath"), }, }, }
Source Files ¶
- CfnAlarmModel.go
- CfnAlarmModelProps.go
- CfnAlarmModel_AcknowledgeFlowProperty.go
- CfnAlarmModel_AlarmActionProperty.go
- CfnAlarmModel_AlarmCapabilitiesProperty.go
- CfnAlarmModel_AlarmEventActionsProperty.go
- CfnAlarmModel_AlarmRuleProperty.go
- CfnAlarmModel_AssetPropertyTimestampProperty.go
- CfnAlarmModel_AssetPropertyValueProperty.go
- CfnAlarmModel_AssetPropertyVariantProperty.go
- CfnAlarmModel_DynamoDBProperty.go
- CfnAlarmModel_DynamoDBv2Property.go
- CfnAlarmModel_FirehoseProperty.go
- CfnAlarmModel_InitializationConfigurationProperty.go
- CfnAlarmModel_IotEventsProperty.go
- CfnAlarmModel_IotSiteWiseProperty.go
- CfnAlarmModel_IotTopicPublishProperty.go
- CfnAlarmModel_LambdaProperty.go
- CfnAlarmModel_PayloadProperty.go
- CfnAlarmModel_SimpleRuleProperty.go
- CfnAlarmModel_SnsProperty.go
- CfnAlarmModel_SqsProperty.go
- CfnAlarmModel__checks.go
- CfnDetectorModel.go
- CfnDetectorModelProps.go
- CfnDetectorModel_ActionProperty.go
- CfnDetectorModel_AssetPropertyTimestampProperty.go
- CfnDetectorModel_AssetPropertyValueProperty.go
- CfnDetectorModel_AssetPropertyVariantProperty.go
- CfnDetectorModel_ClearTimerProperty.go
- CfnDetectorModel_DetectorModelDefinitionProperty.go
- CfnDetectorModel_DynamoDBProperty.go
- CfnDetectorModel_DynamoDBv2Property.go
- CfnDetectorModel_EventProperty.go
- CfnDetectorModel_FirehoseProperty.go
- CfnDetectorModel_IotEventsProperty.go
- CfnDetectorModel_IotSiteWiseProperty.go
- CfnDetectorModel_IotTopicPublishProperty.go
- CfnDetectorModel_LambdaProperty.go
- CfnDetectorModel_OnEnterProperty.go
- CfnDetectorModel_OnExitProperty.go
- CfnDetectorModel_OnInputProperty.go
- CfnDetectorModel_PayloadProperty.go
- CfnDetectorModel_ResetTimerProperty.go
- CfnDetectorModel_SetTimerProperty.go
- CfnDetectorModel_SetVariableProperty.go
- CfnDetectorModel_SnsProperty.go
- CfnDetectorModel_SqsProperty.go
- CfnDetectorModel_StateProperty.go
- CfnDetectorModel_TransitionEventProperty.go
- CfnDetectorModel__checks.go
- CfnInput.go
- CfnInputProps.go
- CfnInput_AttributeProperty.go
- CfnInput_InputDefinitionProperty.go
- CfnInput__checks.go
- main.go