@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
|
@@ -3,9 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export type AlarmActions = AlarmAction[];
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.
|
|
6
|
+
* Represents an alarm model to monitor an ITE 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 *Developer Guide*.
|
|
9
7
|
*/
|
|
10
8
|
export interface _AWS_IOTEVENTS_ALARMMODEL {
|
|
11
9
|
/**
|
|
@@ -13,32 +11,27 @@ export interface _AWS_IOTEVENTS_ALARMMODEL {
|
|
|
13
11
|
*/
|
|
14
12
|
AlarmModelName?: string;
|
|
15
13
|
/**
|
|
16
|
-
*
|
|
14
|
+
* The description of the alarm model.
|
|
17
15
|
*/
|
|
18
16
|
AlarmModelDescription?: string;
|
|
19
17
|
/**
|
|
20
|
-
* The ARN of the role that
|
|
18
|
+
* 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 *General Reference*.
|
|
21
19
|
*/
|
|
22
20
|
RoleArn: string;
|
|
23
21
|
/**
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* 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 alarm instance, the device must send a message payload that contains the same attribute-value.
|
|
22
|
+
* An input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm.
|
|
27
23
|
*/
|
|
28
24
|
Key?: string;
|
|
29
25
|
/**
|
|
30
26
|
* A non-negative integer that reflects the severity level of the alarm.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
27
|
*/
|
|
34
28
|
Severity?: number;
|
|
35
29
|
AlarmRule: AlarmRule;
|
|
36
30
|
AlarmEventActions?: AlarmEventActions;
|
|
37
31
|
AlarmCapabilities?: AlarmCapabilities;
|
|
38
32
|
/**
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
|
33
|
+
* 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 resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *Developer Guide*.
|
|
34
|
+
* You can create up to 50 tags for one alarm model.
|
|
42
35
|
*/
|
|
43
36
|
Tags?: Tag[];
|
|
44
37
|
}
|
|
@@ -53,7 +46,7 @@ export interface AlarmRule {
|
|
|
53
46
|
*/
|
|
54
47
|
export interface SimpleRule {
|
|
55
48
|
/**
|
|
56
|
-
* The value on the left side of the comparison operator. You can specify an
|
|
49
|
+
* The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property.
|
|
57
50
|
*/
|
|
58
51
|
InputProperty: string;
|
|
59
52
|
/**
|
|
@@ -61,7 +54,7 @@ export interface SimpleRule {
|
|
|
61
54
|
*/
|
|
62
55
|
ComparisonOperator: ("GREATER" | "GREATER_OR_EQUAL" | "LESS" | "LESS_OR_EQUAL" | "EQUAL" | "NOT_EQUAL");
|
|
63
56
|
/**
|
|
64
|
-
* The value on the right side of the comparison operator. You can enter a number or specify an
|
|
57
|
+
* The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute.
|
|
65
58
|
*/
|
|
66
59
|
Threshold: string;
|
|
67
60
|
}
|
|
@@ -72,7 +65,7 @@ export interface AlarmEventActions {
|
|
|
72
65
|
AlarmActions?: AlarmActions;
|
|
73
66
|
}
|
|
74
67
|
/**
|
|
75
|
-
*
|
|
68
|
+
* Specifies one of the following actions to receive notifications when the alarm state changes.
|
|
76
69
|
*/
|
|
77
70
|
export interface AlarmAction {
|
|
78
71
|
DynamoDB?: DynamoDB;
|
|
@@ -86,21 +79,32 @@ export interface AlarmAction {
|
|
|
86
79
|
Sqs?: Sqs;
|
|
87
80
|
}
|
|
88
81
|
/**
|
|
89
|
-
*
|
|
82
|
+
* 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.
|
|
83
|
+
* You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.
|
|
84
|
+
* **Examples**
|
|
85
|
+
* + For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.
|
|
86
|
+
* + For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.
|
|
87
|
+
* + 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.
|
|
88
|
+
* In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template.
|
|
89
|
+
* ``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'``
|
|
90
|
+
* + For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
|
91
|
+
* In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
|
92
|
+
* ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
|
93
|
+
*
|
|
94
|
+
* For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
|
95
|
+
* 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``.
|
|
90
96
|
*/
|
|
91
97
|
export interface DynamoDB {
|
|
92
98
|
/**
|
|
93
|
-
* The name of the hash key (also called the partition key).
|
|
99
|
+
* The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table.
|
|
94
100
|
*/
|
|
95
101
|
HashKeyField: string;
|
|
96
102
|
/**
|
|
97
103
|
* The data type for the hash key (also called the partition key). You can specify the following values:
|
|
104
|
+
* + ``'STRING'`` - The hash key is a string.
|
|
105
|
+
* + ``'NUMBER'`` - The hash key is a number.
|
|
98
106
|
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
* * `NUMBER` - The hash key is a number.
|
|
102
|
-
*
|
|
103
|
-
* If you don't specify `hashKeyType`, the default value is `STRING`.
|
|
107
|
+
* If you don't specify ``hashKeyType``, the default value is ``'STRING'``.
|
|
104
108
|
*/
|
|
105
109
|
HashKeyType?: string;
|
|
106
110
|
/**
|
|
@@ -109,35 +113,29 @@ export interface DynamoDB {
|
|
|
109
113
|
HashKeyValue: string;
|
|
110
114
|
/**
|
|
111
115
|
* The type of operation to perform. You can specify the following values:
|
|
116
|
+
* + ``'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.
|
|
117
|
+
* + ``'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.
|
|
118
|
+
* + ``'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.
|
|
112
119
|
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
* * `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.
|
|
116
|
-
*
|
|
117
|
-
* * `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.
|
|
118
|
-
*
|
|
119
|
-
* If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.
|
|
120
|
+
* If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation.
|
|
120
121
|
*/
|
|
121
122
|
Operation?: string;
|
|
122
123
|
Payload?: Payload;
|
|
123
124
|
/**
|
|
124
125
|
* The name of the DynamoDB column that receives the action payload.
|
|
125
|
-
*
|
|
126
|
-
* If you don't specify this parameter, the name of the DynamoDB column is `payload`.
|
|
126
|
+
* If you don't specify this parameter, the name of the DynamoDB column is ``payload``.
|
|
127
127
|
*/
|
|
128
128
|
PayloadField?: string;
|
|
129
129
|
/**
|
|
130
|
-
* The name of the range key (also called the sort key).
|
|
130
|
+
* The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table.
|
|
131
131
|
*/
|
|
132
132
|
RangeKeyField?: string;
|
|
133
133
|
/**
|
|
134
134
|
* The data type for the range key (also called the sort key), You can specify the following values:
|
|
135
|
+
* + ``'STRING'`` - The range key is a string.
|
|
136
|
+
* + ``'NUMBER'`` - The range key is number.
|
|
135
137
|
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
* * `NUMBER` - The range key is number.
|
|
139
|
-
*
|
|
140
|
-
* If you don't specify `rangeKeyField`, the default value is `STRING`.
|
|
138
|
+
* If you don't specify ``rangeKeyField``, the default value is ``'STRING'``.
|
|
141
139
|
*/
|
|
142
140
|
RangeKeyType?: string;
|
|
143
141
|
/**
|
|
@@ -145,168 +143,286 @@ export interface DynamoDB {
|
|
|
145
143
|
*/
|
|
146
144
|
RangeKeyValue?: string;
|
|
147
145
|
/**
|
|
148
|
-
* The name of the DynamoDB table.
|
|
146
|
+
* The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table.
|
|
149
147
|
*/
|
|
150
148
|
TableName: string;
|
|
151
149
|
}
|
|
152
150
|
/**
|
|
153
151
|
* Information needed to configure the payload.
|
|
154
|
-
*
|
|
155
|
-
* 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 alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
|
152
|
+
* 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``.
|
|
156
153
|
*/
|
|
157
154
|
export interface Payload {
|
|
158
155
|
/**
|
|
159
|
-
* The content of the payload. You can use a string expression that includes quoted strings (
|
|
156
|
+
* 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.
|
|
160
157
|
*/
|
|
161
158
|
ContentExpression: string;
|
|
162
159
|
/**
|
|
163
|
-
* The value of the payload type can be either
|
|
160
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
164
161
|
*/
|
|
165
162
|
Type: string;
|
|
166
163
|
}
|
|
167
164
|
/**
|
|
168
|
-
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all
|
|
165
|
+
* 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.
|
|
166
|
+
* You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.
|
|
167
|
+
* **Examples**
|
|
168
|
+
* + For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.
|
|
169
|
+
* + For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.
|
|
170
|
+
* + 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.
|
|
171
|
+
* In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template.
|
|
172
|
+
* ``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'``
|
|
173
|
+
* + For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
|
174
|
+
* In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
|
175
|
+
* ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
|
169
176
|
*
|
|
170
|
-
*
|
|
177
|
+
* For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
|
178
|
+
* The value for the ``type`` parameter in ``Payload`` must be ``JSON``.
|
|
171
179
|
*/
|
|
172
180
|
export interface DynamoDBv2 {
|
|
173
|
-
Payload?:
|
|
181
|
+
Payload?: Payload1;
|
|
174
182
|
/**
|
|
175
183
|
* The name of the DynamoDB table.
|
|
176
184
|
*/
|
|
177
185
|
TableName: string;
|
|
178
186
|
}
|
|
179
187
|
/**
|
|
180
|
-
*
|
|
188
|
+
* Information needed to configure the payload.
|
|
189
|
+
* 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``.
|
|
190
|
+
*/
|
|
191
|
+
export interface Payload1 {
|
|
192
|
+
/**
|
|
193
|
+
* 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.
|
|
194
|
+
*/
|
|
195
|
+
ContentExpression: string;
|
|
196
|
+
/**
|
|
197
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
198
|
+
*/
|
|
199
|
+
Type: string;
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
|
|
181
203
|
*/
|
|
182
204
|
export interface Firehose {
|
|
183
205
|
/**
|
|
184
206
|
* The name of the Kinesis Data Firehose delivery stream where the data is written.
|
|
185
207
|
*/
|
|
186
208
|
DeliveryStreamName: string;
|
|
187
|
-
Payload?:
|
|
209
|
+
Payload?: Payload2;
|
|
188
210
|
/**
|
|
189
211
|
* 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).
|
|
190
212
|
*/
|
|
191
213
|
Separator?: string;
|
|
192
214
|
}
|
|
193
215
|
/**
|
|
194
|
-
*
|
|
216
|
+
* You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
|
|
217
|
+
*/
|
|
218
|
+
export interface Payload2 {
|
|
219
|
+
/**
|
|
220
|
+
* 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.
|
|
221
|
+
*/
|
|
222
|
+
ContentExpression: string;
|
|
223
|
+
/**
|
|
224
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
225
|
+
*/
|
|
226
|
+
Type: string;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.
|
|
195
230
|
*/
|
|
196
231
|
export interface IotEvents {
|
|
197
232
|
/**
|
|
198
|
-
* The name of the
|
|
233
|
+
* The name of the ITE input where the data is sent.
|
|
199
234
|
*/
|
|
200
235
|
InputName: string;
|
|
201
|
-
Payload?:
|
|
236
|
+
Payload?: Payload3;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* You can configure the action payload when you send a message to an ITE input.
|
|
240
|
+
*/
|
|
241
|
+
export interface Payload3 {
|
|
242
|
+
/**
|
|
243
|
+
* 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.
|
|
244
|
+
*/
|
|
245
|
+
ContentExpression: string;
|
|
246
|
+
/**
|
|
247
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
248
|
+
*/
|
|
249
|
+
Type: string;
|
|
202
250
|
}
|
|
203
251
|
/**
|
|
204
|
-
* Sends information about the
|
|
252
|
+
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.
|
|
253
|
+
* You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.
|
|
254
|
+
* **Examples**
|
|
255
|
+
* + 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'``.
|
|
256
|
+
* + For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.
|
|
257
|
+
* + 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.
|
|
258
|
+
* In the following example, the value for the ``propertyAlias`` parameter uses a substitution template.
|
|
259
|
+
* ``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'``
|
|
260
|
+
*
|
|
261
|
+
* You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.
|
|
262
|
+
* For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
|
205
263
|
*/
|
|
206
264
|
export interface IotSiteWise {
|
|
207
265
|
/**
|
|
208
|
-
* The ID of the asset that has the specified property.
|
|
266
|
+
* The ID of the asset that has the specified property.
|
|
209
267
|
*/
|
|
210
268
|
AssetId?: string;
|
|
211
269
|
/**
|
|
212
|
-
* 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.
|
|
213
271
|
*/
|
|
214
272
|
EntryId?: string;
|
|
215
273
|
/**
|
|
216
|
-
* The alias of the asset property.
|
|
274
|
+
* The alias of the asset property.
|
|
217
275
|
*/
|
|
218
276
|
PropertyAlias?: string;
|
|
219
277
|
/**
|
|
220
|
-
* The ID of the asset property.
|
|
278
|
+
* The ID of the asset property.
|
|
221
279
|
*/
|
|
222
280
|
PropertyId?: string;
|
|
223
281
|
PropertyValue?: AssetPropertyValue;
|
|
224
282
|
}
|
|
225
283
|
/**
|
|
226
|
-
*
|
|
284
|
+
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
|
|
227
285
|
*/
|
|
228
286
|
export interface AssetPropertyValue {
|
|
229
287
|
/**
|
|
230
|
-
* 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'``.
|
|
231
289
|
*/
|
|
232
290
|
Quality?: string;
|
|
233
291
|
Timestamp?: AssetPropertyTimestamp;
|
|
234
292
|
Value: AssetPropertyVariant;
|
|
235
293
|
}
|
|
236
294
|
/**
|
|
237
|
-
*
|
|
295
|
+
* The timestamp associated with the asset property value. The default is the current event time.
|
|
238
296
|
*/
|
|
239
297
|
export interface AssetPropertyTimestamp {
|
|
240
298
|
/**
|
|
241
|
-
* The
|
|
299
|
+
* The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999.
|
|
242
300
|
*/
|
|
243
301
|
OffsetInNanos?: string;
|
|
244
302
|
/**
|
|
245
|
-
* The
|
|
303
|
+
* The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
|
|
246
304
|
*/
|
|
247
305
|
TimeInSeconds: string;
|
|
248
306
|
}
|
|
249
307
|
/**
|
|
250
|
-
*
|
|
308
|
+
* The value to send to an asset property.
|
|
251
309
|
*/
|
|
252
310
|
export interface AssetPropertyVariant {
|
|
253
311
|
/**
|
|
254
|
-
* 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.
|
|
255
313
|
*/
|
|
256
314
|
BooleanValue?: string;
|
|
257
315
|
/**
|
|
258
|
-
* 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.
|
|
259
317
|
*/
|
|
260
318
|
DoubleValue?: string;
|
|
261
319
|
/**
|
|
262
|
-
* 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.
|
|
263
321
|
*/
|
|
264
322
|
IntegerValue?: string;
|
|
265
323
|
/**
|
|
266
|
-
* 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.
|
|
267
325
|
*/
|
|
268
326
|
StringValue?: string;
|
|
269
327
|
}
|
|
270
328
|
/**
|
|
271
|
-
* Information required to publish the MQTT message through the
|
|
329
|
+
* Information required to publish the MQTT message through the IoT message broker.
|
|
272
330
|
*/
|
|
273
331
|
export interface IotTopicPublish {
|
|
274
332
|
/**
|
|
275
|
-
* 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.
|
|
276
334
|
*/
|
|
277
335
|
MqttTopic: string;
|
|
278
|
-
Payload?:
|
|
336
|
+
Payload?: Payload4;
|
|
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;
|
|
279
350
|
}
|
|
351
|
+
/**
|
|
352
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
|
353
|
+
*/
|
|
280
354
|
export interface Lambda {
|
|
281
355
|
/**
|
|
282
356
|
* The ARN of the Lambda function that is executed.
|
|
283
357
|
*/
|
|
284
358
|
FunctionArn: string;
|
|
285
|
-
Payload?:
|
|
359
|
+
Payload?: Payload5;
|
|
360
|
+
}
|
|
361
|
+
/**
|
|
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;
|
|
286
373
|
}
|
|
287
374
|
/**
|
|
288
375
|
* Information required to publish the Amazon SNS message.
|
|
289
376
|
*/
|
|
290
377
|
export interface Sns {
|
|
291
|
-
Payload?:
|
|
378
|
+
Payload?: Payload6;
|
|
292
379
|
/**
|
|
293
380
|
* The ARN of the Amazon SNS target where the message is sent.
|
|
294
381
|
*/
|
|
295
382
|
TargetArn: string;
|
|
296
383
|
}
|
|
384
|
+
/**
|
|
385
|
+
* You can configure the action payload when you send a message as an Amazon SNS push notification.
|
|
386
|
+
*/
|
|
387
|
+
export interface Payload6 {
|
|
388
|
+
/**
|
|
389
|
+
* 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.
|
|
390
|
+
*/
|
|
391
|
+
ContentExpression: string;
|
|
392
|
+
/**
|
|
393
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
394
|
+
*/
|
|
395
|
+
Type: string;
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
|
|
399
|
+
*/
|
|
297
400
|
export interface Sqs {
|
|
298
|
-
Payload?:
|
|
401
|
+
Payload?: Payload7;
|
|
299
402
|
/**
|
|
300
403
|
* The URL of the SQS queue where the data is written.
|
|
301
404
|
*/
|
|
302
405
|
QueueUrl: string;
|
|
303
406
|
/**
|
|
304
|
-
* Set this to
|
|
407
|
+
* 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.
|
|
305
408
|
*/
|
|
306
409
|
UseBase64?: boolean;
|
|
307
410
|
}
|
|
308
411
|
/**
|
|
309
|
-
*
|
|
412
|
+
* You can configure the action payload when you send a message to an Amazon SQS queue.
|
|
413
|
+
*/
|
|
414
|
+
export interface Payload7 {
|
|
415
|
+
/**
|
|
416
|
+
* 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.
|
|
417
|
+
*/
|
|
418
|
+
ContentExpression: string;
|
|
419
|
+
/**
|
|
420
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
|
421
|
+
*/
|
|
422
|
+
Type: string;
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* Contains the configuration information of alarm state changes.
|
|
310
426
|
*/
|
|
311
427
|
export interface AlarmCapabilities {
|
|
312
428
|
InitializationConfiguration?: InitializationConfiguration;
|
|
@@ -317,7 +433,7 @@ export interface AlarmCapabilities {
|
|
|
317
433
|
*/
|
|
318
434
|
export interface InitializationConfiguration {
|
|
319
435
|
/**
|
|
320
|
-
* The value must be TRUE or FALSE
|
|
436
|
+
* 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``.
|
|
321
437
|
*/
|
|
322
438
|
DisabledOnInitialization: (boolean & string);
|
|
323
439
|
}
|
|
@@ -326,20 +442,20 @@ export interface InitializationConfiguration {
|
|
|
326
442
|
*/
|
|
327
443
|
export interface AcknowledgeFlow {
|
|
328
444
|
/**
|
|
329
|
-
* The value must be TRUE or FALSE
|
|
445
|
+
* 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.
|
|
330
446
|
*/
|
|
331
447
|
Enabled?: (boolean & string);
|
|
332
448
|
}
|
|
333
449
|
/**
|
|
334
|
-
*
|
|
450
|
+
* Metadata that can be used to manage the resource.
|
|
335
451
|
*/
|
|
336
452
|
export interface Tag {
|
|
337
453
|
/**
|
|
338
|
-
*
|
|
454
|
+
* The tag's key.
|
|
339
455
|
*/
|
|
340
456
|
Key: string;
|
|
341
457
|
/**
|
|
342
|
-
*
|
|
458
|
+
* The tag's value.
|
|
343
459
|
*/
|
|
344
460
|
Value: string;
|
|
345
461
|
}
|