Skip to content
This repository was archived by the owner on Jan 8, 2024. It is now read-only.

Commit c7e9d7a

Browse files
committed
make gen/website-mdx
1 parent 2b2133d commit c7e9d7a

File tree

2 files changed

+141
-1
lines changed

2 files changed

+141
-1
lines changed

embedJson/gen/releasemanager-lambda-function-url.json

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"description": "Create an AWS Lambda function URL",
3-
"example": "release {\n\tuse \"lambda-function-url\" {\n\t\tauth_type = \"NONE\"\n\t}\n}",
3+
"example": "release {\n\tuse \"lambda-function-url\" {\n\t\tauth_type = \"NONE\"\n\t\tcors {\n\t\t\tallow_methods = [\"*\"]\n\t\t}\n\t}\n}",
44
"input": "lambda.Deployment",
55
"mappers": null,
66
"name": "lambda-function-url",
@@ -17,6 +17,91 @@
1717
"Example": "",
1818
"SubFields": null
1919
},
20+
{
21+
"Field": "cors",
22+
"Type": "function_url.ReleaserConfigCors",
23+
"Synopsis": "CORS configuration for the function URL",
24+
"Summary": "",
25+
"Optional": false,
26+
"Default": "NONE",
27+
"EnvVar": "",
28+
"Category": true,
29+
"Example": "",
30+
"SubFields": [
31+
{
32+
"Field": "allow_credentials",
33+
"Type": "bool",
34+
"Synopsis": "Whether to allow cookies or other credentials in requests to your function URL.",
35+
"Summary": "",
36+
"Optional": true,
37+
"Default": "false",
38+
"EnvVar": "",
39+
"Category": false,
40+
"Example": "",
41+
"SubFields": null
42+
},
43+
{
44+
"Field": "allow_headers",
45+
"Type": "list of string",
46+
"Synopsis": "The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.",
47+
"Summary": "",
48+
"Optional": true,
49+
"Default": "[]",
50+
"EnvVar": "",
51+
"Category": false,
52+
"Example": "",
53+
"SubFields": null
54+
},
55+
{
56+
"Field": "allow_methods",
57+
"Type": "list of string",
58+
"Synopsis": "The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).",
59+
"Summary": "",
60+
"Optional": true,
61+
"Default": "[]",
62+
"EnvVar": "",
63+
"Category": false,
64+
"Example": "",
65+
"SubFields": null
66+
},
67+
{
68+
"Field": "allow_origins",
69+
"Type": "list of string",
70+
"Synopsis": "The origins that can access your function URL. You can list any number of specific origins, separated by a comma. You can grant access to all origins using the wildcard character (*).",
71+
"Summary": "",
72+
"Optional": true,
73+
"Default": "[]",
74+
"EnvVar": "",
75+
"Category": false,
76+
"Example": "",
77+
"SubFields": null
78+
},
79+
{
80+
"Field": "expose_headers",
81+
"Type": "list of string",
82+
"Synopsis": "The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.",
83+
"Summary": "",
84+
"Optional": true,
85+
"Default": "[]",
86+
"EnvVar": "",
87+
"Category": false,
88+
"Example": "",
89+
"SubFields": null
90+
},
91+
{
92+
"Field": "max_age",
93+
"Type": "int64",
94+
"Synopsis": "The maximum amount of time, in seconds, that web browsers can cache results of a preflight request.",
95+
"Summary": "",
96+
"Optional": true,
97+
"Default": "0",
98+
"EnvVar": "",
99+
"Category": false,
100+
"Example": "",
101+
"SubFields": null
102+
}
103+
]
104+
},
20105
{
21106
"Field": "principal",
22107
"Type": "string",

website/content/partials/components/releasemanager-lambda-function-url.mdx

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ Create an AWS Lambda function URL.
1313
release {
1414
use "lambda-function-url" {
1515
auth_type = "NONE"
16+
cors {
17+
allow_methods = ["*"]
18+
}
1619
}
1720
}
1821
```
@@ -35,6 +38,58 @@ The AuthType parameter determines how Lambda authenticates or authorizes request
3538
- **Optional**
3639
- Default: NONE
3740

41+
#### cors (category)
42+
43+
CORS configuration for the function URL.
44+
45+
##### cors.allow_credentials
46+
47+
Whether to allow cookies or other credentials in requests to your function URL.
48+
49+
- Type: **bool**
50+
- **Optional**
51+
- Default: false
52+
53+
##### cors.allow_headers
54+
55+
The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.
56+
57+
- Type: **list of string**
58+
- **Optional**
59+
- Default: []
60+
61+
##### cors.allow_methods
62+
63+
The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (\*).
64+
65+
- Type: **list of string**
66+
- **Optional**
67+
- Default: []
68+
69+
##### cors.allow_origins
70+
71+
The origins that can access your function URL. You can list any number of specific origins, separated by a comma. You can grant access to all origins using the wildcard character (\*).
72+
73+
- Type: **list of string**
74+
- **Optional**
75+
- Default: []
76+
77+
##### cors.expose_headers
78+
79+
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.
80+
81+
- Type: **list of string**
82+
- **Optional**
83+
- Default: []
84+
85+
##### cors.max_age
86+
87+
The maximum amount of time, in seconds, that web browsers can cache results of a preflight request.
88+
89+
- Type: **int64**
90+
- **Optional**
91+
- Default: 0
92+
3893
#### principal
3994

4095
The principal to use when auth_type is `AWS_IAM`.

0 commit comments

Comments
 (0)