sst 3.0.66 → 3.0.67

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.
@@ -10,15 +10,30 @@ import { IoTCustomAuthorizerHandler, PolicyDocument } from "aws-lambda";
10
10
  export declare namespace realtime {
11
11
  interface AuthResult {
12
12
  /**
13
- * The principal ID of the authorized client. This could be (but is not limited to) a user ID, an email address, or a phone number.
13
+ * The principal ID of the authorized client. This could be a user ID, username, or
14
+ * phone number.
15
+ *
16
+ * The value must be an alphanumeric string with at least one, and no more than 128,
17
+ * characters and match the regex pattern, `([a-zA-Z0-9]){1,128}`.
14
18
  */
15
19
  principalId?: string;
16
20
  /**
17
- * How long the client should be disconnected after the token expires.
21
+ * The maximum duration in seconds of the connection to IoT Core.
22
+ *
23
+ * :::note
24
+ * This is set when the connection is established and cannot be modified during subsequent
25
+ * policy refresh authorization handler invocations.
26
+ * :::
27
+ *
28
+ * The minimum value is 300 seconds, and the maximum is 86400 seconds.
29
+ * @default `86400`
18
30
  */
19
31
  disconnectAfterInSeconds?: number;
20
32
  /**
21
- * How long the client should be refreshed after the token expires.
33
+ * The duration in seconds between policy refreshes. After the given duration, IoT Core
34
+ * will invoke the authorization handler function.
35
+ *
36
+ * The minimum value is 300 seconds, and the maximum value is 86400 seconds.
22
37
  */
23
38
  refreshAfterInSeconds?: number;
24
39
  /**
@@ -57,7 +72,10 @@ export declare namespace realtime {
57
72
  */
58
73
  publish?: string[];
59
74
  /**
60
- * Any additional policy documents to attach to the client.
75
+ * Any additional [IoT Core policy documents](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) to attach to the client.
76
+ *
77
+ * There's a maximum of 10 policy documents. Where each document can contain a maximum of
78
+ * 2048 characters.
61
79
  * @example
62
80
  * ```js
63
81
  * {
@@ -66,14 +84,14 @@ export declare namespace realtime {
66
84
  * Version: "2012-10-17",
67
85
  * Statement: [
68
86
  * {
69
- * Action: "iot:GetThingShadow",
87
+ * Action: "iot:Publish",
70
88
  * Effect: "Allow",
71
- * Resource: "*",
72
- * },
73
- * ],
74
- * },
75
- * ],
76
- * };
89
+ * Resource: "*"
90
+ * }
91
+ * ]
92
+ * }
93
+ * ]
94
+ * }
77
95
  * ```
78
96
  */
79
97
  policyDocuments?: PolicyDocument[];
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "name": "sst",
4
4
  "type": "module",
5
5
  "sideEffects": false,
6
- "version": "3.0.66",
6
+ "version": "3.0.67",
7
7
  "main": "./dist/index.js",
8
8
  "exports": {
9
9
  ".": "./dist/index.js",
@@ -47,11 +47,11 @@
47
47
  }
48
48
  },
49
49
  "optionalDependencies": {
50
- "sst-linux-x64": "3.0.66",
51
- "sst-linux-x86": "3.0.66",
52
- "sst-linux-arm64": "3.0.66",
53
- "sst-darwin-x64": "3.0.66",
54
- "sst-darwin-arm64": "3.0.66"
50
+ "sst-linux-x64": "3.0.67",
51
+ "sst-linux-x86": "3.0.67",
52
+ "sst-linux-arm64": "3.0.67",
53
+ "sst-darwin-x64": "3.0.67",
54
+ "sst-darwin-arm64": "3.0.67"
55
55
  },
56
56
  "dependencies": {
57
57
  "@aws-sdk/client-lambda": "3.478.0",