@horietakehiro/aws-cdk-utul 0.10.2 → 0.11.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/stack-manager.d.ts +41 -0
- package/lib/stack-manager.js +132 -0
- package/lib/types/cfn-resource-types/aws-amazonmq-configuration.d.ts +35 -5
- package/lib/types/cfn-resource-types/aws-amazonmq-configuration.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-vpclink.d.ts +0 -9
- package/lib/types/cfn-resource-types/aws-apigateway-vpclink.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigatewayv2-domainname.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-apigatewayv2-domainname.js +1 -1
- package/lib/types/cfn-resource-types/aws-appconfig-deploymentstrategy.d.ts +56 -8
- package/lib/types/cfn-resource-types/aws-appconfig-deploymentstrategy.js +1 -1
- package/lib/types/cfn-resource-types/aws-appsync-datasource.d.ts +151 -31
- package/lib/types/cfn-resource-types/aws-appsync-datasource.js +1 -1
- package/lib/types/cfn-resource-types/aws-appsync-graphqlapi.d.ts +225 -36
- package/lib/types/cfn-resource-types/aws-appsync-graphqlapi.js +1 -1
- package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.d.ts +6 -1
- package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-capability.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-b2bi-capability.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-partnership.d.ts +37 -1
- package/lib/types/cfn-resource-types/aws-b2bi-partnership.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-transformer.d.ts +41 -4
- package/lib/types/cfn-resource-types/aws-b2bi-transformer.js +1 -1
- package/lib/types/cfn-resource-types/aws-backup-logicallyairgappedbackupvault.d.ts +28 -0
- package/lib/types/cfn-resource-types/aws-backup-logicallyairgappedbackupvault.js +3 -0
- package/lib/types/cfn-resource-types/aws-bedrock-agent.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-agent.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-flow.d.ts +17 -6
- package/lib/types/cfn-resource-types/aws-bedrock-flow.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-flowversion.d.ts +17 -6
- package/lib/types/cfn-resource-types/aws-bedrock-flowversion.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-prompt.d.ts +3 -7
- package/lib/types/cfn-resource-types/aws-bedrock-prompt.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-promptversion.d.ts +4 -8
- package/lib/types/cfn-resource-types/aws-bedrock-promptversion.js +1 -1
- package/lib/types/cfn-resource-types/aws-cloudformation-customresource.d.ts +2 -1
- package/lib/types/cfn-resource-types/aws-cloudformation-customresource.js +1 -1
- package/lib/types/cfn-resource-types/aws-codepipeline-pipeline.d.ts +23 -2
- package/lib/types/cfn-resource-types/aws-codepipeline-pipeline.js +1 -1
- package/lib/types/cfn-resource-types/aws-cognito-userpool.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-cognito-userpool.js +1 -1
- package/lib/types/cfn-resource-types/aws-cognito-userpoolidentityprovider.d.ts +15 -8
- package/lib/types/cfn-resource-types/aws-cognito-userpoolidentityprovider.js +1 -1
- package/lib/types/cfn-resource-types/aws-connect-contactflow.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-connect-contactflow.js +1 -1
- package/lib/types/cfn-resource-types/aws-connect-hoursofoperation.d.ts +18 -18
- package/lib/types/cfn-resource-types/aws-connect-hoursofoperation.js +1 -1
- package/lib/types/cfn-resource-types/aws-datasync-task.d.ts +96 -96
- package/lib/types/cfn-resource-types/aws-datasync-task.js +1 -1
- package/lib/types/cfn-resource-types/aws-dms-datamigration.d.ts +90 -0
- package/lib/types/cfn-resource-types/aws-dms-datamigration.js +3 -0
- package/lib/types/cfn-resource-types/aws-dms-replicationinstance.d.ts +1 -0
- package/lib/types/cfn-resource-types/aws-dms-replicationinstance.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-capacityreservation.d.ts +1 -0
- package/lib/types/cfn-resource-types/aws-ec2-capacityreservation.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-eip.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-ec2-eip.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-natgateway.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-natgateway.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgateway.d.ts +6 -5
- package/lib/types/cfn-resource-types/aws-ec2-transitgateway.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayattachment.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayattachment.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayvpcattachment.d.ts +14 -10
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayvpcattachment.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpc.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpc.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.d.ts +2 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpointconnectionnotification.d.ts +8 -8
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpointconnectionnotification.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpnconnection.d.ts +213 -3
- package/lib/types/cfn-resource-types/aws-ec2-vpnconnection.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-capacityprovider.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-capacityprovider.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.d.ts +10 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-taskset.d.ts +57 -51
- package/lib/types/cfn-resource-types/aws-ecs-taskset.js +1 -1
- package/lib/types/cfn-resource-types/aws-eks-cluster.d.ts +11 -1
- package/lib/types/cfn-resource-types/aws-eks-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticache-globalreplicationgroup.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-elasticache-globalreplicationgroup.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listener.d.ts +79 -63
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listener.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listenerrule.d.ts +65 -63
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listenerrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-emr-cluster.d.ts +35 -14
- package/lib/types/cfn-resource-types/aws-emr-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-emr-instancefleetconfig.d.ts +21 -0
- package/lib/types/cfn-resource-types/aws-emr-instancefleetconfig.js +1 -1
- package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.d.ts +81 -81
- package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.js +1 -1
- package/lib/types/cfn-resource-types/aws-gamelift-containergroupdefinition.d.ts +19 -0
- package/lib/types/cfn-resource-types/aws-gamelift-containergroupdefinition.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-crawler.d.ts +179 -1
- package/lib/types/cfn-resource-types/aws-glue-crawler.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-job.d.ts +96 -6
- package/lib/types/cfn-resource-types/aws-glue-job.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-schema.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-glue-schema.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-usageprofile.d.ts +64 -0
- package/lib/types/cfn-resource-types/aws-glue-usageprofile.js +3 -0
- package/lib/types/cfn-resource-types/aws-iam-policy.d.ts +4 -1
- package/lib/types/cfn-resource-types/aws-iam-policy.js +1 -1
- package/lib/types/cfn-resource-types/aws-iam-role.d.ts +3 -2
- package/lib/types/cfn-resource-types/aws-iam-role.js +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-component.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-component.js +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-infrastructureconfiguration.d.ts +22 -0
- package/lib/types/cfn-resource-types/aws-imagebuilder-infrastructureconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-iot-domainconfiguration.d.ts +6 -0
- package/lib/types/cfn-resource-types/aws-iot-domainconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-alarmmodel.d.ts +195 -79
- package/lib/types/cfn-resource-types/aws-iotevents-alarmmodel.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-detectormodel.d.ts +177 -85
- package/lib/types/cfn-resource-types/aws-iotevents-detectormodel.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-input.d.ts +9 -11
- package/lib/types/cfn-resource-types/aws-iotevents-input.js +1 -1
- package/lib/types/cfn-resource-types/aws-ivs-encoderconfiguration.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-ivs-encoderconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-kinesis-resourcepolicy.d.ts +17 -0
- package/lib/types/cfn-resource-types/aws-kinesis-resourcepolicy.js +3 -0
- package/lib/types/cfn-resource-types/aws-lakeformation-principalpermissions.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-principalpermissions.js +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-tag.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-tag.js +1 -1
- package/lib/types/cfn-resource-types/aws-lambda-eventsourcemapping.d.ts +115 -108
- package/lib/types/cfn-resource-types/aws-lambda-eventsourcemapping.js +1 -1
- package/lib/types/cfn-resource-types/aws-medialive-channel.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-medialive-channel.js +1 -1
- package/lib/types/cfn-resource-types/aws-memorydb-cluster.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-memorydb-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-networkfirewall-firewallpolicy.d.ts +3 -0
- package/lib/types/cfn-resource-types/aws-networkfirewall-firewallpolicy.js +1 -1
- package/lib/types/cfn-resource-types/aws-organizations-policy.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-organizations-policy.js +1 -1
- package/lib/types/cfn-resource-types/aws-qbusiness-webexperience.d.ts +6 -0
- package/lib/types/cfn-resource-types/aws-qbusiness-webexperience.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-analysis.d.ts +13 -0
- package/lib/types/cfn-resource-types/aws-quicksight-analysis.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-dashboard.d.ts +13 -0
- package/lib/types/cfn-resource-types/aws-quicksight-dashboard.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-dataset.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-quicksight-dataset.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-datasource.d.ts +247 -242
- package/lib/types/cfn-resource-types/aws-quicksight-datasource.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-folder.d.ts +79 -0
- package/lib/types/cfn-resource-types/aws-quicksight-folder.js +3 -0
- package/lib/types/cfn-resource-types/aws-quicksight-template.d.ts +8 -0
- package/lib/types/cfn-resource-types/aws-quicksight-template.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbcluster.d.ts +366 -366
- package/lib/types/cfn-resource-types/aws-rds-dbcluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbinstance.d.ts +1 -4
- package/lib/types/cfn-resource-types/aws-rds-dbinstance.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-globalcluster.d.ts +19 -0
- package/lib/types/cfn-resource-types/aws-rds-globalcluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-redshift-integration.d.ts +61 -0
- package/lib/types/cfn-resource-types/aws-redshift-integration.js +3 -0
- package/lib/types/cfn-resource-types/aws-refactorspaces-environment.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-refactorspaces-environment.js +1 -1
- package/lib/types/cfn-resource-types/aws-route53profiles-profileassociation.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-route53profiles-profileassociation.js +1 -1
- package/lib/types/cfn-resource-types/aws-route53resolver-resolverrule.d.ts +4 -4
- package/lib/types/cfn-resource-types/aws-route53resolver-resolverrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-s3-bucket.d.ts +599 -591
- package/lib/types/cfn-resource-types/aws-s3-bucket.js +1 -1
- package/lib/types/cfn-resource-types/aws-s3express-directorybucket.d.ts +34 -3
- package/lib/types/cfn-resource-types/aws-s3express-directorybucket.js +1 -1
- package/lib/types/cfn-resource-types/aws-sagemaker-domain.d.ts +8 -0
- package/lib/types/cfn-resource-types/aws-sagemaker-domain.js +1 -1
- package/lib/types/cfn-resource-types/aws-sagemaker-endpoint.d.ts +137 -20
- package/lib/types/cfn-resource-types/aws-sagemaker-endpoint.js +1 -1
- package/lib/types/cfn-resource-types/aws-secretsmanager-secret.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-secretsmanager-secret.js +1 -1
- package/lib/types/cfn-resource-types/aws-securityhub-automationrule.d.ts +4 -4
- package/lib/types/cfn-resource-types/aws-securityhub-automationrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-securityhub-findingaggregator.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-securityhub-findingaggregator.js +1 -1
- package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.d.ts +4 -1
- package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.js +1 -1
- package/lib/types/cfn-resource-types/aws-sns-topic.d.ts +2 -6
- package/lib/types/cfn-resource-types/aws-sns-topic.js +1 -1
- package/lib/types/cfn-resource-types/aws-sqs-queue.d.ts +12 -12
- package/lib/types/cfn-resource-types/aws-sqs-queue.js +1 -1
- package/lib/types/cfn-resource-types/aws-sqs-queuepolicy.d.ts +1 -3
- package/lib/types/cfn-resource-types/aws-sqs-queuepolicy.js +1 -1
- package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.js +1 -1
- package/lib/types/cfn-resource-types/aws-transfer-server.d.ts +70 -36
- package/lib/types/cfn-resource-types/aws-transfer-server.js +1 -1
- package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.d.ts +34 -0
- package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.js +3 -0
- package/lib/types/cfn-resource-types/aws-wisdom-knowledgebase.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-wisdom-knowledgebase.js +1 -1
- package/lib/types/cfn-resource-types/aws-workspacesweb-identityprovider.d.ts +9 -0
- package/lib/types/cfn-resource-types/aws-workspacesweb-identityprovider.js +1 -1
- package/lib/types/cfn-resource-types.d.ts +14 -0
- package/lib/types/cfn-resource-types.js +40 -26
- package/package.json +11 -7
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* 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
|
|
2
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
|
|
3
|
+
* When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) 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.)
|
|
4
|
+
* When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) 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.)
|
|
5
|
+
* If you attempt to update a detector model using CFN 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.
|
|
6
|
+
* Also, be aware that if you attempt to update several detector models at once using CFN, 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.
|
|
3
7
|
*/
|
|
4
8
|
export interface _AWS_IOTEVENTS_DETECTORMODEL {
|
|
5
9
|
DetectorModelDefinition: DetectorModelDefinition;
|
|
@@ -16,19 +20,17 @@ export interface _AWS_IOTEVENTS_DETECTORMODEL {
|
|
|
16
20
|
*/
|
|
17
21
|
EvaluationMethod?: ("BATCH" | "SERIAL");
|
|
18
22
|
/**
|
|
19
|
-
* 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.
|
|
20
|
-
*
|
|
21
|
-
* 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.
|
|
23
|
+
* 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. ITE can continue to route input to its corresponding detector instance based on this identifying information.
|
|
24
|
+
* 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.
|
|
22
25
|
*/
|
|
23
26
|
Key?: string;
|
|
24
27
|
/**
|
|
25
|
-
* The ARN of the role that grants permission to
|
|
28
|
+
* The ARN of the role that grants permission to ITE to perform its operations.
|
|
26
29
|
*/
|
|
27
30
|
RoleArn: string;
|
|
28
31
|
/**
|
|
29
32
|
* An array of key-value pairs to apply to this resource.
|
|
30
|
-
*
|
|
31
|
-
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
|
33
|
+
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
|
32
34
|
*/
|
|
33
35
|
Tags?: Tag[];
|
|
34
36
|
}
|
|
@@ -60,16 +62,16 @@ export interface State {
|
|
|
60
62
|
StateName: string;
|
|
61
63
|
}
|
|
62
64
|
/**
|
|
63
|
-
* When entering this state, perform these
|
|
65
|
+
* When entering this state, perform these ``actions`` if the ``condition`` is TRUE.
|
|
64
66
|
*/
|
|
65
67
|
export interface OnEnter {
|
|
66
68
|
/**
|
|
67
|
-
* Specifies the
|
|
69
|
+
* Specifies the actions that are performed when the state is entered and the ``condition`` is ``TRUE``.
|
|
68
70
|
*/
|
|
69
71
|
Events?: Event[];
|
|
70
72
|
}
|
|
71
73
|
/**
|
|
72
|
-
* Specifies the
|
|
74
|
+
* Specifies the ``actions`` to be performed when the ``condition`` evaluates to TRUE.
|
|
73
75
|
*/
|
|
74
76
|
export interface Event {
|
|
75
77
|
/**
|
|
@@ -77,7 +79,7 @@ export interface Event {
|
|
|
77
79
|
*/
|
|
78
80
|
Actions?: Action[];
|
|
79
81
|
/**
|
|
80
|
-
* The Boolean expression that, when
|
|
82
|
+
* 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).
|
|
81
83
|
*/
|
|
82
84
|
Condition?: string;
|
|
83
85
|
/**
|
|
@@ -86,7 +88,7 @@ export interface Event {
|
|
|
86
88
|
EventName: string;
|
|
87
89
|
}
|
|
88
90
|
/**
|
|
89
|
-
*
|
|
91
|
+
* An action to be performed when the ``condition`` is TRUE.
|
|
90
92
|
*/
|
|
91
93
|
export interface Action {
|
|
92
94
|
ClearTimer?: ClearTimer;
|
|
@@ -107,24 +109,25 @@ export interface Action {
|
|
|
107
109
|
* Information needed to clear the timer.
|
|
108
110
|
*/
|
|
109
111
|
export interface ClearTimer {
|
|
112
|
+
/**
|
|
113
|
+
* The name of the timer to clear.
|
|
114
|
+
*/
|
|
110
115
|
TimerName: string;
|
|
111
116
|
}
|
|
112
117
|
/**
|
|
113
|
-
* 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
|
|
118
|
+
* 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 *Developer Guide*.
|
|
114
119
|
*/
|
|
115
120
|
export interface DynamoDB {
|
|
116
121
|
/**
|
|
117
|
-
* The name of the hash key (also called the partition key).
|
|
122
|
+
* The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table.
|
|
118
123
|
*/
|
|
119
124
|
HashKeyField: string;
|
|
120
125
|
/**
|
|
121
126
|
* The data type for the hash key (also called the partition key). You can specify the following values:
|
|
127
|
+
* + ``'STRING'`` - The hash key is a string.
|
|
128
|
+
* + ``'NUMBER'`` - The hash key is a number.
|
|
122
129
|
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* * `NUMBER` - The hash key is a number.
|
|
126
|
-
*
|
|
127
|
-
* If you don't specify `hashKeyType`, the default value is `STRING`.
|
|
130
|
+
* If you don't specify ``hashKeyType``, the default value is ``'STRING'``.
|
|
128
131
|
*/
|
|
129
132
|
HashKeyType?: string;
|
|
130
133
|
/**
|
|
@@ -133,35 +136,29 @@ export interface DynamoDB {
|
|
|
133
136
|
HashKeyValue: string;
|
|
134
137
|
/**
|
|
135
138
|
* The type of operation to perform. You can specify the following values:
|
|
139
|
+
* + ``'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.
|
|
140
|
+
* + ``'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.
|
|
141
|
+
* + ``'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.
|
|
136
142
|
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
* * `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.
|
|
140
|
-
*
|
|
141
|
-
* * `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.
|
|
142
|
-
*
|
|
143
|
-
* If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.
|
|
143
|
+
* If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation.
|
|
144
144
|
*/
|
|
145
145
|
Operation?: string;
|
|
146
146
|
Payload?: Payload;
|
|
147
147
|
/**
|
|
148
148
|
* The name of the DynamoDB column that receives the action payload.
|
|
149
|
-
*
|
|
150
|
-
* If you don't specify this parameter, the name of the DynamoDB column is `payload`.
|
|
149
|
+
* If you don't specify this parameter, the name of the DynamoDB column is ``payload``.
|
|
151
150
|
*/
|
|
152
151
|
PayloadField?: string;
|
|
153
152
|
/**
|
|
154
|
-
* The name of the range key (also called the sort key).
|
|
153
|
+
* The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table.
|
|
155
154
|
*/
|
|
156
155
|
RangeKeyField?: string;
|
|
157
156
|
/**
|
|
158
157
|
* The data type for the range key (also called the sort key), You can specify the following values:
|
|
158
|
+
* + ``'STRING'`` - The range key is a string.
|
|
159
|
+
* + ``'NUMBER'`` - The range key is number.
|
|
159
160
|
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
* * `NUMBER` - The range key is number.
|
|
163
|
-
*
|
|
164
|
-
* If you don't specify `rangeKeyField`, the default value is `STRING`.
|
|
161
|
+
* If you don't specify ``rangeKeyField``, the default value is ``'STRING'``.
|
|
165
162
|
*/
|
|
166
163
|
RangeKeyType?: string;
|
|
167
164
|
/**
|
|
@@ -169,37 +166,48 @@ export interface DynamoDB {
|
|
|
169
166
|
*/
|
|
170
167
|
RangeKeyValue?: string;
|
|
171
168
|
/**
|
|
172
|
-
* The name of the DynamoDB table.
|
|
169
|
+
* The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table.
|
|
173
170
|
*/
|
|
174
171
|
TableName: string;
|
|
175
172
|
}
|
|
176
173
|
/**
|
|
177
174
|
* Information needed to configure the payload.
|
|
178
|
-
*
|
|
179
|
-
* 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`.
|
|
175
|
+
* By default, ITE 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``.
|
|
180
176
|
*/
|
|
181
177
|
export interface Payload {
|
|
182
178
|
/**
|
|
183
|
-
* The content of the payload. You can use a string expression that includes quoted strings (
|
|
179
|
+
* 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.
|
|
184
180
|
*/
|
|
185
181
|
ContentExpression: string;
|
|
186
182
|
/**
|
|
187
|
-
* The value of the payload type can be either
|
|
183
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
188
184
|
*/
|
|
189
185
|
Type: string;
|
|
190
186
|
}
|
|
191
187
|
/**
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
* You can use expressions for parameters that are strings. For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*.
|
|
188
|
+
* 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 *Developer Guide*.
|
|
195
189
|
*/
|
|
196
190
|
export interface DynamoDBv2 {
|
|
197
|
-
Payload?:
|
|
191
|
+
Payload?: Payload1;
|
|
198
192
|
/**
|
|
199
193
|
* The name of the DynamoDB table.
|
|
200
194
|
*/
|
|
201
195
|
TableName: string;
|
|
202
196
|
}
|
|
197
|
+
/**
|
|
198
|
+
* Information needed to configure the payload.
|
|
199
|
+
* By default, ITE 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``.
|
|
200
|
+
*/
|
|
201
|
+
export interface Payload1 {
|
|
202
|
+
/**
|
|
203
|
+
* 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.
|
|
204
|
+
*/
|
|
205
|
+
ContentExpression: string;
|
|
206
|
+
/**
|
|
207
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
208
|
+
*/
|
|
209
|
+
Type: string;
|
|
210
|
+
}
|
|
203
211
|
/**
|
|
204
212
|
* Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
|
|
205
213
|
*/
|
|
@@ -208,108 +216,163 @@ export interface Firehose {
|
|
|
208
216
|
* The name of the Kinesis Data Firehose delivery stream where the data is written.
|
|
209
217
|
*/
|
|
210
218
|
DeliveryStreamName: string;
|
|
211
|
-
Payload?:
|
|
219
|
+
Payload?: Payload2;
|
|
212
220
|
/**
|
|
213
221
|
* 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).
|
|
214
222
|
*/
|
|
215
223
|
Separator?: string;
|
|
216
224
|
}
|
|
217
225
|
/**
|
|
218
|
-
*
|
|
226
|
+
* You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
|
|
227
|
+
*/
|
|
228
|
+
export interface Payload2 {
|
|
229
|
+
/**
|
|
230
|
+
* 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.
|
|
231
|
+
*/
|
|
232
|
+
ContentExpression: string;
|
|
233
|
+
/**
|
|
234
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
235
|
+
*/
|
|
236
|
+
Type: string;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Sends ITE input, which passes information about the detector model instance and the event that triggered the action.
|
|
219
240
|
*/
|
|
220
241
|
export interface IotEvents {
|
|
221
242
|
/**
|
|
222
|
-
* The name of the
|
|
243
|
+
* The name of the ITE input where the data is sent.
|
|
223
244
|
*/
|
|
224
245
|
InputName: string;
|
|
225
|
-
Payload?:
|
|
246
|
+
Payload?: Payload3;
|
|
226
247
|
}
|
|
227
248
|
/**
|
|
228
|
-
*
|
|
249
|
+
* You can configure the action payload when you send a message to an ITE input.
|
|
250
|
+
*/
|
|
251
|
+
export interface Payload3 {
|
|
252
|
+
/**
|
|
253
|
+
* 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.
|
|
254
|
+
*/
|
|
255
|
+
ContentExpression: string;
|
|
256
|
+
/**
|
|
257
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
258
|
+
*/
|
|
259
|
+
Type: string;
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
* Sends information about the detector model instance and the event that triggered the action to an asset property in ITSW .
|
|
229
263
|
*/
|
|
230
264
|
export interface IotSiteWise {
|
|
231
265
|
/**
|
|
232
|
-
* The ID of the asset that has the specified property.
|
|
266
|
+
* The ID of the asset that has the specified property.
|
|
233
267
|
*/
|
|
234
268
|
AssetId?: string;
|
|
235
269
|
/**
|
|
236
|
-
* 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.
|
|
270
|
+
* 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.
|
|
237
271
|
*/
|
|
238
272
|
EntryId?: string;
|
|
239
273
|
/**
|
|
240
|
-
* The alias of the asset property.
|
|
274
|
+
* The alias of the asset property.
|
|
241
275
|
*/
|
|
242
276
|
PropertyAlias?: string;
|
|
243
277
|
/**
|
|
244
|
-
* The ID of the asset property.
|
|
278
|
+
* The ID of the asset property.
|
|
245
279
|
*/
|
|
246
280
|
PropertyId?: string;
|
|
247
281
|
PropertyValue: AssetPropertyValue;
|
|
248
282
|
}
|
|
249
283
|
/**
|
|
250
|
-
*
|
|
284
|
+
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
|
|
251
285
|
*/
|
|
252
286
|
export interface AssetPropertyValue {
|
|
253
287
|
/**
|
|
254
|
-
* The quality of the asset property value. The value must be
|
|
288
|
+
* The quality of the asset property value. The value must be ``'GOOD'``, ``'BAD'``, or ``'UNCERTAIN'``.
|
|
255
289
|
*/
|
|
256
290
|
Quality?: string;
|
|
257
291
|
Timestamp?: AssetPropertyTimestamp;
|
|
258
292
|
Value: AssetPropertyVariant;
|
|
259
293
|
}
|
|
260
294
|
/**
|
|
261
|
-
*
|
|
295
|
+
* The timestamp associated with the asset property value. The default is the current event time.
|
|
262
296
|
*/
|
|
263
297
|
export interface AssetPropertyTimestamp {
|
|
264
298
|
/**
|
|
265
|
-
* The
|
|
299
|
+
* The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999.
|
|
266
300
|
*/
|
|
267
301
|
OffsetInNanos?: string;
|
|
268
302
|
/**
|
|
269
|
-
* The
|
|
303
|
+
* The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
|
|
270
304
|
*/
|
|
271
305
|
TimeInSeconds: string;
|
|
272
306
|
}
|
|
273
307
|
/**
|
|
274
|
-
*
|
|
308
|
+
* The value to send to an asset property.
|
|
275
309
|
*/
|
|
276
310
|
export interface AssetPropertyVariant {
|
|
277
311
|
/**
|
|
278
|
-
* The asset property value is a Boolean value that must be
|
|
312
|
+
* 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.
|
|
279
313
|
*/
|
|
280
314
|
BooleanValue?: string;
|
|
281
315
|
/**
|
|
282
|
-
* The asset property value is a double. You
|
|
316
|
+
* The asset property value is a double. You must use an expression, and the evaluated result should be a double.
|
|
283
317
|
*/
|
|
284
318
|
DoubleValue?: string;
|
|
285
319
|
/**
|
|
286
|
-
* The asset property value is an integer. You
|
|
320
|
+
* The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
|
|
287
321
|
*/
|
|
288
322
|
IntegerValue?: string;
|
|
289
323
|
/**
|
|
290
|
-
* The asset property value is a string. You
|
|
324
|
+
* The asset property value is a string. You must use an expression, and the evaluated result should be a string.
|
|
291
325
|
*/
|
|
292
326
|
StringValue?: string;
|
|
293
327
|
}
|
|
294
328
|
/**
|
|
295
|
-
*
|
|
329
|
+
* Publishes an MQTT message with the given topic to the IoT message broker.
|
|
296
330
|
*/
|
|
297
331
|
export interface IotTopicPublish {
|
|
298
332
|
/**
|
|
299
|
-
* The MQTT topic of the message. You can use a string expression that includes variables (
|
|
333
|
+
* 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.
|
|
300
334
|
*/
|
|
301
335
|
MqttTopic: string;
|
|
302
|
-
Payload?:
|
|
336
|
+
Payload?: Payload4;
|
|
303
337
|
}
|
|
338
|
+
/**
|
|
339
|
+
* You can configure the action payload when you publish a message to an IoTCore topic.
|
|
340
|
+
*/
|
|
341
|
+
export interface Payload4 {
|
|
342
|
+
/**
|
|
343
|
+
* 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.
|
|
344
|
+
*/
|
|
345
|
+
ContentExpression: string;
|
|
346
|
+
/**
|
|
347
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
348
|
+
*/
|
|
349
|
+
Type: string;
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
|
353
|
+
*/
|
|
304
354
|
export interface Lambda {
|
|
305
355
|
/**
|
|
306
356
|
* The ARN of the Lambda function that is executed.
|
|
307
357
|
*/
|
|
308
358
|
FunctionArn: string;
|
|
309
|
-
Payload?:
|
|
359
|
+
Payload?: Payload5;
|
|
310
360
|
}
|
|
311
361
|
/**
|
|
312
|
-
*
|
|
362
|
+
* You can configure the action payload when you send a message to a Lambda function.
|
|
363
|
+
*/
|
|
364
|
+
export interface Payload5 {
|
|
365
|
+
/**
|
|
366
|
+
* 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.
|
|
367
|
+
*/
|
|
368
|
+
ContentExpression: string;
|
|
369
|
+
/**
|
|
370
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
371
|
+
*/
|
|
372
|
+
Type: string;
|
|
373
|
+
}
|
|
374
|
+
/**
|
|
375
|
+
* Information needed to reset the timer.
|
|
313
376
|
*/
|
|
314
377
|
export interface ResetTimer {
|
|
315
378
|
/**
|
|
@@ -322,11 +385,11 @@ export interface ResetTimer {
|
|
|
322
385
|
*/
|
|
323
386
|
export interface SetTimer {
|
|
324
387
|
/**
|
|
325
|
-
* The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (
|
|
388
|
+
* 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.
|
|
326
389
|
*/
|
|
327
390
|
DurationExpression?: string;
|
|
328
391
|
/**
|
|
329
|
-
* The number of seconds until the timer expires. The minimum value is
|
|
392
|
+
* The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
|
|
330
393
|
*/
|
|
331
394
|
Seconds?: number;
|
|
332
395
|
/**
|
|
@@ -335,7 +398,7 @@ export interface SetTimer {
|
|
|
335
398
|
TimerName: string;
|
|
336
399
|
}
|
|
337
400
|
/**
|
|
338
|
-
*
|
|
401
|
+
* Sets a variable to a specified value.
|
|
339
402
|
*/
|
|
340
403
|
export interface SetVariable {
|
|
341
404
|
/**
|
|
@@ -348,50 +411,79 @@ export interface SetVariable {
|
|
|
348
411
|
VariableName: string;
|
|
349
412
|
}
|
|
350
413
|
/**
|
|
351
|
-
*
|
|
414
|
+
* Sends an Amazon SNS message.
|
|
352
415
|
*/
|
|
353
416
|
export interface Sns {
|
|
354
|
-
Payload?:
|
|
417
|
+
Payload?: Payload6;
|
|
355
418
|
/**
|
|
356
419
|
* The ARN of the Amazon SNS target where the message is sent.
|
|
357
420
|
*/
|
|
358
421
|
TargetArn: string;
|
|
359
422
|
}
|
|
423
|
+
/**
|
|
424
|
+
* You can configure the action payload when you send a message as an Amazon SNS push notification.
|
|
425
|
+
*/
|
|
426
|
+
export interface Payload6 {
|
|
427
|
+
/**
|
|
428
|
+
* 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.
|
|
429
|
+
*/
|
|
430
|
+
ContentExpression: string;
|
|
431
|
+
/**
|
|
432
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
433
|
+
*/
|
|
434
|
+
Type: string;
|
|
435
|
+
}
|
|
436
|
+
/**
|
|
437
|
+
* Sends an Amazon SNS message.
|
|
438
|
+
*/
|
|
360
439
|
export interface Sqs {
|
|
361
|
-
Payload?:
|
|
440
|
+
Payload?: Payload7;
|
|
362
441
|
/**
|
|
363
442
|
* The URL of the SQS queue where the data is written.
|
|
364
443
|
*/
|
|
365
444
|
QueueUrl: string;
|
|
366
445
|
/**
|
|
367
|
-
* Set this to
|
|
446
|
+
* 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.
|
|
368
447
|
*/
|
|
369
448
|
UseBase64?: boolean;
|
|
370
449
|
}
|
|
371
450
|
/**
|
|
372
|
-
*
|
|
451
|
+
* You can configure the action payload when you send a message to an Amazon SQS queue.
|
|
452
|
+
*/
|
|
453
|
+
export interface Payload7 {
|
|
454
|
+
/**
|
|
455
|
+
* 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.
|
|
456
|
+
*/
|
|
457
|
+
ContentExpression: string;
|
|
458
|
+
/**
|
|
459
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
460
|
+
*/
|
|
461
|
+
Type: string;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
* When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``.
|
|
373
465
|
*/
|
|
374
466
|
export interface OnExit {
|
|
375
467
|
/**
|
|
376
|
-
* Specifies the
|
|
468
|
+
* Specifies the ``actions`` that are performed when the state is exited and the ``condition`` is ``TRUE``.
|
|
377
469
|
*/
|
|
378
470
|
Events?: Event[];
|
|
379
471
|
}
|
|
380
472
|
/**
|
|
381
|
-
* When an input is received and the
|
|
473
|
+
* When an input is received and the ``condition`` is TRUE, perform the specified ``actions``.
|
|
382
474
|
*/
|
|
383
475
|
export interface OnInput {
|
|
384
476
|
/**
|
|
385
|
-
* Specifies the
|
|
477
|
+
* Specifies the actions performed when the ``condition`` evaluates to TRUE.
|
|
386
478
|
*/
|
|
387
479
|
Events?: Event[];
|
|
388
480
|
/**
|
|
389
|
-
* Specifies the
|
|
481
|
+
* Specifies the actions performed, and the next state entered, when a ``condition`` evaluates to TRUE.
|
|
390
482
|
*/
|
|
391
483
|
TransitionEvents?: TransitionEvent[];
|
|
392
484
|
}
|
|
393
485
|
/**
|
|
394
|
-
* Specifies the
|
|
486
|
+
* Specifies the actions performed and the next state entered when a ``condition`` evaluates to TRUE.
|
|
395
487
|
*/
|
|
396
488
|
export interface TransitionEvent {
|
|
397
489
|
/**
|
|
@@ -399,11 +491,11 @@ export interface TransitionEvent {
|
|
|
399
491
|
*/
|
|
400
492
|
Actions?: Action[];
|
|
401
493
|
/**
|
|
402
|
-
* A Boolean expression that when
|
|
494
|
+
* Required. A Boolean expression that when TRUE causes the actions to be performed and the ``nextState`` to be entered.
|
|
403
495
|
*/
|
|
404
496
|
Condition: string;
|
|
405
497
|
/**
|
|
406
|
-
* The name of the event.
|
|
498
|
+
* The name of the transition event.
|
|
407
499
|
*/
|
|
408
500
|
EventName: string;
|
|
409
501
|
/**
|
|
@@ -412,15 +504,15 @@ export interface TransitionEvent {
|
|
|
412
504
|
NextState: string;
|
|
413
505
|
}
|
|
414
506
|
/**
|
|
415
|
-
*
|
|
507
|
+
* Metadata that can be used to manage the resource.
|
|
416
508
|
*/
|
|
417
509
|
export interface Tag {
|
|
418
510
|
/**
|
|
419
|
-
*
|
|
511
|
+
* The tag's key.
|
|
420
512
|
*/
|
|
421
513
|
Key: string;
|
|
422
514
|
/**
|
|
423
|
-
*
|
|
515
|
+
* The tag's value.
|
|
424
516
|
*/
|
|
425
517
|
Value: string;
|
|
426
518
|
}
|