Skip to content

Commit d9ee11c

Browse files
committed
Sync web site with Quarkus documentation
1 parent 95bdfbb commit d9ee11c

File tree

899 files changed

+494170
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

899 files changed

+494170
-0
lines changed

_data/versioned/3-27/index/quarkus.yaml

Lines changed: 3291 additions & 0 deletions
Large diffs are not rendered by default.

_data/versioned/3-27/index/relations.yaml

Lines changed: 24103 additions & 0 deletions
Large diffs are not rendered by default.

_generated-doc/3.27/config/quarkus-agroal.adoc

Lines changed: 824 additions & 0 deletions
Large diffs are not rendered by default.

_generated-doc/3.27/config/quarkus-agroal_quarkus.datasource.adoc

Lines changed: 824 additions & 0 deletions
Large diffs are not rendered by default.

_generated-doc/3.27/config/quarkus-all-config.adoc

Lines changed: 97684 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[.header-title]##Configuration property##
7+
h|Type
8+
h|Default
9+
10+
a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda-http_quarkus-lambda-http-enable-security]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-enable-security[`quarkus.lambda-http.enable-security`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.lambda-http.enable-security+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`+++false+++`
30+
31+
a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-map-cognito-to-roles]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-map-cognito-to-roles[`quarkus.lambda-http.map-cognito-to-roles`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.lambda-http.map-cognito-to-roles+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|boolean
50+
|`+++true+++`
51+
52+
a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-role-claim]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-role-claim[`quarkus.lambda-http.cognito-role-claim`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.lambda-http.cognito-role-claim+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|string
71+
|`+++cognito:groups+++`
72+
73+
a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-claim-matcher]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-claim-matcher[`quarkus.lambda-http.cognito-claim-matcher`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.lambda-http.cognito-claim-matcher+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
Regular expression to locate role values within a Cognito claim string. By default, it looks for space delimited strings enclosed in brackets "++[++^++\[\]++ ++\++t++]++{plus}"
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|`+++[^\[\] \t]++++`
93+
94+
|===
95+
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[.header-title]##Configuration property##
7+
h|Type
8+
h|Default
9+
10+
a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda-http_quarkus-lambda-http-enable-security]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-enable-security[`quarkus.lambda-http.enable-security`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.lambda-http.enable-security+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`+++false+++`
30+
31+
a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-map-cognito-to-roles]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-map-cognito-to-roles[`quarkus.lambda-http.map-cognito-to-roles`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.lambda-http.map-cognito-to-roles+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|boolean
50+
|`+++true+++`
51+
52+
a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-role-claim]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-role-claim[`quarkus.lambda-http.cognito-role-claim`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.lambda-http.cognito-role-claim+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|string
71+
|`+++cognito:groups+++`
72+
73+
a| [[quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-claim-matcher]] [.property-path]##link:#quarkus-amazon-lambda-http_quarkus-lambda-http-cognito-claim-matcher[`quarkus.lambda-http.cognito-claim-matcher`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.lambda-http.cognito-claim-matcher+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
Regular expression to locate role values within a Cognito claim string. By default, it looks for space delimited strings enclosed in brackets "++[++^++\[\]++ ++\++t++]++{plus}"
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|`+++[^\[\] \t]++++`
93+
94+
|===
95+
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[.header-title]##Configuration property##
7+
h|Type
8+
h|Default
9+
10+
a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda-rest_quarkus-lambda-http-enable-security]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-enable-security[`quarkus.lambda-http.enable-security`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.lambda-http.enable-security+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`+++false+++`
30+
31+
a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-map-cognito-to-roles]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-map-cognito-to-roles[`quarkus.lambda-http.map-cognito-to-roles`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.lambda-http.map-cognito-to-roles+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|boolean
50+
|`+++true+++`
51+
52+
a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-role-claim]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-role-claim[`quarkus.lambda-http.cognito-role-claim`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.lambda-http.cognito-role-claim+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|string
71+
|`+++cognito:groups+++`
72+
73+
a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-claim-matcher]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-claim-matcher[`quarkus.lambda-http.cognito-claim-matcher`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.lambda-http.cognito-claim-matcher+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
Regular expression to locate role values within a Cognito claim string. By default, it looks for space delimited strings enclosed in brackets "++[++^++\[\]++ ++\++t++]++{plus}"
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|`+++[^\[\] \t]++++`
93+
94+
|===
95+
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[.header-title]##Configuration property##
7+
h|Type
8+
h|Default
9+
10+
a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda-rest_quarkus-lambda-http-enable-security]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-enable-security[`quarkus.lambda-http.enable-security`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.lambda-http.enable-security+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`+++false+++`
30+
31+
a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-map-cognito-to-roles]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-map-cognito-to-roles[`quarkus.lambda-http.map-cognito-to-roles`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.lambda-http.map-cognito-to-roles+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|boolean
50+
|`+++true+++`
51+
52+
a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-role-claim]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-role-claim[`quarkus.lambda-http.cognito-role-claim`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.lambda-http.cognito-role-claim+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|string
71+
|`+++cognito:groups+++`
72+
73+
a| [[quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-claim-matcher]] [.property-path]##link:#quarkus-amazon-lambda-rest_quarkus-lambda-http-cognito-claim-matcher[`quarkus.lambda-http.cognito-claim-matcher`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.lambda-http.cognito-claim-matcher+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
Regular expression to locate role values within a Cognito claim string. By default, it looks for space delimited strings enclosed in brackets "++[++^++\[\]++ ++\++t++]++{plus}"
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|`+++[^\[\] \t]++++`
93+
94+
|===
95+

0 commit comments

Comments
 (0)