pulumi-aws-apigateway 2.7.0a1752881638__py3-none-any.whl → 2.7.0a1753124556__py3-none-any.whl
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.
Potentially problematic release.
This version of pulumi-aws-apigateway might be problematic. Click here for more details.
- pulumi_aws_apigateway/__init__.py +1 -1
- pulumi_aws_apigateway/_enums.py +7 -7
- pulumi_aws_apigateway/_inputs.py +151 -152
- pulumi_aws_apigateway/provider.py +1 -2
- pulumi_aws_apigateway/pulumi-plugin.json +1 -1
- pulumi_aws_apigateway/rest_api.py +60 -61
- {pulumi_aws_apigateway-2.7.0a1752881638.dist-info → pulumi_aws_apigateway-2.7.0a1753124556.dist-info}/METADATA +1 -1
- pulumi_aws_apigateway-2.7.0a1753124556.dist-info/RECORD +12 -0
- pulumi_aws_apigateway-2.7.0a1752881638.dist-info/RECORD +0 -12
- {pulumi_aws_apigateway-2.7.0a1752881638.dist-info → pulumi_aws_apigateway-2.7.0a1753124556.dist-info}/WHEEL +0 -0
- {pulumi_aws_apigateway-2.7.0a1752881638.dist-info → pulumi_aws_apigateway-2.7.0a1753124556.dist-info}/top_level.txt +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import builtins
|
|
5
|
+
import builtins as _builtins
|
|
6
6
|
from . import _utilities
|
|
7
7
|
import typing
|
|
8
8
|
# Export this package's modules as members:
|
pulumi_aws_apigateway/_enums.py
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import builtins
|
|
5
|
+
import builtins as _builtins
|
|
6
6
|
import pulumi
|
|
7
7
|
from enum import Enum
|
|
8
8
|
|
|
@@ -17,26 +17,26 @@ __all__ = [
|
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
@pulumi.type_token("aws-apigateway:index:APIKeySource")
|
|
20
|
-
class APIKeySource(
|
|
20
|
+
class APIKeySource(_builtins.str, Enum):
|
|
21
21
|
HEADER = "HEADER"
|
|
22
22
|
AUTHORIZER = "AUTHORIZER"
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
@pulumi.type_token("aws-apigateway:index:IntegrationConnectionType")
|
|
26
|
-
class IntegrationConnectionType(
|
|
26
|
+
class IntegrationConnectionType(_builtins.str, Enum):
|
|
27
27
|
INTERNET = "INTERNET"
|
|
28
28
|
VP_C_LINK = "VPC_LINK"
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
@pulumi.type_token("aws-apigateway:index:IntegrationPassthroughBehavior")
|
|
32
|
-
class IntegrationPassthroughBehavior(
|
|
32
|
+
class IntegrationPassthroughBehavior(_builtins.str, Enum):
|
|
33
33
|
WHEN_NO_MATCH = "when_no_match"
|
|
34
34
|
WHEN_NO_TEMPLATES = "when_no_templates"
|
|
35
35
|
NEVER = "never"
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
@pulumi.type_token("aws-apigateway:index:IntegrationType")
|
|
39
|
-
class IntegrationType(
|
|
39
|
+
class IntegrationType(_builtins.str, Enum):
|
|
40
40
|
AWS = "aws"
|
|
41
41
|
AWS_PROXY = "aws_proxy"
|
|
42
42
|
HTTP = "http"
|
|
@@ -45,7 +45,7 @@ class IntegrationType(builtins.str, Enum):
|
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
@pulumi.type_token("aws-apigateway:index:Method")
|
|
48
|
-
class Method(
|
|
48
|
+
class Method(_builtins.str, Enum):
|
|
49
49
|
ANY = "ANY"
|
|
50
50
|
GET = "GET"
|
|
51
51
|
PUT = "PUT"
|
|
@@ -57,7 +57,7 @@ class Method(builtins.str, Enum):
|
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
@pulumi.type_token("aws-apigateway:index:RequestValidator")
|
|
60
|
-
class RequestValidator(
|
|
60
|
+
class RequestValidator(_builtins.str, Enum):
|
|
61
61
|
ALL = "ALL"
|
|
62
62
|
PARAM_S_ONLY = "PARAMS_ONLY"
|
|
63
63
|
BOD_Y_ONLY = "BODY_ONLY"
|
pulumi_aws_apigateway/_inputs.py
CHANGED
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import builtins
|
|
6
|
-
import copy
|
|
5
|
+
import builtins as _builtins
|
|
7
6
|
import warnings
|
|
8
7
|
import sys
|
|
9
8
|
import pulumi
|
|
@@ -37,21 +36,21 @@ if not MYPY:
|
|
|
37
36
|
"""
|
|
38
37
|
LambdaAuthorizer provides the definition for a custom Authorizer for API Gateway.
|
|
39
38
|
"""
|
|
40
|
-
parameter_name:
|
|
39
|
+
parameter_name: _builtins.str
|
|
41
40
|
"""
|
|
42
41
|
parameterName is the name of the header or query parameter containing the authorization
|
|
43
42
|
token. Must be "Unused" for multiple identity sources.
|
|
44
43
|
"""
|
|
45
|
-
auth_type: NotRequired[
|
|
44
|
+
auth_type: NotRequired[_builtins.str]
|
|
46
45
|
"""
|
|
47
46
|
Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".
|
|
48
47
|
"""
|
|
49
|
-
authorizer_name: NotRequired[
|
|
48
|
+
authorizer_name: NotRequired[_builtins.str]
|
|
50
49
|
"""
|
|
51
50
|
The name for the Authorizer to be referenced as. This must be unique for each unique
|
|
52
51
|
authorizer within the API. If no name if specified, a name will be generated for you.
|
|
53
52
|
"""
|
|
54
|
-
authorizer_result_ttl_in_seconds: NotRequired[
|
|
53
|
+
authorizer_result_ttl_in_seconds: NotRequired[_builtins.float]
|
|
55
54
|
"""
|
|
56
55
|
The number of seconds during which the resulting IAM policy is cached. Default is 300s. You
|
|
57
56
|
can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an
|
|
@@ -62,20 +61,20 @@ if not MYPY:
|
|
|
62
61
|
"""
|
|
63
62
|
The authorizerHandler specifies information about the authorizing Lambda.
|
|
64
63
|
"""
|
|
65
|
-
identity_source: NotRequired[Sequence[
|
|
64
|
+
identity_source: NotRequired[Sequence[_builtins.str]]
|
|
66
65
|
"""
|
|
67
66
|
List of mapping expressions of the request parameters as the identity source. This indicates
|
|
68
67
|
where in the request identity information is expected. Applicable for the authorizer of the
|
|
69
68
|
"request" type only. Example: ["method.request.header.HeaderAuth1",
|
|
70
69
|
"method.request.querystring.QueryString1"]
|
|
71
70
|
"""
|
|
72
|
-
identity_validation_expression: NotRequired[
|
|
71
|
+
identity_validation_expression: NotRequired[_builtins.str]
|
|
73
72
|
"""
|
|
74
73
|
A regular expression for validating the token as the incoming identity. It only invokes the
|
|
75
74
|
authorizer's lambda if there is a match, else it will return a 401. This does not apply to
|
|
76
75
|
REQUEST Lambda Authorizers. Example: "^x-[a-z]+".
|
|
77
76
|
"""
|
|
78
|
-
methods_to_authorize: NotRequired[Sequence[
|
|
77
|
+
methods_to_authorize: NotRequired[Sequence[_builtins.str]]
|
|
79
78
|
"""
|
|
80
79
|
For method authorization, you can define resource servers and custom scopes by specifying the
|
|
81
80
|
"resource-server/scope". e.g. ["com.hamuta.movies/drama.view",
|
|
@@ -83,16 +82,16 @@ if not MYPY:
|
|
|
83
82
|
scopes visit the AWS documentation -
|
|
84
83
|
https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html
|
|
85
84
|
"""
|
|
86
|
-
parameter_location: NotRequired[
|
|
85
|
+
parameter_location: NotRequired[_builtins.str]
|
|
87
86
|
"""
|
|
88
87
|
Defines where in the request API Gateway should look for identity information. The value must
|
|
89
88
|
be "header" or "query". If there are multiple identity sources, the value must be "header".
|
|
90
89
|
"""
|
|
91
|
-
provider_arns: NotRequired[Sequence[pulumi.Input[
|
|
90
|
+
provider_arns: NotRequired[Sequence[pulumi.Input[_builtins.str]]]
|
|
92
91
|
"""
|
|
93
92
|
The ARNs of the Cognito User Pools to use.
|
|
94
93
|
"""
|
|
95
|
-
type: NotRequired[
|
|
94
|
+
type: NotRequired[_builtins.str]
|
|
96
95
|
"""
|
|
97
96
|
The type of the authorizer. This value must be one of the following:
|
|
98
97
|
- "token", for an authorizer with the caller identity embedded in an authorization token
|
|
@@ -104,46 +103,46 @@ elif False:
|
|
|
104
103
|
@pulumi.input_type
|
|
105
104
|
class AuthorizerArgs:
|
|
106
105
|
def __init__(__self__, *,
|
|
107
|
-
parameter_name:
|
|
108
|
-
auth_type: Optional[
|
|
109
|
-
authorizer_name: Optional[
|
|
110
|
-
authorizer_result_ttl_in_seconds: Optional[
|
|
106
|
+
parameter_name: _builtins.str,
|
|
107
|
+
auth_type: Optional[_builtins.str] = None,
|
|
108
|
+
authorizer_name: Optional[_builtins.str] = None,
|
|
109
|
+
authorizer_result_ttl_in_seconds: Optional[_builtins.float] = None,
|
|
111
110
|
handler: Optional[pulumi.Input['pulumi_aws.lambda_.Function']] = None,
|
|
112
|
-
identity_source: Optional[Sequence[
|
|
113
|
-
identity_validation_expression: Optional[
|
|
114
|
-
methods_to_authorize: Optional[Sequence[
|
|
115
|
-
parameter_location: Optional[
|
|
116
|
-
provider_arns: Optional[Sequence[pulumi.Input[
|
|
117
|
-
type: Optional[
|
|
111
|
+
identity_source: Optional[Sequence[_builtins.str]] = None,
|
|
112
|
+
identity_validation_expression: Optional[_builtins.str] = None,
|
|
113
|
+
methods_to_authorize: Optional[Sequence[_builtins.str]] = None,
|
|
114
|
+
parameter_location: Optional[_builtins.str] = None,
|
|
115
|
+
provider_arns: Optional[Sequence[pulumi.Input[_builtins.str]]] = None,
|
|
116
|
+
type: Optional[_builtins.str] = None):
|
|
118
117
|
"""
|
|
119
118
|
LambdaAuthorizer provides the definition for a custom Authorizer for API Gateway.
|
|
120
119
|
|
|
121
|
-
:param
|
|
120
|
+
:param _builtins.str parameter_name: parameterName is the name of the header or query parameter containing the authorization
|
|
122
121
|
token. Must be "Unused" for multiple identity sources.
|
|
123
|
-
:param
|
|
124
|
-
:param
|
|
122
|
+
:param _builtins.str auth_type: Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".
|
|
123
|
+
:param _builtins.str authorizer_name: The name for the Authorizer to be referenced as. This must be unique for each unique
|
|
125
124
|
authorizer within the API. If no name if specified, a name will be generated for you.
|
|
126
|
-
:param
|
|
125
|
+
:param _builtins.float authorizer_result_ttl_in_seconds: The number of seconds during which the resulting IAM policy is cached. Default is 300s. You
|
|
127
126
|
can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an
|
|
128
127
|
authorizer across more than one route you will want to disable the cache or else it will
|
|
129
128
|
cause problems for you.
|
|
130
129
|
:param pulumi.Input['pulumi_aws.lambda_.Function'] handler: The authorizerHandler specifies information about the authorizing Lambda.
|
|
131
|
-
:param Sequence[
|
|
130
|
+
:param Sequence[_builtins.str] identity_source: List of mapping expressions of the request parameters as the identity source. This indicates
|
|
132
131
|
where in the request identity information is expected. Applicable for the authorizer of the
|
|
133
132
|
"request" type only. Example: ["method.request.header.HeaderAuth1",
|
|
134
133
|
"method.request.querystring.QueryString1"]
|
|
135
|
-
:param
|
|
134
|
+
:param _builtins.str identity_validation_expression: A regular expression for validating the token as the incoming identity. It only invokes the
|
|
136
135
|
authorizer's lambda if there is a match, else it will return a 401. This does not apply to
|
|
137
136
|
REQUEST Lambda Authorizers. Example: "^x-[a-z]+".
|
|
138
|
-
:param Sequence[
|
|
137
|
+
:param Sequence[_builtins.str] methods_to_authorize: For method authorization, you can define resource servers and custom scopes by specifying the
|
|
139
138
|
"resource-server/scope". e.g. ["com.hamuta.movies/drama.view",
|
|
140
139
|
"http://my.resource.com/file.read"] For more information on resource servers and custom
|
|
141
140
|
scopes visit the AWS documentation -
|
|
142
141
|
https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html
|
|
143
|
-
:param
|
|
142
|
+
:param _builtins.str parameter_location: Defines where in the request API Gateway should look for identity information. The value must
|
|
144
143
|
be "header" or "query". If there are multiple identity sources, the value must be "header".
|
|
145
|
-
:param Sequence[pulumi.Input[
|
|
146
|
-
:param
|
|
144
|
+
:param Sequence[pulumi.Input[_builtins.str]] provider_arns: The ARNs of the Cognito User Pools to use.
|
|
145
|
+
:param _builtins.str type: The type of the authorizer. This value must be one of the following:
|
|
147
146
|
- "token", for an authorizer with the caller identity embedded in an authorization token
|
|
148
147
|
- "request", for an authorizer with the caller identity contained in request parameters
|
|
149
148
|
"""
|
|
@@ -169,9 +168,9 @@ class AuthorizerArgs:
|
|
|
169
168
|
if type is not None:
|
|
170
169
|
pulumi.set(__self__, "type", type)
|
|
171
170
|
|
|
172
|
-
@property
|
|
171
|
+
@_builtins.property
|
|
173
172
|
@pulumi.getter(name="parameterName")
|
|
174
|
-
def parameter_name(self) ->
|
|
173
|
+
def parameter_name(self) -> _builtins.str:
|
|
175
174
|
"""
|
|
176
175
|
parameterName is the name of the header or query parameter containing the authorization
|
|
177
176
|
token. Must be "Unused" for multiple identity sources.
|
|
@@ -179,24 +178,24 @@ class AuthorizerArgs:
|
|
|
179
178
|
return pulumi.get(self, "parameter_name")
|
|
180
179
|
|
|
181
180
|
@parameter_name.setter
|
|
182
|
-
def parameter_name(self, value:
|
|
181
|
+
def parameter_name(self, value: _builtins.str):
|
|
183
182
|
pulumi.set(self, "parameter_name", value)
|
|
184
183
|
|
|
185
|
-
@property
|
|
184
|
+
@_builtins.property
|
|
186
185
|
@pulumi.getter(name="authType")
|
|
187
|
-
def auth_type(self) -> Optional[
|
|
186
|
+
def auth_type(self) -> Optional[_builtins.str]:
|
|
188
187
|
"""
|
|
189
188
|
Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".
|
|
190
189
|
"""
|
|
191
190
|
return pulumi.get(self, "auth_type")
|
|
192
191
|
|
|
193
192
|
@auth_type.setter
|
|
194
|
-
def auth_type(self, value: Optional[
|
|
193
|
+
def auth_type(self, value: Optional[_builtins.str]):
|
|
195
194
|
pulumi.set(self, "auth_type", value)
|
|
196
195
|
|
|
197
|
-
@property
|
|
196
|
+
@_builtins.property
|
|
198
197
|
@pulumi.getter(name="authorizerName")
|
|
199
|
-
def authorizer_name(self) -> Optional[
|
|
198
|
+
def authorizer_name(self) -> Optional[_builtins.str]:
|
|
200
199
|
"""
|
|
201
200
|
The name for the Authorizer to be referenced as. This must be unique for each unique
|
|
202
201
|
authorizer within the API. If no name if specified, a name will be generated for you.
|
|
@@ -204,12 +203,12 @@ class AuthorizerArgs:
|
|
|
204
203
|
return pulumi.get(self, "authorizer_name")
|
|
205
204
|
|
|
206
205
|
@authorizer_name.setter
|
|
207
|
-
def authorizer_name(self, value: Optional[
|
|
206
|
+
def authorizer_name(self, value: Optional[_builtins.str]):
|
|
208
207
|
pulumi.set(self, "authorizer_name", value)
|
|
209
208
|
|
|
210
|
-
@property
|
|
209
|
+
@_builtins.property
|
|
211
210
|
@pulumi.getter(name="authorizerResultTtlInSeconds")
|
|
212
|
-
def authorizer_result_ttl_in_seconds(self) -> Optional[
|
|
211
|
+
def authorizer_result_ttl_in_seconds(self) -> Optional[_builtins.float]:
|
|
213
212
|
"""
|
|
214
213
|
The number of seconds during which the resulting IAM policy is cached. Default is 300s. You
|
|
215
214
|
can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an
|
|
@@ -219,10 +218,10 @@ class AuthorizerArgs:
|
|
|
219
218
|
return pulumi.get(self, "authorizer_result_ttl_in_seconds")
|
|
220
219
|
|
|
221
220
|
@authorizer_result_ttl_in_seconds.setter
|
|
222
|
-
def authorizer_result_ttl_in_seconds(self, value: Optional[
|
|
221
|
+
def authorizer_result_ttl_in_seconds(self, value: Optional[_builtins.float]):
|
|
223
222
|
pulumi.set(self, "authorizer_result_ttl_in_seconds", value)
|
|
224
223
|
|
|
225
|
-
@property
|
|
224
|
+
@_builtins.property
|
|
226
225
|
@pulumi.getter
|
|
227
226
|
def handler(self) -> Optional[pulumi.Input['pulumi_aws.lambda_.Function']]:
|
|
228
227
|
"""
|
|
@@ -234,9 +233,9 @@ class AuthorizerArgs:
|
|
|
234
233
|
def handler(self, value: Optional[pulumi.Input['pulumi_aws.lambda_.Function']]):
|
|
235
234
|
pulumi.set(self, "handler", value)
|
|
236
235
|
|
|
237
|
-
@property
|
|
236
|
+
@_builtins.property
|
|
238
237
|
@pulumi.getter(name="identitySource")
|
|
239
|
-
def identity_source(self) -> Optional[Sequence[
|
|
238
|
+
def identity_source(self) -> Optional[Sequence[_builtins.str]]:
|
|
240
239
|
"""
|
|
241
240
|
List of mapping expressions of the request parameters as the identity source. This indicates
|
|
242
241
|
where in the request identity information is expected. Applicable for the authorizer of the
|
|
@@ -246,12 +245,12 @@ class AuthorizerArgs:
|
|
|
246
245
|
return pulumi.get(self, "identity_source")
|
|
247
246
|
|
|
248
247
|
@identity_source.setter
|
|
249
|
-
def identity_source(self, value: Optional[Sequence[
|
|
248
|
+
def identity_source(self, value: Optional[Sequence[_builtins.str]]):
|
|
250
249
|
pulumi.set(self, "identity_source", value)
|
|
251
250
|
|
|
252
|
-
@property
|
|
251
|
+
@_builtins.property
|
|
253
252
|
@pulumi.getter(name="identityValidationExpression")
|
|
254
|
-
def identity_validation_expression(self) -> Optional[
|
|
253
|
+
def identity_validation_expression(self) -> Optional[_builtins.str]:
|
|
255
254
|
"""
|
|
256
255
|
A regular expression for validating the token as the incoming identity. It only invokes the
|
|
257
256
|
authorizer's lambda if there is a match, else it will return a 401. This does not apply to
|
|
@@ -260,12 +259,12 @@ class AuthorizerArgs:
|
|
|
260
259
|
return pulumi.get(self, "identity_validation_expression")
|
|
261
260
|
|
|
262
261
|
@identity_validation_expression.setter
|
|
263
|
-
def identity_validation_expression(self, value: Optional[
|
|
262
|
+
def identity_validation_expression(self, value: Optional[_builtins.str]):
|
|
264
263
|
pulumi.set(self, "identity_validation_expression", value)
|
|
265
264
|
|
|
266
|
-
@property
|
|
265
|
+
@_builtins.property
|
|
267
266
|
@pulumi.getter(name="methodsToAuthorize")
|
|
268
|
-
def methods_to_authorize(self) -> Optional[Sequence[
|
|
267
|
+
def methods_to_authorize(self) -> Optional[Sequence[_builtins.str]]:
|
|
269
268
|
"""
|
|
270
269
|
For method authorization, you can define resource servers and custom scopes by specifying the
|
|
271
270
|
"resource-server/scope". e.g. ["com.hamuta.movies/drama.view",
|
|
@@ -276,12 +275,12 @@ class AuthorizerArgs:
|
|
|
276
275
|
return pulumi.get(self, "methods_to_authorize")
|
|
277
276
|
|
|
278
277
|
@methods_to_authorize.setter
|
|
279
|
-
def methods_to_authorize(self, value: Optional[Sequence[
|
|
278
|
+
def methods_to_authorize(self, value: Optional[Sequence[_builtins.str]]):
|
|
280
279
|
pulumi.set(self, "methods_to_authorize", value)
|
|
281
280
|
|
|
282
|
-
@property
|
|
281
|
+
@_builtins.property
|
|
283
282
|
@pulumi.getter(name="parameterLocation")
|
|
284
|
-
def parameter_location(self) -> Optional[
|
|
283
|
+
def parameter_location(self) -> Optional[_builtins.str]:
|
|
285
284
|
"""
|
|
286
285
|
Defines where in the request API Gateway should look for identity information. The value must
|
|
287
286
|
be "header" or "query". If there are multiple identity sources, the value must be "header".
|
|
@@ -289,24 +288,24 @@ class AuthorizerArgs:
|
|
|
289
288
|
return pulumi.get(self, "parameter_location")
|
|
290
289
|
|
|
291
290
|
@parameter_location.setter
|
|
292
|
-
def parameter_location(self, value: Optional[
|
|
291
|
+
def parameter_location(self, value: Optional[_builtins.str]):
|
|
293
292
|
pulumi.set(self, "parameter_location", value)
|
|
294
293
|
|
|
295
|
-
@property
|
|
294
|
+
@_builtins.property
|
|
296
295
|
@pulumi.getter(name="providerARNs")
|
|
297
|
-
def provider_arns(self) -> Optional[Sequence[pulumi.Input[
|
|
296
|
+
def provider_arns(self) -> Optional[Sequence[pulumi.Input[_builtins.str]]]:
|
|
298
297
|
"""
|
|
299
298
|
The ARNs of the Cognito User Pools to use.
|
|
300
299
|
"""
|
|
301
300
|
return pulumi.get(self, "provider_arns")
|
|
302
301
|
|
|
303
302
|
@provider_arns.setter
|
|
304
|
-
def provider_arns(self, value: Optional[Sequence[pulumi.Input[
|
|
303
|
+
def provider_arns(self, value: Optional[Sequence[pulumi.Input[_builtins.str]]]):
|
|
305
304
|
pulumi.set(self, "provider_arns", value)
|
|
306
305
|
|
|
307
|
-
@property
|
|
306
|
+
@_builtins.property
|
|
308
307
|
@pulumi.getter
|
|
309
|
-
def type(self) -> Optional[
|
|
308
|
+
def type(self) -> Optional[_builtins.str]:
|
|
310
309
|
"""
|
|
311
310
|
The type of the authorizer. This value must be one of the following:
|
|
312
311
|
- "token", for an authorizer with the caller identity embedded in an authorization token
|
|
@@ -315,43 +314,43 @@ class AuthorizerArgs:
|
|
|
315
314
|
return pulumi.get(self, "type")
|
|
316
315
|
|
|
317
316
|
@type.setter
|
|
318
|
-
def type(self, value: Optional[
|
|
317
|
+
def type(self, value: Optional[_builtins.str]):
|
|
319
318
|
pulumi.set(self, "type", value)
|
|
320
319
|
|
|
321
320
|
|
|
322
321
|
if not MYPY:
|
|
323
322
|
class RequiredParameterArgsDict(TypedDict):
|
|
324
|
-
in_: NotRequired[pulumi.Input[
|
|
325
|
-
name: NotRequired[pulumi.Input[
|
|
323
|
+
in_: NotRequired[pulumi.Input[_builtins.str]]
|
|
324
|
+
name: NotRequired[pulumi.Input[_builtins.str]]
|
|
326
325
|
elif False:
|
|
327
326
|
RequiredParameterArgsDict: TypeAlias = Mapping[str, Any]
|
|
328
327
|
|
|
329
328
|
@pulumi.input_type
|
|
330
329
|
class RequiredParameterArgs:
|
|
331
330
|
def __init__(__self__, *,
|
|
332
|
-
in_: Optional[pulumi.Input[
|
|
333
|
-
name: Optional[pulumi.Input[
|
|
331
|
+
in_: Optional[pulumi.Input[_builtins.str]] = None,
|
|
332
|
+
name: Optional[pulumi.Input[_builtins.str]] = None):
|
|
334
333
|
if in_ is not None:
|
|
335
334
|
pulumi.set(__self__, "in_", in_)
|
|
336
335
|
if name is not None:
|
|
337
336
|
pulumi.set(__self__, "name", name)
|
|
338
337
|
|
|
339
|
-
@property
|
|
338
|
+
@_builtins.property
|
|
340
339
|
@pulumi.getter(name="in")
|
|
341
|
-
def in_(self) -> Optional[pulumi.Input[
|
|
340
|
+
def in_(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
342
341
|
return pulumi.get(self, "in_")
|
|
343
342
|
|
|
344
343
|
@in_.setter
|
|
345
|
-
def in_(self, value: Optional[pulumi.Input[
|
|
344
|
+
def in_(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
346
345
|
pulumi.set(self, "in_", value)
|
|
347
346
|
|
|
348
|
-
@property
|
|
347
|
+
@_builtins.property
|
|
349
348
|
@pulumi.getter
|
|
350
|
-
def name(self) -> Optional[pulumi.Input[
|
|
349
|
+
def name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
351
350
|
return pulumi.get(self, "name")
|
|
352
351
|
|
|
353
352
|
@name.setter
|
|
354
|
-
def name(self, value: Optional[pulumi.Input[
|
|
353
|
+
def name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
355
354
|
pulumi.set(self, "name", value)
|
|
356
355
|
|
|
357
356
|
|
|
@@ -362,12 +361,12 @@ if not MYPY:
|
|
|
362
361
|
have an incoming path that they match against. However, destinations are determined by the kind
|
|
363
362
|
of the route.
|
|
364
363
|
"""
|
|
365
|
-
path:
|
|
364
|
+
path: _builtins.str
|
|
366
365
|
"""
|
|
367
366
|
The path on the API that will serve this route. If not prefixed with `/`,
|
|
368
367
|
then a `/` will be added automatically to the beginning.
|
|
369
368
|
"""
|
|
370
|
-
api_key_required: NotRequired[
|
|
369
|
+
api_key_required: NotRequired[_builtins.bool]
|
|
371
370
|
"""
|
|
372
371
|
If true, an API key will be required for this route. The source for the API Key can be set at
|
|
373
372
|
the API level and by default, the source will be the HEADER.
|
|
@@ -377,7 +376,7 @@ if not MYPY:
|
|
|
377
376
|
Authorizers allows you to define Lambda authorizers be applied for authorization when the
|
|
378
377
|
the route is called.
|
|
379
378
|
"""
|
|
380
|
-
content_type: NotRequired[
|
|
379
|
+
content_type: NotRequired[_builtins.str]
|
|
381
380
|
"""
|
|
382
381
|
The `content-type` to serve the file as. Only valid when `localPath` points to a file. If
|
|
383
382
|
`localPath` points to a directory, the content types for all files will be inferred.
|
|
@@ -390,17 +389,17 @@ if not MYPY:
|
|
|
390
389
|
"""
|
|
391
390
|
A Lambda function which will handle the route for the given path and method.
|
|
392
391
|
"""
|
|
393
|
-
iam_auth_enabled: NotRequired[
|
|
392
|
+
iam_auth_enabled: NotRequired[_builtins.bool]
|
|
394
393
|
"""
|
|
395
394
|
By default, the route method auth type is set to `NONE`. If true, the auth type will be
|
|
396
395
|
set to `AWS_IAM`.
|
|
397
396
|
"""
|
|
398
|
-
index: NotRequired[Union[
|
|
397
|
+
index: NotRequired[Union[_builtins.str, _builtins.bool]]
|
|
399
398
|
"""
|
|
400
399
|
By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory.
|
|
401
400
|
To disable this pass `false` or supply a new index document name.
|
|
402
401
|
"""
|
|
403
|
-
local_path: NotRequired[
|
|
402
|
+
local_path: NotRequired[_builtins.str]
|
|
404
403
|
"""
|
|
405
404
|
The local path on disk to create static S3 resources for. Files will be uploaded into S3
|
|
406
405
|
objects, and directories will be recursively walked into.
|
|
@@ -429,15 +428,15 @@ elif False:
|
|
|
429
428
|
@pulumi.input_type
|
|
430
429
|
class RouteArgs:
|
|
431
430
|
def __init__(__self__, *,
|
|
432
|
-
path:
|
|
433
|
-
api_key_required: Optional[
|
|
431
|
+
path: _builtins.str,
|
|
432
|
+
api_key_required: Optional[_builtins.bool] = None,
|
|
434
433
|
authorizers: Optional[Sequence['AuthorizerArgs']] = None,
|
|
435
|
-
content_type: Optional[
|
|
434
|
+
content_type: Optional[_builtins.str] = None,
|
|
436
435
|
data: Optional[Any] = None,
|
|
437
436
|
event_handler: Optional[pulumi.Input['pulumi_aws.lambda_.Function']] = None,
|
|
438
|
-
iam_auth_enabled: Optional[
|
|
439
|
-
index: Optional[Union[
|
|
440
|
-
local_path: Optional[
|
|
437
|
+
iam_auth_enabled: Optional[_builtins.bool] = None,
|
|
438
|
+
index: Optional[Union[_builtins.str, _builtins.bool]] = None,
|
|
439
|
+
local_path: Optional[_builtins.str] = None,
|
|
441
440
|
method: Optional['Method'] = None,
|
|
442
441
|
request_validator: Optional['RequestValidator'] = None,
|
|
443
442
|
required_parameters: Optional[Sequence['RequiredParameterArgs']] = None,
|
|
@@ -447,21 +446,21 @@ class RouteArgs:
|
|
|
447
446
|
have an incoming path that they match against. However, destinations are determined by the kind
|
|
448
447
|
of the route.
|
|
449
448
|
|
|
450
|
-
:param
|
|
449
|
+
:param _builtins.str path: The path on the API that will serve this route. If not prefixed with `/`,
|
|
451
450
|
then a `/` will be added automatically to the beginning.
|
|
452
|
-
:param
|
|
451
|
+
:param _builtins.bool api_key_required: If true, an API key will be required for this route. The source for the API Key can be set at
|
|
453
452
|
the API level and by default, the source will be the HEADER.
|
|
454
453
|
:param Sequence['AuthorizerArgs'] authorizers: Authorizers allows you to define Lambda authorizers be applied for authorization when the
|
|
455
454
|
the route is called.
|
|
456
|
-
:param
|
|
455
|
+
:param _builtins.str content_type: The `content-type` to serve the file as. Only valid when `localPath` points to a file. If
|
|
457
456
|
`localPath` points to a directory, the content types for all files will be inferred.
|
|
458
457
|
:param Any data: A raw Swagger object to include verbatim in the integration for this path.
|
|
459
458
|
:param pulumi.Input['pulumi_aws.lambda_.Function'] event_handler: A Lambda function which will handle the route for the given path and method.
|
|
460
|
-
:param
|
|
459
|
+
:param _builtins.bool iam_auth_enabled: By default, the route method auth type is set to `NONE`. If true, the auth type will be
|
|
461
460
|
set to `AWS_IAM`.
|
|
462
|
-
:param Union[
|
|
461
|
+
:param Union[_builtins.str, _builtins.bool] index: By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory.
|
|
463
462
|
To disable this pass `false` or supply a new index document name.
|
|
464
|
-
:param
|
|
463
|
+
:param _builtins.str local_path: The local path on disk to create static S3 resources for. Files will be uploaded into S3
|
|
465
464
|
objects, and directories will be recursively walked into.
|
|
466
465
|
:param 'Method' method: The REST method of the route to match. Only valid with `eventHandler` or `data` routes.
|
|
467
466
|
:param 'RequestValidator' request_validator: Request Validator specifies the validator to use at the method level. This will override anything
|
|
@@ -496,9 +495,9 @@ class RouteArgs:
|
|
|
496
495
|
if target is not None:
|
|
497
496
|
pulumi.set(__self__, "target", target)
|
|
498
497
|
|
|
499
|
-
@property
|
|
498
|
+
@_builtins.property
|
|
500
499
|
@pulumi.getter
|
|
501
|
-
def path(self) ->
|
|
500
|
+
def path(self) -> _builtins.str:
|
|
502
501
|
"""
|
|
503
502
|
The path on the API that will serve this route. If not prefixed with `/`,
|
|
504
503
|
then a `/` will be added automatically to the beginning.
|
|
@@ -506,12 +505,12 @@ class RouteArgs:
|
|
|
506
505
|
return pulumi.get(self, "path")
|
|
507
506
|
|
|
508
507
|
@path.setter
|
|
509
|
-
def path(self, value:
|
|
508
|
+
def path(self, value: _builtins.str):
|
|
510
509
|
pulumi.set(self, "path", value)
|
|
511
510
|
|
|
512
|
-
@property
|
|
511
|
+
@_builtins.property
|
|
513
512
|
@pulumi.getter(name="apiKeyRequired")
|
|
514
|
-
def api_key_required(self) -> Optional[
|
|
513
|
+
def api_key_required(self) -> Optional[_builtins.bool]:
|
|
515
514
|
"""
|
|
516
515
|
If true, an API key will be required for this route. The source for the API Key can be set at
|
|
517
516
|
the API level and by default, the source will be the HEADER.
|
|
@@ -519,10 +518,10 @@ class RouteArgs:
|
|
|
519
518
|
return pulumi.get(self, "api_key_required")
|
|
520
519
|
|
|
521
520
|
@api_key_required.setter
|
|
522
|
-
def api_key_required(self, value: Optional[
|
|
521
|
+
def api_key_required(self, value: Optional[_builtins.bool]):
|
|
523
522
|
pulumi.set(self, "api_key_required", value)
|
|
524
523
|
|
|
525
|
-
@property
|
|
524
|
+
@_builtins.property
|
|
526
525
|
@pulumi.getter
|
|
527
526
|
def authorizers(self) -> Optional[Sequence['AuthorizerArgs']]:
|
|
528
527
|
"""
|
|
@@ -535,9 +534,9 @@ class RouteArgs:
|
|
|
535
534
|
def authorizers(self, value: Optional[Sequence['AuthorizerArgs']]):
|
|
536
535
|
pulumi.set(self, "authorizers", value)
|
|
537
536
|
|
|
538
|
-
@property
|
|
537
|
+
@_builtins.property
|
|
539
538
|
@pulumi.getter(name="contentType")
|
|
540
|
-
def content_type(self) -> Optional[
|
|
539
|
+
def content_type(self) -> Optional[_builtins.str]:
|
|
541
540
|
"""
|
|
542
541
|
The `content-type` to serve the file as. Only valid when `localPath` points to a file. If
|
|
543
542
|
`localPath` points to a directory, the content types for all files will be inferred.
|
|
@@ -545,10 +544,10 @@ class RouteArgs:
|
|
|
545
544
|
return pulumi.get(self, "content_type")
|
|
546
545
|
|
|
547
546
|
@content_type.setter
|
|
548
|
-
def content_type(self, value: Optional[
|
|
547
|
+
def content_type(self, value: Optional[_builtins.str]):
|
|
549
548
|
pulumi.set(self, "content_type", value)
|
|
550
549
|
|
|
551
|
-
@property
|
|
550
|
+
@_builtins.property
|
|
552
551
|
@pulumi.getter
|
|
553
552
|
def data(self) -> Optional[Any]:
|
|
554
553
|
"""
|
|
@@ -560,7 +559,7 @@ class RouteArgs:
|
|
|
560
559
|
def data(self, value: Optional[Any]):
|
|
561
560
|
pulumi.set(self, "data", value)
|
|
562
561
|
|
|
563
|
-
@property
|
|
562
|
+
@_builtins.property
|
|
564
563
|
@pulumi.getter(name="eventHandler")
|
|
565
564
|
def event_handler(self) -> Optional[pulumi.Input['pulumi_aws.lambda_.Function']]:
|
|
566
565
|
"""
|
|
@@ -572,9 +571,9 @@ class RouteArgs:
|
|
|
572
571
|
def event_handler(self, value: Optional[pulumi.Input['pulumi_aws.lambda_.Function']]):
|
|
573
572
|
pulumi.set(self, "event_handler", value)
|
|
574
573
|
|
|
575
|
-
@property
|
|
574
|
+
@_builtins.property
|
|
576
575
|
@pulumi.getter(name="iamAuthEnabled")
|
|
577
|
-
def iam_auth_enabled(self) -> Optional[
|
|
576
|
+
def iam_auth_enabled(self) -> Optional[_builtins.bool]:
|
|
578
577
|
"""
|
|
579
578
|
By default, the route method auth type is set to `NONE`. If true, the auth type will be
|
|
580
579
|
set to `AWS_IAM`.
|
|
@@ -582,12 +581,12 @@ class RouteArgs:
|
|
|
582
581
|
return pulumi.get(self, "iam_auth_enabled")
|
|
583
582
|
|
|
584
583
|
@iam_auth_enabled.setter
|
|
585
|
-
def iam_auth_enabled(self, value: Optional[
|
|
584
|
+
def iam_auth_enabled(self, value: Optional[_builtins.bool]):
|
|
586
585
|
pulumi.set(self, "iam_auth_enabled", value)
|
|
587
586
|
|
|
588
|
-
@property
|
|
587
|
+
@_builtins.property
|
|
589
588
|
@pulumi.getter
|
|
590
|
-
def index(self) -> Optional[Union[
|
|
589
|
+
def index(self) -> Optional[Union[_builtins.str, _builtins.bool]]:
|
|
591
590
|
"""
|
|
592
591
|
By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory.
|
|
593
592
|
To disable this pass `false` or supply a new index document name.
|
|
@@ -595,12 +594,12 @@ class RouteArgs:
|
|
|
595
594
|
return pulumi.get(self, "index")
|
|
596
595
|
|
|
597
596
|
@index.setter
|
|
598
|
-
def index(self, value: Optional[Union[
|
|
597
|
+
def index(self, value: Optional[Union[_builtins.str, _builtins.bool]]):
|
|
599
598
|
pulumi.set(self, "index", value)
|
|
600
599
|
|
|
601
|
-
@property
|
|
600
|
+
@_builtins.property
|
|
602
601
|
@pulumi.getter(name="localPath")
|
|
603
|
-
def local_path(self) -> Optional[
|
|
602
|
+
def local_path(self) -> Optional[_builtins.str]:
|
|
604
603
|
"""
|
|
605
604
|
The local path on disk to create static S3 resources for. Files will be uploaded into S3
|
|
606
605
|
objects, and directories will be recursively walked into.
|
|
@@ -608,10 +607,10 @@ class RouteArgs:
|
|
|
608
607
|
return pulumi.get(self, "local_path")
|
|
609
608
|
|
|
610
609
|
@local_path.setter
|
|
611
|
-
def local_path(self, value: Optional[
|
|
610
|
+
def local_path(self, value: Optional[_builtins.str]):
|
|
612
611
|
pulumi.set(self, "local_path", value)
|
|
613
612
|
|
|
614
|
-
@property
|
|
613
|
+
@_builtins.property
|
|
615
614
|
@pulumi.getter
|
|
616
615
|
def method(self) -> Optional['Method']:
|
|
617
616
|
"""
|
|
@@ -623,7 +622,7 @@ class RouteArgs:
|
|
|
623
622
|
def method(self, value: Optional['Method']):
|
|
624
623
|
pulumi.set(self, "method", value)
|
|
625
624
|
|
|
626
|
-
@property
|
|
625
|
+
@_builtins.property
|
|
627
626
|
@pulumi.getter(name="requestValidator")
|
|
628
627
|
def request_validator(self) -> Optional['RequestValidator']:
|
|
629
628
|
"""
|
|
@@ -636,7 +635,7 @@ class RouteArgs:
|
|
|
636
635
|
def request_validator(self, value: Optional['RequestValidator']):
|
|
637
636
|
pulumi.set(self, "request_validator", value)
|
|
638
637
|
|
|
639
|
-
@property
|
|
638
|
+
@_builtins.property
|
|
640
639
|
@pulumi.getter(name="requiredParameters")
|
|
641
640
|
def required_parameters(self) -> Optional[Sequence['RequiredParameterArgs']]:
|
|
642
641
|
"""
|
|
@@ -649,7 +648,7 @@ class RouteArgs:
|
|
|
649
648
|
def required_parameters(self, value: Optional[Sequence['RequiredParameterArgs']]):
|
|
650
649
|
pulumi.set(self, "required_parameters", value)
|
|
651
650
|
|
|
652
|
-
@property
|
|
651
|
+
@_builtins.property
|
|
653
652
|
@pulumi.getter
|
|
654
653
|
def target(self) -> Optional[pulumi.Input['TargetArgs']]:
|
|
655
654
|
"""
|
|
@@ -664,18 +663,18 @@ class RouteArgs:
|
|
|
664
663
|
|
|
665
664
|
if not MYPY:
|
|
666
665
|
class SwaggerGatewayResponseArgsDict(TypedDict):
|
|
667
|
-
response_parameters: NotRequired[pulumi.Input[Mapping[str, pulumi.Input[
|
|
668
|
-
response_templates: NotRequired[pulumi.Input[Mapping[str, pulumi.Input[
|
|
669
|
-
status_code: NotRequired[pulumi.Input[
|
|
666
|
+
response_parameters: NotRequired[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]
|
|
667
|
+
response_templates: NotRequired[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]
|
|
668
|
+
status_code: NotRequired[pulumi.Input[_builtins.float]]
|
|
670
669
|
elif False:
|
|
671
670
|
SwaggerGatewayResponseArgsDict: TypeAlias = Mapping[str, Any]
|
|
672
671
|
|
|
673
672
|
@pulumi.input_type
|
|
674
673
|
class SwaggerGatewayResponseArgs:
|
|
675
674
|
def __init__(__self__, *,
|
|
676
|
-
response_parameters: Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
677
|
-
response_templates: Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
678
|
-
status_code: Optional[pulumi.Input[
|
|
675
|
+
response_parameters: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
|
|
676
|
+
response_templates: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
|
|
677
|
+
status_code: Optional[pulumi.Input[_builtins.float]] = None):
|
|
679
678
|
if response_parameters is not None:
|
|
680
679
|
pulumi.set(__self__, "response_parameters", response_parameters)
|
|
681
680
|
if response_templates is not None:
|
|
@@ -683,31 +682,31 @@ class SwaggerGatewayResponseArgs:
|
|
|
683
682
|
if status_code is not None:
|
|
684
683
|
pulumi.set(__self__, "status_code", status_code)
|
|
685
684
|
|
|
686
|
-
@property
|
|
685
|
+
@_builtins.property
|
|
687
686
|
@pulumi.getter(name="responseParameters")
|
|
688
|
-
def response_parameters(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
687
|
+
def response_parameters(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
|
|
689
688
|
return pulumi.get(self, "response_parameters")
|
|
690
689
|
|
|
691
690
|
@response_parameters.setter
|
|
692
|
-
def response_parameters(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
691
|
+
def response_parameters(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]):
|
|
693
692
|
pulumi.set(self, "response_parameters", value)
|
|
694
693
|
|
|
695
|
-
@property
|
|
694
|
+
@_builtins.property
|
|
696
695
|
@pulumi.getter(name="responseTemplates")
|
|
697
|
-
def response_templates(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
696
|
+
def response_templates(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
|
|
698
697
|
return pulumi.get(self, "response_templates")
|
|
699
698
|
|
|
700
699
|
@response_templates.setter
|
|
701
|
-
def response_templates(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
700
|
+
def response_templates(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]):
|
|
702
701
|
pulumi.set(self, "response_templates", value)
|
|
703
702
|
|
|
704
|
-
@property
|
|
703
|
+
@_builtins.property
|
|
705
704
|
@pulumi.getter(name="statusCode")
|
|
706
|
-
def status_code(self) -> Optional[pulumi.Input[
|
|
705
|
+
def status_code(self) -> Optional[pulumi.Input[_builtins.float]]:
|
|
707
706
|
return pulumi.get(self, "status_code")
|
|
708
707
|
|
|
709
708
|
@status_code.setter
|
|
710
|
-
def status_code(self, value: Optional[pulumi.Input[
|
|
709
|
+
def status_code(self, value: Optional[pulumi.Input[_builtins.float]]):
|
|
711
710
|
pulumi.set(self, "status_code", value)
|
|
712
711
|
|
|
713
712
|
|
|
@@ -736,7 +735,7 @@ if not MYPY:
|
|
|
736
735
|
* `mock`: for integrating the API method request with API Gateway as a "loop-back" endpoint
|
|
737
736
|
without invoking any backend.
|
|
738
737
|
"""
|
|
739
|
-
connection_id: NotRequired[pulumi.Input[
|
|
738
|
+
connection_id: NotRequired[pulumi.Input[_builtins.str]]
|
|
740
739
|
"""
|
|
741
740
|
The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
|
|
742
741
|
otherwise.
|
|
@@ -747,7 +746,7 @@ if not MYPY:
|
|
|
747
746
|
for connections through the public routable internet or `VPC_LINK` for private connections
|
|
748
747
|
between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.
|
|
749
748
|
"""
|
|
750
|
-
http_method: NotRequired[pulumi.Input[
|
|
749
|
+
http_method: NotRequired[pulumi.Input[_builtins.str]]
|
|
751
750
|
"""
|
|
752
751
|
Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.
|
|
753
752
|
"""
|
|
@@ -774,7 +773,7 @@ if not MYPY:
|
|
|
774
773
|
|
|
775
774
|
Defaults to `WHEN_NO_MATCH` if unspecified.
|
|
776
775
|
"""
|
|
777
|
-
uri: NotRequired[pulumi.Input[
|
|
776
|
+
uri: NotRequired[pulumi.Input[_builtins.str]]
|
|
778
777
|
"""
|
|
779
778
|
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
|
|
780
779
|
|
|
@@ -803,11 +802,11 @@ elif False:
|
|
|
803
802
|
class TargetArgs:
|
|
804
803
|
def __init__(__self__, *,
|
|
805
804
|
type: pulumi.Input['IntegrationType'],
|
|
806
|
-
connection_id: Optional[pulumi.Input[
|
|
805
|
+
connection_id: Optional[pulumi.Input[_builtins.str]] = None,
|
|
807
806
|
connection_type: Optional[pulumi.Input['IntegrationConnectionType']] = None,
|
|
808
|
-
http_method: Optional[pulumi.Input[
|
|
807
|
+
http_method: Optional[pulumi.Input[_builtins.str]] = None,
|
|
809
808
|
passthrough_behaviour: Optional[pulumi.Input['IntegrationPassthroughBehavior']] = None,
|
|
810
|
-
uri: Optional[pulumi.Input[
|
|
809
|
+
uri: Optional[pulumi.Input[_builtins.str]] = None):
|
|
811
810
|
"""
|
|
812
811
|
:param pulumi.Input['IntegrationType'] type: Specifies an API method integration type. The valid value is one of the following:
|
|
813
812
|
|
|
@@ -829,12 +828,12 @@ class TargetArgs:
|
|
|
829
828
|
|
|
830
829
|
* `mock`: for integrating the API method request with API Gateway as a "loop-back" endpoint
|
|
831
830
|
without invoking any backend.
|
|
832
|
-
:param pulumi.Input[
|
|
831
|
+
:param pulumi.Input[_builtins.str] connection_id: The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
|
|
833
832
|
otherwise.
|
|
834
833
|
:param pulumi.Input['IntegrationConnectionType'] connection_type: The type of the network connection to the integration endpoint. The valid value is `INTERNET`
|
|
835
834
|
for connections through the public routable internet or `VPC_LINK` for private connections
|
|
836
835
|
between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.
|
|
837
|
-
:param pulumi.Input[
|
|
836
|
+
:param pulumi.Input[_builtins.str] http_method: Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.
|
|
838
837
|
:param pulumi.Input['IntegrationPassthroughBehavior'] passthrough_behaviour: Specifies how the method request body of an unmapped content type will be passed through the
|
|
839
838
|
integration request to the back end without transformation.
|
|
840
839
|
|
|
@@ -855,7 +854,7 @@ class TargetArgs:
|
|
|
855
854
|
integration request.
|
|
856
855
|
|
|
857
856
|
Defaults to `WHEN_NO_MATCH` if unspecified.
|
|
858
|
-
:param pulumi.Input[
|
|
857
|
+
:param pulumi.Input[_builtins.str] uri: Specifies Uniform Resource Identifier (URI) of the integration endpoint.
|
|
859
858
|
|
|
860
859
|
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL
|
|
861
860
|
according to the RFC-3986 specification, for either standard integration, where
|
|
@@ -887,7 +886,7 @@ class TargetArgs:
|
|
|
887
886
|
if uri is not None:
|
|
888
887
|
pulumi.set(__self__, "uri", uri)
|
|
889
888
|
|
|
890
|
-
@property
|
|
889
|
+
@_builtins.property
|
|
891
890
|
@pulumi.getter
|
|
892
891
|
def type(self) -> pulumi.Input['IntegrationType']:
|
|
893
892
|
"""
|
|
@@ -918,9 +917,9 @@ class TargetArgs:
|
|
|
918
917
|
def type(self, value: pulumi.Input['IntegrationType']):
|
|
919
918
|
pulumi.set(self, "type", value)
|
|
920
919
|
|
|
921
|
-
@property
|
|
920
|
+
@_builtins.property
|
|
922
921
|
@pulumi.getter(name="connectionId")
|
|
923
|
-
def connection_id(self) -> Optional[pulumi.Input[
|
|
922
|
+
def connection_id(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
924
923
|
"""
|
|
925
924
|
The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
|
|
926
925
|
otherwise.
|
|
@@ -928,10 +927,10 @@ class TargetArgs:
|
|
|
928
927
|
return pulumi.get(self, "connection_id")
|
|
929
928
|
|
|
930
929
|
@connection_id.setter
|
|
931
|
-
def connection_id(self, value: Optional[pulumi.Input[
|
|
930
|
+
def connection_id(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
932
931
|
pulumi.set(self, "connection_id", value)
|
|
933
932
|
|
|
934
|
-
@property
|
|
933
|
+
@_builtins.property
|
|
935
934
|
@pulumi.getter(name="connectionType")
|
|
936
935
|
def connection_type(self) -> Optional[pulumi.Input['IntegrationConnectionType']]:
|
|
937
936
|
"""
|
|
@@ -945,19 +944,19 @@ class TargetArgs:
|
|
|
945
944
|
def connection_type(self, value: Optional[pulumi.Input['IntegrationConnectionType']]):
|
|
946
945
|
pulumi.set(self, "connection_type", value)
|
|
947
946
|
|
|
948
|
-
@property
|
|
947
|
+
@_builtins.property
|
|
949
948
|
@pulumi.getter(name="httpMethod")
|
|
950
|
-
def http_method(self) -> Optional[pulumi.Input[
|
|
949
|
+
def http_method(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
951
950
|
"""
|
|
952
951
|
Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.
|
|
953
952
|
"""
|
|
954
953
|
return pulumi.get(self, "http_method")
|
|
955
954
|
|
|
956
955
|
@http_method.setter
|
|
957
|
-
def http_method(self, value: Optional[pulumi.Input[
|
|
956
|
+
def http_method(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
958
957
|
pulumi.set(self, "http_method", value)
|
|
959
958
|
|
|
960
|
-
@property
|
|
959
|
+
@_builtins.property
|
|
961
960
|
@pulumi.getter(name="passthroughBehaviour")
|
|
962
961
|
def passthrough_behaviour(self) -> Optional[pulumi.Input['IntegrationPassthroughBehavior']]:
|
|
963
962
|
"""
|
|
@@ -988,9 +987,9 @@ class TargetArgs:
|
|
|
988
987
|
def passthrough_behaviour(self, value: Optional[pulumi.Input['IntegrationPassthroughBehavior']]):
|
|
989
988
|
pulumi.set(self, "passthrough_behaviour", value)
|
|
990
989
|
|
|
991
|
-
@property
|
|
990
|
+
@_builtins.property
|
|
992
991
|
@pulumi.getter
|
|
993
|
-
def uri(self) -> Optional[pulumi.Input[
|
|
992
|
+
def uri(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
994
993
|
"""
|
|
995
994
|
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
|
|
996
995
|
|
|
@@ -1015,7 +1014,7 @@ class TargetArgs:
|
|
|
1015
1014
|
return pulumi.get(self, "uri")
|
|
1016
1015
|
|
|
1017
1016
|
@uri.setter
|
|
1018
|
-
def uri(self, value: Optional[pulumi.Input[
|
|
1017
|
+
def uri(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
1019
1018
|
pulumi.set(self, "uri", value)
|
|
1020
1019
|
|
|
1021
1020
|
|
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import builtins
|
|
6
|
-
import copy
|
|
5
|
+
import builtins as _builtins
|
|
7
6
|
import warnings
|
|
8
7
|
import sys
|
|
9
8
|
import pulumi
|
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
# *** WARNING: this file was generated by pulumi-language-python. ***
|
|
3
3
|
# *** Do not edit by hand unless you're certain you know what you are doing! ***
|
|
4
4
|
|
|
5
|
-
import builtins
|
|
6
|
-
import copy
|
|
5
|
+
import builtins as _builtins
|
|
7
6
|
import warnings
|
|
8
7
|
import sys
|
|
9
8
|
import pulumi
|
|
@@ -24,25 +23,25 @@ __all__ = ['RestAPIArgs', 'RestAPI']
|
|
|
24
23
|
class RestAPIArgs:
|
|
25
24
|
def __init__(__self__, *,
|
|
26
25
|
api_key_source: Optional['APIKeySource'] = None,
|
|
27
|
-
binary_media_types: Optional[Sequence[pulumi.Input[
|
|
28
|
-
description: Optional[pulumi.Input[
|
|
29
|
-
disable_execute_api_endpoint: Optional[pulumi.Input[
|
|
26
|
+
binary_media_types: Optional[Sequence[pulumi.Input[_builtins.str]]] = None,
|
|
27
|
+
description: Optional[pulumi.Input[_builtins.str]] = None,
|
|
28
|
+
disable_execute_api_endpoint: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
30
29
|
gateway_responses: Optional[Mapping[str, pulumi.Input['SwaggerGatewayResponseArgs']]] = None,
|
|
31
30
|
request_validator: Optional['RequestValidator'] = None,
|
|
32
31
|
routes: Optional[Sequence['RouteArgs']] = None,
|
|
33
|
-
stage_name: Optional[pulumi.Input[
|
|
32
|
+
stage_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
34
33
|
static_routes_bucket: Optional[pulumi.Input['pulumi_aws.s3.Bucket']] = None,
|
|
35
|
-
swagger_string: Optional[pulumi.Input[
|
|
36
|
-
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
34
|
+
swagger_string: Optional[pulumi.Input[_builtins.str]] = None,
|
|
35
|
+
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None):
|
|
37
36
|
"""
|
|
38
37
|
The set of arguments for constructing a RestAPI resource.
|
|
39
38
|
:param 'APIKeySource' api_key_source: The source for the apikey. This can either be a HEADER or AUTHORIZER. If `apiKeyRequired` is
|
|
40
39
|
set to true on a route, and this is not defined the value will default to HEADER.
|
|
41
|
-
:param Sequence[pulumi.Input[
|
|
40
|
+
:param Sequence[pulumi.Input[_builtins.str]] binary_media_types: List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads.
|
|
42
41
|
If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-binary-media-types extension.
|
|
43
42
|
If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
|
|
44
|
-
:param pulumi.Input[
|
|
45
|
-
:param pulumi.Input[
|
|
43
|
+
:param pulumi.Input[_builtins.str] description: Description of the REST API.
|
|
44
|
+
:param pulumi.Input[_builtins.bool] disable_execute_api_endpoint: Whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke
|
|
46
45
|
your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
|
|
47
46
|
clients use a custom domain name to invoke your API, disable the default endpoint. Defaults to false.
|
|
48
47
|
:param Mapping[str, pulumi.Input['SwaggerGatewayResponseArgs']] gateway_responses: Define custom gateway responses for the API. This can be used to properly enable
|
|
@@ -53,15 +52,15 @@ class RestAPIArgs:
|
|
|
53
52
|
specification for the API.
|
|
54
53
|
|
|
55
54
|
Either `swaggerString` or `routes` must be specified.
|
|
56
|
-
:param pulumi.Input[
|
|
55
|
+
:param pulumi.Input[_builtins.str] stage_name: The stage name for your API. This will get added as a base path to your API url.
|
|
57
56
|
:param pulumi.Input['pulumi_aws.s3.Bucket'] static_routes_bucket: Bucket to use for placing resources for static resources. If not provided a default one will
|
|
58
57
|
be created on your behalf if any `StaticRoute`s are provided.
|
|
59
|
-
:param pulumi.Input[
|
|
58
|
+
:param pulumi.Input[_builtins.str] swagger_string: A Swagger specification already in string form to use to initialize the APIGateway. Note
|
|
60
59
|
that you must manually provide permission for any route targets to be invoked by API Gateway
|
|
61
60
|
when using `swaggerString`.
|
|
62
61
|
|
|
63
62
|
Either `swaggerString` or `routes` must be specified.
|
|
64
|
-
:param pulumi.Input[Mapping[str, pulumi.Input[
|
|
63
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] tags: 'Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present,
|
|
65
64
|
tags with matching keys will overwrite those defined at the provider-level.
|
|
66
65
|
"""
|
|
67
66
|
if api_key_source is not None:
|
|
@@ -87,7 +86,7 @@ class RestAPIArgs:
|
|
|
87
86
|
if tags is not None:
|
|
88
87
|
pulumi.set(__self__, "tags", tags)
|
|
89
88
|
|
|
90
|
-
@property
|
|
89
|
+
@_builtins.property
|
|
91
90
|
@pulumi.getter(name="apiKeySource")
|
|
92
91
|
def api_key_source(self) -> Optional['APIKeySource']:
|
|
93
92
|
"""
|
|
@@ -100,9 +99,9 @@ class RestAPIArgs:
|
|
|
100
99
|
def api_key_source(self, value: Optional['APIKeySource']):
|
|
101
100
|
pulumi.set(self, "api_key_source", value)
|
|
102
101
|
|
|
103
|
-
@property
|
|
102
|
+
@_builtins.property
|
|
104
103
|
@pulumi.getter(name="binaryMediaTypes")
|
|
105
|
-
def binary_media_types(self) -> Optional[Sequence[pulumi.Input[
|
|
104
|
+
def binary_media_types(self) -> Optional[Sequence[pulumi.Input[_builtins.str]]]:
|
|
106
105
|
"""
|
|
107
106
|
List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads.
|
|
108
107
|
If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-binary-media-types extension.
|
|
@@ -111,24 +110,24 @@ class RestAPIArgs:
|
|
|
111
110
|
return pulumi.get(self, "binary_media_types")
|
|
112
111
|
|
|
113
112
|
@binary_media_types.setter
|
|
114
|
-
def binary_media_types(self, value: Optional[Sequence[pulumi.Input[
|
|
113
|
+
def binary_media_types(self, value: Optional[Sequence[pulumi.Input[_builtins.str]]]):
|
|
115
114
|
pulumi.set(self, "binary_media_types", value)
|
|
116
115
|
|
|
117
|
-
@property
|
|
116
|
+
@_builtins.property
|
|
118
117
|
@pulumi.getter
|
|
119
|
-
def description(self) -> Optional[pulumi.Input[
|
|
118
|
+
def description(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
120
119
|
"""
|
|
121
120
|
Description of the REST API.
|
|
122
121
|
"""
|
|
123
122
|
return pulumi.get(self, "description")
|
|
124
123
|
|
|
125
124
|
@description.setter
|
|
126
|
-
def description(self, value: Optional[pulumi.Input[
|
|
125
|
+
def description(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
127
126
|
pulumi.set(self, "description", value)
|
|
128
127
|
|
|
129
|
-
@property
|
|
128
|
+
@_builtins.property
|
|
130
129
|
@pulumi.getter(name="disableExecuteApiEndpoint")
|
|
131
|
-
def disable_execute_api_endpoint(self) -> Optional[pulumi.Input[
|
|
130
|
+
def disable_execute_api_endpoint(self) -> Optional[pulumi.Input[_builtins.bool]]:
|
|
132
131
|
"""
|
|
133
132
|
Whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke
|
|
134
133
|
your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
|
|
@@ -137,10 +136,10 @@ class RestAPIArgs:
|
|
|
137
136
|
return pulumi.get(self, "disable_execute_api_endpoint")
|
|
138
137
|
|
|
139
138
|
@disable_execute_api_endpoint.setter
|
|
140
|
-
def disable_execute_api_endpoint(self, value: Optional[pulumi.Input[
|
|
139
|
+
def disable_execute_api_endpoint(self, value: Optional[pulumi.Input[_builtins.bool]]):
|
|
141
140
|
pulumi.set(self, "disable_execute_api_endpoint", value)
|
|
142
141
|
|
|
143
|
-
@property
|
|
142
|
+
@_builtins.property
|
|
144
143
|
@pulumi.getter(name="gatewayResponses")
|
|
145
144
|
def gateway_responses(self) -> Optional[Mapping[str, pulumi.Input['SwaggerGatewayResponseArgs']]]:
|
|
146
145
|
"""
|
|
@@ -153,7 +152,7 @@ class RestAPIArgs:
|
|
|
153
152
|
def gateway_responses(self, value: Optional[Mapping[str, pulumi.Input['SwaggerGatewayResponseArgs']]]):
|
|
154
153
|
pulumi.set(self, "gateway_responses", value)
|
|
155
154
|
|
|
156
|
-
@property
|
|
155
|
+
@_builtins.property
|
|
157
156
|
@pulumi.getter(name="requestValidator")
|
|
158
157
|
def request_validator(self) -> Optional['RequestValidator']:
|
|
159
158
|
"""
|
|
@@ -166,7 +165,7 @@ class RestAPIArgs:
|
|
|
166
165
|
def request_validator(self, value: Optional['RequestValidator']):
|
|
167
166
|
pulumi.set(self, "request_validator", value)
|
|
168
167
|
|
|
169
|
-
@property
|
|
168
|
+
@_builtins.property
|
|
170
169
|
@pulumi.getter
|
|
171
170
|
def routes(self) -> Optional[Sequence['RouteArgs']]:
|
|
172
171
|
"""
|
|
@@ -181,19 +180,19 @@ class RestAPIArgs:
|
|
|
181
180
|
def routes(self, value: Optional[Sequence['RouteArgs']]):
|
|
182
181
|
pulumi.set(self, "routes", value)
|
|
183
182
|
|
|
184
|
-
@property
|
|
183
|
+
@_builtins.property
|
|
185
184
|
@pulumi.getter(name="stageName")
|
|
186
|
-
def stage_name(self) -> Optional[pulumi.Input[
|
|
185
|
+
def stage_name(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
187
186
|
"""
|
|
188
187
|
The stage name for your API. This will get added as a base path to your API url.
|
|
189
188
|
"""
|
|
190
189
|
return pulumi.get(self, "stage_name")
|
|
191
190
|
|
|
192
191
|
@stage_name.setter
|
|
193
|
-
def stage_name(self, value: Optional[pulumi.Input[
|
|
192
|
+
def stage_name(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
194
193
|
pulumi.set(self, "stage_name", value)
|
|
195
194
|
|
|
196
|
-
@property
|
|
195
|
+
@_builtins.property
|
|
197
196
|
@pulumi.getter(name="staticRoutesBucket")
|
|
198
197
|
def static_routes_bucket(self) -> Optional[pulumi.Input['pulumi_aws.s3.Bucket']]:
|
|
199
198
|
"""
|
|
@@ -206,9 +205,9 @@ class RestAPIArgs:
|
|
|
206
205
|
def static_routes_bucket(self, value: Optional[pulumi.Input['pulumi_aws.s3.Bucket']]):
|
|
207
206
|
pulumi.set(self, "static_routes_bucket", value)
|
|
208
207
|
|
|
209
|
-
@property
|
|
208
|
+
@_builtins.property
|
|
210
209
|
@pulumi.getter(name="swaggerString")
|
|
211
|
-
def swagger_string(self) -> Optional[pulumi.Input[
|
|
210
|
+
def swagger_string(self) -> Optional[pulumi.Input[_builtins.str]]:
|
|
212
211
|
"""
|
|
213
212
|
A Swagger specification already in string form to use to initialize the APIGateway. Note
|
|
214
213
|
that you must manually provide permission for any route targets to be invoked by API Gateway
|
|
@@ -219,12 +218,12 @@ class RestAPIArgs:
|
|
|
219
218
|
return pulumi.get(self, "swagger_string")
|
|
220
219
|
|
|
221
220
|
@swagger_string.setter
|
|
222
|
-
def swagger_string(self, value: Optional[pulumi.Input[
|
|
221
|
+
def swagger_string(self, value: Optional[pulumi.Input[_builtins.str]]):
|
|
223
222
|
pulumi.set(self, "swagger_string", value)
|
|
224
223
|
|
|
225
|
-
@property
|
|
224
|
+
@_builtins.property
|
|
226
225
|
@pulumi.getter
|
|
227
|
-
def tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
226
|
+
def tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
|
|
228
227
|
"""
|
|
229
228
|
'Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present,
|
|
230
229
|
tags with matching keys will overwrite those defined at the provider-level.
|
|
@@ -232,7 +231,7 @@ class RestAPIArgs:
|
|
|
232
231
|
return pulumi.get(self, "tags")
|
|
233
232
|
|
|
234
233
|
@tags.setter
|
|
235
|
-
def tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
234
|
+
def tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]):
|
|
236
235
|
pulumi.set(self, "tags", value)
|
|
237
236
|
|
|
238
237
|
|
|
@@ -243,16 +242,16 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
243
242
|
resource_name: str,
|
|
244
243
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
245
244
|
api_key_source: Optional['APIKeySource'] = None,
|
|
246
|
-
binary_media_types: Optional[Sequence[pulumi.Input[
|
|
247
|
-
description: Optional[pulumi.Input[
|
|
248
|
-
disable_execute_api_endpoint: Optional[pulumi.Input[
|
|
245
|
+
binary_media_types: Optional[Sequence[pulumi.Input[_builtins.str]]] = None,
|
|
246
|
+
description: Optional[pulumi.Input[_builtins.str]] = None,
|
|
247
|
+
disable_execute_api_endpoint: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
249
248
|
gateway_responses: Optional[Mapping[str, pulumi.Input[Union['SwaggerGatewayResponseArgs', 'SwaggerGatewayResponseArgsDict']]]] = None,
|
|
250
249
|
request_validator: Optional['RequestValidator'] = None,
|
|
251
250
|
routes: Optional[Sequence[Union['RouteArgs', 'RouteArgsDict']]] = None,
|
|
252
|
-
stage_name: Optional[pulumi.Input[
|
|
251
|
+
stage_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
253
252
|
static_routes_bucket: Optional[pulumi.Input['pulumi_aws.s3.Bucket']] = None,
|
|
254
|
-
swagger_string: Optional[pulumi.Input[
|
|
255
|
-
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
253
|
+
swagger_string: Optional[pulumi.Input[_builtins.str]] = None,
|
|
254
|
+
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
|
|
256
255
|
__props__=None):
|
|
257
256
|
"""
|
|
258
257
|
The RestAPI component offers a simple interface for creating a fully functional API Gateway REST API. The
|
|
@@ -264,11 +263,11 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
264
263
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
265
264
|
:param 'APIKeySource' api_key_source: The source for the apikey. This can either be a HEADER or AUTHORIZER. If `apiKeyRequired` is
|
|
266
265
|
set to true on a route, and this is not defined the value will default to HEADER.
|
|
267
|
-
:param Sequence[pulumi.Input[
|
|
266
|
+
:param Sequence[pulumi.Input[_builtins.str]] binary_media_types: List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads.
|
|
268
267
|
If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-binary-media-types extension.
|
|
269
268
|
If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
|
|
270
|
-
:param pulumi.Input[
|
|
271
|
-
:param pulumi.Input[
|
|
269
|
+
:param pulumi.Input[_builtins.str] description: Description of the REST API.
|
|
270
|
+
:param pulumi.Input[_builtins.bool] disable_execute_api_endpoint: Whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke
|
|
272
271
|
your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
|
|
273
272
|
clients use a custom domain name to invoke your API, disable the default endpoint. Defaults to false.
|
|
274
273
|
:param Mapping[str, pulumi.Input[Union['SwaggerGatewayResponseArgs', 'SwaggerGatewayResponseArgsDict']]] gateway_responses: Define custom gateway responses for the API. This can be used to properly enable
|
|
@@ -279,15 +278,15 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
279
278
|
specification for the API.
|
|
280
279
|
|
|
281
280
|
Either `swaggerString` or `routes` must be specified.
|
|
282
|
-
:param pulumi.Input[
|
|
281
|
+
:param pulumi.Input[_builtins.str] stage_name: The stage name for your API. This will get added as a base path to your API url.
|
|
283
282
|
:param pulumi.Input['pulumi_aws.s3.Bucket'] static_routes_bucket: Bucket to use for placing resources for static resources. If not provided a default one will
|
|
284
283
|
be created on your behalf if any `StaticRoute`s are provided.
|
|
285
|
-
:param pulumi.Input[
|
|
284
|
+
:param pulumi.Input[_builtins.str] swagger_string: A Swagger specification already in string form to use to initialize the APIGateway. Note
|
|
286
285
|
that you must manually provide permission for any route targets to be invoked by API Gateway
|
|
287
286
|
when using `swaggerString`.
|
|
288
287
|
|
|
289
288
|
Either `swaggerString` or `routes` must be specified.
|
|
290
|
-
:param pulumi.Input[Mapping[str, pulumi.Input[
|
|
289
|
+
:param pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]] tags: 'Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present,
|
|
291
290
|
tags with matching keys will overwrite those defined at the provider-level.
|
|
292
291
|
"""
|
|
293
292
|
...
|
|
@@ -318,16 +317,16 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
318
317
|
resource_name: str,
|
|
319
318
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
320
319
|
api_key_source: Optional['APIKeySource'] = None,
|
|
321
|
-
binary_media_types: Optional[Sequence[pulumi.Input[
|
|
322
|
-
description: Optional[pulumi.Input[
|
|
323
|
-
disable_execute_api_endpoint: Optional[pulumi.Input[
|
|
320
|
+
binary_media_types: Optional[Sequence[pulumi.Input[_builtins.str]]] = None,
|
|
321
|
+
description: Optional[pulumi.Input[_builtins.str]] = None,
|
|
322
|
+
disable_execute_api_endpoint: Optional[pulumi.Input[_builtins.bool]] = None,
|
|
324
323
|
gateway_responses: Optional[Mapping[str, pulumi.Input[Union['SwaggerGatewayResponseArgs', 'SwaggerGatewayResponseArgsDict']]]] = None,
|
|
325
324
|
request_validator: Optional['RequestValidator'] = None,
|
|
326
325
|
routes: Optional[Sequence[Union['RouteArgs', 'RouteArgsDict']]] = None,
|
|
327
|
-
stage_name: Optional[pulumi.Input[
|
|
326
|
+
stage_name: Optional[pulumi.Input[_builtins.str]] = None,
|
|
328
327
|
static_routes_bucket: Optional[pulumi.Input['pulumi_aws.s3.Bucket']] = None,
|
|
329
|
-
swagger_string: Optional[pulumi.Input[
|
|
330
|
-
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[
|
|
328
|
+
swagger_string: Optional[pulumi.Input[_builtins.str]] = None,
|
|
329
|
+
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]] = None,
|
|
331
330
|
__props__=None):
|
|
332
331
|
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
333
332
|
if not isinstance(opts, pulumi.ResourceOptions):
|
|
@@ -362,7 +361,7 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
362
361
|
opts,
|
|
363
362
|
remote=True)
|
|
364
363
|
|
|
365
|
-
@property
|
|
364
|
+
@_builtins.property
|
|
366
365
|
@pulumi.getter
|
|
367
366
|
def api(self) -> pulumi.Output['pulumi_aws.apigateway.RestApi']:
|
|
368
367
|
"""
|
|
@@ -370,7 +369,7 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
370
369
|
"""
|
|
371
370
|
return pulumi.get(self, "api")
|
|
372
371
|
|
|
373
|
-
@property
|
|
372
|
+
@_builtins.property
|
|
374
373
|
@pulumi.getter(name="apiPolicy")
|
|
375
374
|
def api_policy(self) -> pulumi.Output[Optional['pulumi_aws.apigateway.RestApiPolicy']]:
|
|
376
375
|
"""
|
|
@@ -378,7 +377,7 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
378
377
|
"""
|
|
379
378
|
return pulumi.get(self, "api_policy")
|
|
380
379
|
|
|
381
|
-
@property
|
|
380
|
+
@_builtins.property
|
|
382
381
|
@pulumi.getter
|
|
383
382
|
def deployment(self) -> pulumi.Output['pulumi_aws.apigateway.Deployment']:
|
|
384
383
|
"""
|
|
@@ -386,7 +385,7 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
386
385
|
"""
|
|
387
386
|
return pulumi.get(self, "deployment")
|
|
388
387
|
|
|
389
|
-
@property
|
|
388
|
+
@_builtins.property
|
|
390
389
|
@pulumi.getter
|
|
391
390
|
def stage(self) -> pulumi.Output['pulumi_aws.apigateway.Stage']:
|
|
392
391
|
"""
|
|
@@ -394,9 +393,9 @@ class RestAPI(pulumi.ComponentResource):
|
|
|
394
393
|
"""
|
|
395
394
|
return pulumi.get(self, "stage")
|
|
396
395
|
|
|
397
|
-
@property
|
|
396
|
+
@_builtins.property
|
|
398
397
|
@pulumi.getter
|
|
399
|
-
def url(self) -> pulumi.Output[
|
|
398
|
+
def url(self) -> pulumi.Output[_builtins.str]:
|
|
400
399
|
"""
|
|
401
400
|
The URL where the Rest API is exposed.
|
|
402
401
|
"""
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: pulumi_aws_apigateway
|
|
3
|
-
Version: 2.7.
|
|
3
|
+
Version: 2.7.0a1753124556
|
|
4
4
|
Summary: Pulumi Amazon Web Services (AWS) API Gateway Components.
|
|
5
5
|
License: Apache-2.0
|
|
6
6
|
Project-URL: Repository, https://github.com/pulumi/pulumi-aws-apigateway
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
pulumi_aws_apigateway/__init__.py,sha256=-Y2G_LvPPAIYvzap0o0WQV8XcrVQryd3Zi3Xv9mUW9k,747
|
|
2
|
+
pulumi_aws_apigateway/_enums.py,sha256=yYie1py4CEPLxDkkI-OkI13cXQgjwDFfxmcu8qasf8Y,1600
|
|
3
|
+
pulumi_aws_apigateway/_inputs.py,sha256=K5_wORVkNkk_KtxjmO1EQ3VHLZ75hWVVkpTs3sAAlBg,52033
|
|
4
|
+
pulumi_aws_apigateway/_utilities.py,sha256=66uLGQDI1oMFOI3Fe5igAphtexWhcSLDyuVW50jW3ik,10789
|
|
5
|
+
pulumi_aws_apigateway/provider.py,sha256=0EETsawHAXrPjtcLTWDLSGjRxnt8znP3_RboozHPqiI,3001
|
|
6
|
+
pulumi_aws_apigateway/pulumi-plugin.json,sha256=HDbLCeiEmFcyz9wCrQ9YR-r5iOZcXVPToAPTMKlrT0c,90
|
|
7
|
+
pulumi_aws_apigateway/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
8
|
+
pulumi_aws_apigateway/rest_api.py,sha256=Hvi-OjnfE1dNXApVb6hh8YvJx0kXYpaoPrwB2lJdf3Q,22306
|
|
9
|
+
pulumi_aws_apigateway-2.7.0a1753124556.dist-info/METADATA,sha256=5kRWsdeP1s78LDXFDadbzTEIjLc76hDvXQEw5kT30lo,3010
|
|
10
|
+
pulumi_aws_apigateway-2.7.0a1753124556.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
11
|
+
pulumi_aws_apigateway-2.7.0a1753124556.dist-info/top_level.txt,sha256=YY2wCK-Qy789n9y-8rwjASV5533Pg_6X5fH0hoDSif4,22
|
|
12
|
+
pulumi_aws_apigateway-2.7.0a1753124556.dist-info/RECORD,,
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
pulumi_aws_apigateway/__init__.py,sha256=de7yPkrlX_cJc9hPR7esIlwEAt2bce80bGkoN3j7nQg,734
|
|
2
|
-
pulumi_aws_apigateway/_enums.py,sha256=Cby_ZZc4rcSDyicrwc_OB0psvxWYlY2tt5t5-Z-pUvM,1581
|
|
3
|
-
pulumi_aws_apigateway/_inputs.py,sha256=kqPMB3ituvhTaVHQb9oZ3JYdTNNu_CfOKbPnKo3fHSw,51562
|
|
4
|
-
pulumi_aws_apigateway/_utilities.py,sha256=66uLGQDI1oMFOI3Fe5igAphtexWhcSLDyuVW50jW3ik,10789
|
|
5
|
-
pulumi_aws_apigateway/provider.py,sha256=chs_RU_2X7E2wh9aKnpXjwl5vOeEbBEf6_ZvLHRNbys,3000
|
|
6
|
-
pulumi_aws_apigateway/pulumi-plugin.json,sha256=8NeV6OzwtNdJlEY18yXXb3XGvK8OmfAROu1gRy_DK8c,90
|
|
7
|
-
pulumi_aws_apigateway/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
8
|
-
pulumi_aws_apigateway/rest_api.py,sha256=2g0fXy240zuKbQBP_DNNLUVPqikkXLPv4FdNPVm-9AA,22102
|
|
9
|
-
pulumi_aws_apigateway-2.7.0a1752881638.dist-info/METADATA,sha256=MmgmX__MYb032x4QFOAOGUjTq4YxFz67G26CrSkXTEY,3010
|
|
10
|
-
pulumi_aws_apigateway-2.7.0a1752881638.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
11
|
-
pulumi_aws_apigateway-2.7.0a1752881638.dist-info/top_level.txt,sha256=YY2wCK-Qy789n9y-8rwjASV5533Pg_6X5fH0hoDSif4,22
|
|
12
|
-
pulumi_aws_apigateway-2.7.0a1752881638.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|