pulumi-aws-apigateway 2.7.0a1742520710__py3-none-any.whl → 3.1.0a1762981340__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.
@@ -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 copy
5
+ import builtins as _builtins
6
6
  import warnings
7
7
  import sys
8
8
  import pulumi
@@ -36,21 +36,21 @@ if not MYPY:
36
36
  """
37
37
  LambdaAuthorizer provides the definition for a custom Authorizer for API Gateway.
38
38
  """
39
- parameter_name: str
39
+ parameter_name: _builtins.str
40
40
  """
41
41
  parameterName is the name of the header or query parameter containing the authorization
42
42
  token. Must be "Unused" for multiple identity sources.
43
43
  """
44
- auth_type: NotRequired[str]
44
+ auth_type: NotRequired[_builtins.str]
45
45
  """
46
46
  Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".
47
47
  """
48
- authorizer_name: NotRequired[str]
48
+ authorizer_name: NotRequired[_builtins.str]
49
49
  """
50
50
  The name for the Authorizer to be referenced as. This must be unique for each unique
51
51
  authorizer within the API. If no name if specified, a name will be generated for you.
52
52
  """
53
- authorizer_result_ttl_in_seconds: NotRequired[float]
53
+ authorizer_result_ttl_in_seconds: NotRequired[_builtins.float]
54
54
  """
55
55
  The number of seconds during which the resulting IAM policy is cached. Default is 300s. You
56
56
  can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an
@@ -61,20 +61,20 @@ if not MYPY:
61
61
  """
62
62
  The authorizerHandler specifies information about the authorizing Lambda.
63
63
  """
64
- identity_source: NotRequired[Sequence[str]]
64
+ identity_source: NotRequired[Sequence[_builtins.str]]
65
65
  """
66
66
  List of mapping expressions of the request parameters as the identity source. This indicates
67
67
  where in the request identity information is expected. Applicable for the authorizer of the
68
68
  "request" type only. Example: ["method.request.header.HeaderAuth1",
69
69
  "method.request.querystring.QueryString1"]
70
70
  """
71
- identity_validation_expression: NotRequired[str]
71
+ identity_validation_expression: NotRequired[_builtins.str]
72
72
  """
73
73
  A regular expression for validating the token as the incoming identity. It only invokes the
74
74
  authorizer's lambda if there is a match, else it will return a 401. This does not apply to
75
75
  REQUEST Lambda Authorizers. Example: "^x-[a-z]+".
76
76
  """
77
- methods_to_authorize: NotRequired[Sequence[str]]
77
+ methods_to_authorize: NotRequired[Sequence[_builtins.str]]
78
78
  """
79
79
  For method authorization, you can define resource servers and custom scopes by specifying the
80
80
  "resource-server/scope". e.g. ["com.hamuta.movies/drama.view",
@@ -82,16 +82,16 @@ if not MYPY:
82
82
  scopes visit the AWS documentation -
83
83
  https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html
84
84
  """
85
- parameter_location: NotRequired[str]
85
+ parameter_location: NotRequired[_builtins.str]
86
86
  """
87
87
  Defines where in the request API Gateway should look for identity information. The value must
88
88
  be "header" or "query". If there are multiple identity sources, the value must be "header".
89
89
  """
90
- provider_arns: NotRequired[Sequence[pulumi.Input[str]]]
90
+ provider_arns: NotRequired[Sequence[pulumi.Input[_builtins.str]]]
91
91
  """
92
92
  The ARNs of the Cognito User Pools to use.
93
93
  """
94
- type: NotRequired[str]
94
+ type: NotRequired[_builtins.str]
95
95
  """
96
96
  The type of the authorizer. This value must be one of the following:
97
97
  - "token", for an authorizer with the caller identity embedded in an authorization token
@@ -103,46 +103,46 @@ elif False:
103
103
  @pulumi.input_type
104
104
  class AuthorizerArgs:
105
105
  def __init__(__self__, *,
106
- parameter_name: str,
107
- auth_type: Optional[str] = None,
108
- authorizer_name: Optional[str] = None,
109
- authorizer_result_ttl_in_seconds: Optional[float] = None,
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,
110
110
  handler: Optional[pulumi.Input['pulumi_aws.lambda_.Function']] = None,
111
- identity_source: Optional[Sequence[str]] = None,
112
- identity_validation_expression: Optional[str] = None,
113
- methods_to_authorize: Optional[Sequence[str]] = None,
114
- parameter_location: Optional[str] = None,
115
- provider_arns: Optional[Sequence[pulumi.Input[str]]] = None,
116
- type: Optional[str] = None):
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):
117
117
  """
118
118
  LambdaAuthorizer provides the definition for a custom Authorizer for API Gateway.
119
119
 
120
- :param str parameter_name: parameterName is the name of the header or query parameter containing the authorization
120
+ :param _builtins.str parameter_name: parameterName is the name of the header or query parameter containing the authorization
121
121
  token. Must be "Unused" for multiple identity sources.
122
- :param str auth_type: Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".
123
- :param str authorizer_name: The name for the Authorizer to be referenced as. This must be unique for each unique
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
124
124
  authorizer within the API. If no name if specified, a name will be generated for you.
125
- :param float authorizer_result_ttl_in_seconds: The number of seconds during which the resulting IAM policy is cached. Default is 300s. You
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
126
126
  can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an
127
127
  authorizer across more than one route you will want to disable the cache or else it will
128
128
  cause problems for you.
129
129
  :param pulumi.Input['pulumi_aws.lambda_.Function'] handler: The authorizerHandler specifies information about the authorizing Lambda.
130
- :param Sequence[str] identity_source: List of mapping expressions of the request parameters as the identity source. This indicates
130
+ :param Sequence[_builtins.str] identity_source: List of mapping expressions of the request parameters as the identity source. This indicates
131
131
  where in the request identity information is expected. Applicable for the authorizer of the
132
132
  "request" type only. Example: ["method.request.header.HeaderAuth1",
133
133
  "method.request.querystring.QueryString1"]
134
- :param str identity_validation_expression: A regular expression for validating the token as the incoming identity. It only invokes the
134
+ :param _builtins.str identity_validation_expression: A regular expression for validating the token as the incoming identity. It only invokes the
135
135
  authorizer's lambda if there is a match, else it will return a 401. This does not apply to
136
136
  REQUEST Lambda Authorizers. Example: "^x-[a-z]+".
137
- :param Sequence[str] methods_to_authorize: For method authorization, you can define resource servers and custom scopes by specifying the
137
+ :param Sequence[_builtins.str] methods_to_authorize: For method authorization, you can define resource servers and custom scopes by specifying the
138
138
  "resource-server/scope". e.g. ["com.hamuta.movies/drama.view",
139
139
  "http://my.resource.com/file.read"] For more information on resource servers and custom
140
140
  scopes visit the AWS documentation -
141
141
  https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html
142
- :param str parameter_location: Defines where in the request API Gateway should look for identity information. The value must
142
+ :param _builtins.str parameter_location: Defines where in the request API Gateway should look for identity information. The value must
143
143
  be "header" or "query". If there are multiple identity sources, the value must be "header".
144
- :param Sequence[pulumi.Input[str]] provider_arns: The ARNs of the Cognito User Pools to use.
145
- :param str type: The type of the authorizer. This value must be one of the following:
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:
146
146
  - "token", for an authorizer with the caller identity embedded in an authorization token
147
147
  - "request", for an authorizer with the caller identity contained in request parameters
148
148
  """
@@ -168,9 +168,9 @@ class AuthorizerArgs:
168
168
  if type is not None:
169
169
  pulumi.set(__self__, "type", type)
170
170
 
171
- @property
171
+ @_builtins.property
172
172
  @pulumi.getter(name="parameterName")
173
- def parameter_name(self) -> str:
173
+ def parameter_name(self) -> _builtins.str:
174
174
  """
175
175
  parameterName is the name of the header or query parameter containing the authorization
176
176
  token. Must be "Unused" for multiple identity sources.
@@ -178,24 +178,24 @@ class AuthorizerArgs:
178
178
  return pulumi.get(self, "parameter_name")
179
179
 
180
180
  @parameter_name.setter
181
- def parameter_name(self, value: str):
181
+ def parameter_name(self, value: _builtins.str):
182
182
  pulumi.set(self, "parameter_name", value)
183
183
 
184
- @property
184
+ @_builtins.property
185
185
  @pulumi.getter(name="authType")
186
- def auth_type(self) -> Optional[str]:
186
+ def auth_type(self) -> Optional[_builtins.str]:
187
187
  """
188
188
  Specifies the authorization mechanism for the client. Typical values are "oauth2" or "custom".
189
189
  """
190
190
  return pulumi.get(self, "auth_type")
191
191
 
192
192
  @auth_type.setter
193
- def auth_type(self, value: Optional[str]):
193
+ def auth_type(self, value: Optional[_builtins.str]):
194
194
  pulumi.set(self, "auth_type", value)
195
195
 
196
- @property
196
+ @_builtins.property
197
197
  @pulumi.getter(name="authorizerName")
198
- def authorizer_name(self) -> Optional[str]:
198
+ def authorizer_name(self) -> Optional[_builtins.str]:
199
199
  """
200
200
  The name for the Authorizer to be referenced as. This must be unique for each unique
201
201
  authorizer within the API. If no name if specified, a name will be generated for you.
@@ -203,12 +203,12 @@ class AuthorizerArgs:
203
203
  return pulumi.get(self, "authorizer_name")
204
204
 
205
205
  @authorizer_name.setter
206
- def authorizer_name(self, value: Optional[str]):
206
+ def authorizer_name(self, value: Optional[_builtins.str]):
207
207
  pulumi.set(self, "authorizer_name", value)
208
208
 
209
- @property
209
+ @_builtins.property
210
210
  @pulumi.getter(name="authorizerResultTtlInSeconds")
211
- def authorizer_result_ttl_in_seconds(self) -> Optional[float]:
211
+ def authorizer_result_ttl_in_seconds(self) -> Optional[_builtins.float]:
212
212
  """
213
213
  The number of seconds during which the resulting IAM policy is cached. Default is 300s. You
214
214
  can set this value to 0 to disable caching. Max value is 3600s. Note - if you are sharing an
@@ -218,10 +218,10 @@ class AuthorizerArgs:
218
218
  return pulumi.get(self, "authorizer_result_ttl_in_seconds")
219
219
 
220
220
  @authorizer_result_ttl_in_seconds.setter
221
- def authorizer_result_ttl_in_seconds(self, value: Optional[float]):
221
+ def authorizer_result_ttl_in_seconds(self, value: Optional[_builtins.float]):
222
222
  pulumi.set(self, "authorizer_result_ttl_in_seconds", value)
223
223
 
224
- @property
224
+ @_builtins.property
225
225
  @pulumi.getter
226
226
  def handler(self) -> Optional[pulumi.Input['pulumi_aws.lambda_.Function']]:
227
227
  """
@@ -233,9 +233,9 @@ class AuthorizerArgs:
233
233
  def handler(self, value: Optional[pulumi.Input['pulumi_aws.lambda_.Function']]):
234
234
  pulumi.set(self, "handler", value)
235
235
 
236
- @property
236
+ @_builtins.property
237
237
  @pulumi.getter(name="identitySource")
238
- def identity_source(self) -> Optional[Sequence[str]]:
238
+ def identity_source(self) -> Optional[Sequence[_builtins.str]]:
239
239
  """
240
240
  List of mapping expressions of the request parameters as the identity source. This indicates
241
241
  where in the request identity information is expected. Applicable for the authorizer of the
@@ -245,12 +245,12 @@ class AuthorizerArgs:
245
245
  return pulumi.get(self, "identity_source")
246
246
 
247
247
  @identity_source.setter
248
- def identity_source(self, value: Optional[Sequence[str]]):
248
+ def identity_source(self, value: Optional[Sequence[_builtins.str]]):
249
249
  pulumi.set(self, "identity_source", value)
250
250
 
251
- @property
251
+ @_builtins.property
252
252
  @pulumi.getter(name="identityValidationExpression")
253
- def identity_validation_expression(self) -> Optional[str]:
253
+ def identity_validation_expression(self) -> Optional[_builtins.str]:
254
254
  """
255
255
  A regular expression for validating the token as the incoming identity. It only invokes the
256
256
  authorizer's lambda if there is a match, else it will return a 401. This does not apply to
@@ -259,12 +259,12 @@ class AuthorizerArgs:
259
259
  return pulumi.get(self, "identity_validation_expression")
260
260
 
261
261
  @identity_validation_expression.setter
262
- def identity_validation_expression(self, value: Optional[str]):
262
+ def identity_validation_expression(self, value: Optional[_builtins.str]):
263
263
  pulumi.set(self, "identity_validation_expression", value)
264
264
 
265
- @property
265
+ @_builtins.property
266
266
  @pulumi.getter(name="methodsToAuthorize")
267
- def methods_to_authorize(self) -> Optional[Sequence[str]]:
267
+ def methods_to_authorize(self) -> Optional[Sequence[_builtins.str]]:
268
268
  """
269
269
  For method authorization, you can define resource servers and custom scopes by specifying the
270
270
  "resource-server/scope". e.g. ["com.hamuta.movies/drama.view",
@@ -275,12 +275,12 @@ class AuthorizerArgs:
275
275
  return pulumi.get(self, "methods_to_authorize")
276
276
 
277
277
  @methods_to_authorize.setter
278
- def methods_to_authorize(self, value: Optional[Sequence[str]]):
278
+ def methods_to_authorize(self, value: Optional[Sequence[_builtins.str]]):
279
279
  pulumi.set(self, "methods_to_authorize", value)
280
280
 
281
- @property
281
+ @_builtins.property
282
282
  @pulumi.getter(name="parameterLocation")
283
- def parameter_location(self) -> Optional[str]:
283
+ def parameter_location(self) -> Optional[_builtins.str]:
284
284
  """
285
285
  Defines where in the request API Gateway should look for identity information. The value must
286
286
  be "header" or "query". If there are multiple identity sources, the value must be "header".
@@ -288,24 +288,24 @@ class AuthorizerArgs:
288
288
  return pulumi.get(self, "parameter_location")
289
289
 
290
290
  @parameter_location.setter
291
- def parameter_location(self, value: Optional[str]):
291
+ def parameter_location(self, value: Optional[_builtins.str]):
292
292
  pulumi.set(self, "parameter_location", value)
293
293
 
294
- @property
294
+ @_builtins.property
295
295
  @pulumi.getter(name="providerARNs")
296
- def provider_arns(self) -> Optional[Sequence[pulumi.Input[str]]]:
296
+ def provider_arns(self) -> Optional[Sequence[pulumi.Input[_builtins.str]]]:
297
297
  """
298
298
  The ARNs of the Cognito User Pools to use.
299
299
  """
300
300
  return pulumi.get(self, "provider_arns")
301
301
 
302
302
  @provider_arns.setter
303
- def provider_arns(self, value: Optional[Sequence[pulumi.Input[str]]]):
303
+ def provider_arns(self, value: Optional[Sequence[pulumi.Input[_builtins.str]]]):
304
304
  pulumi.set(self, "provider_arns", value)
305
305
 
306
- @property
306
+ @_builtins.property
307
307
  @pulumi.getter
308
- def type(self) -> Optional[str]:
308
+ def type(self) -> Optional[_builtins.str]:
309
309
  """
310
310
  The type of the authorizer. This value must be one of the following:
311
311
  - "token", for an authorizer with the caller identity embedded in an authorization token
@@ -314,43 +314,43 @@ class AuthorizerArgs:
314
314
  return pulumi.get(self, "type")
315
315
 
316
316
  @type.setter
317
- def type(self, value: Optional[str]):
317
+ def type(self, value: Optional[_builtins.str]):
318
318
  pulumi.set(self, "type", value)
319
319
 
320
320
 
321
321
  if not MYPY:
322
322
  class RequiredParameterArgsDict(TypedDict):
323
- in_: NotRequired[pulumi.Input[str]]
324
- name: NotRequired[pulumi.Input[str]]
323
+ in_: NotRequired[pulumi.Input[_builtins.str]]
324
+ name: NotRequired[pulumi.Input[_builtins.str]]
325
325
  elif False:
326
326
  RequiredParameterArgsDict: TypeAlias = Mapping[str, Any]
327
327
 
328
328
  @pulumi.input_type
329
329
  class RequiredParameterArgs:
330
330
  def __init__(__self__, *,
331
- in_: Optional[pulumi.Input[str]] = None,
332
- name: Optional[pulumi.Input[str]] = None):
331
+ in_: Optional[pulumi.Input[_builtins.str]] = None,
332
+ name: Optional[pulumi.Input[_builtins.str]] = None):
333
333
  if in_ is not None:
334
334
  pulumi.set(__self__, "in_", in_)
335
335
  if name is not None:
336
336
  pulumi.set(__self__, "name", name)
337
337
 
338
- @property
338
+ @_builtins.property
339
339
  @pulumi.getter(name="in")
340
- def in_(self) -> Optional[pulumi.Input[str]]:
340
+ def in_(self) -> Optional[pulumi.Input[_builtins.str]]:
341
341
  return pulumi.get(self, "in_")
342
342
 
343
343
  @in_.setter
344
- def in_(self, value: Optional[pulumi.Input[str]]):
344
+ def in_(self, value: Optional[pulumi.Input[_builtins.str]]):
345
345
  pulumi.set(self, "in_", value)
346
346
 
347
- @property
347
+ @_builtins.property
348
348
  @pulumi.getter
349
- def name(self) -> Optional[pulumi.Input[str]]:
349
+ def name(self) -> Optional[pulumi.Input[_builtins.str]]:
350
350
  return pulumi.get(self, "name")
351
351
 
352
352
  @name.setter
353
- def name(self, value: Optional[pulumi.Input[str]]):
353
+ def name(self, value: Optional[pulumi.Input[_builtins.str]]):
354
354
  pulumi.set(self, "name", value)
355
355
 
356
356
 
@@ -361,12 +361,12 @@ if not MYPY:
361
361
  have an incoming path that they match against. However, destinations are determined by the kind
362
362
  of the route.
363
363
  """
364
- path: str
364
+ path: _builtins.str
365
365
  """
366
366
  The path on the API that will serve this route. If not prefixed with `/`,
367
367
  then a `/` will be added automatically to the beginning.
368
368
  """
369
- api_key_required: NotRequired[bool]
369
+ api_key_required: NotRequired[_builtins.bool]
370
370
  """
371
371
  If true, an API key will be required for this route. The source for the API Key can be set at
372
372
  the API level and by default, the source will be the HEADER.
@@ -376,7 +376,7 @@ if not MYPY:
376
376
  Authorizers allows you to define Lambda authorizers be applied for authorization when the
377
377
  the route is called.
378
378
  """
379
- content_type: NotRequired[str]
379
+ content_type: NotRequired[_builtins.str]
380
380
  """
381
381
  The `content-type` to serve the file as. Only valid when `localPath` points to a file. If
382
382
  `localPath` points to a directory, the content types for all files will be inferred.
@@ -389,17 +389,17 @@ if not MYPY:
389
389
  """
390
390
  A Lambda function which will handle the route for the given path and method.
391
391
  """
392
- iam_auth_enabled: NotRequired[bool]
392
+ iam_auth_enabled: NotRequired[_builtins.bool]
393
393
  """
394
394
  By default, the route method auth type is set to `NONE`. If true, the auth type will be
395
395
  set to `AWS_IAM`.
396
396
  """
397
- index: NotRequired[Union[str, bool]]
397
+ index: NotRequired[Union[_builtins.str, _builtins.bool]]
398
398
  """
399
399
  By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory.
400
400
  To disable this pass `false` or supply a new index document name.
401
401
  """
402
- local_path: NotRequired[str]
402
+ local_path: NotRequired[_builtins.str]
403
403
  """
404
404
  The local path on disk to create static S3 resources for. Files will be uploaded into S3
405
405
  objects, and directories will be recursively walked into.
@@ -428,15 +428,15 @@ elif False:
428
428
  @pulumi.input_type
429
429
  class RouteArgs:
430
430
  def __init__(__self__, *,
431
- path: str,
432
- api_key_required: Optional[bool] = None,
431
+ path: _builtins.str,
432
+ api_key_required: Optional[_builtins.bool] = None,
433
433
  authorizers: Optional[Sequence['AuthorizerArgs']] = None,
434
- content_type: Optional[str] = None,
434
+ content_type: Optional[_builtins.str] = None,
435
435
  data: Optional[Any] = None,
436
436
  event_handler: Optional[pulumi.Input['pulumi_aws.lambda_.Function']] = None,
437
- iam_auth_enabled: Optional[bool] = None,
438
- index: Optional[Union[str, bool]] = None,
439
- local_path: Optional[str] = None,
437
+ iam_auth_enabled: Optional[_builtins.bool] = None,
438
+ index: Optional[Union[_builtins.str, _builtins.bool]] = None,
439
+ local_path: Optional[_builtins.str] = None,
440
440
  method: Optional['Method'] = None,
441
441
  request_validator: Optional['RequestValidator'] = None,
442
442
  required_parameters: Optional[Sequence['RequiredParameterArgs']] = None,
@@ -446,21 +446,21 @@ class RouteArgs:
446
446
  have an incoming path that they match against. However, destinations are determined by the kind
447
447
  of the route.
448
448
 
449
- :param str path: The path on the API that will serve this route. If not prefixed with `/`,
449
+ :param _builtins.str path: The path on the API that will serve this route. If not prefixed with `/`,
450
450
  then a `/` will be added automatically to the beginning.
451
- :param 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
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
452
452
  the API level and by default, the source will be the HEADER.
453
453
  :param Sequence['AuthorizerArgs'] authorizers: Authorizers allows you to define Lambda authorizers be applied for authorization when the
454
454
  the route is called.
455
- :param str content_type: The `content-type` to serve the file as. Only valid when `localPath` points to a file. If
455
+ :param _builtins.str content_type: The `content-type` to serve the file as. Only valid when `localPath` points to a file. If
456
456
  `localPath` points to a directory, the content types for all files will be inferred.
457
457
  :param Any data: A raw Swagger object to include verbatim in the integration for this path.
458
458
  :param pulumi.Input['pulumi_aws.lambda_.Function'] event_handler: A Lambda function which will handle the route for the given path and method.
459
- :param bool iam_auth_enabled: By default, the route method auth type is set to `NONE`. If true, the auth type will be
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
460
460
  set to `AWS_IAM`.
461
- :param Union[str, bool] index: By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory.
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.
462
462
  To disable this pass `false` or supply a new index document name.
463
- :param str local_path: The local path on disk to create static S3 resources for. Files will be uploaded into S3
463
+ :param _builtins.str local_path: The local path on disk to create static S3 resources for. Files will be uploaded into S3
464
464
  objects, and directories will be recursively walked into.
465
465
  :param 'Method' method: The REST method of the route to match. Only valid with `eventHandler` or `data` routes.
466
466
  :param 'RequestValidator' request_validator: Request Validator specifies the validator to use at the method level. This will override anything
@@ -495,9 +495,9 @@ class RouteArgs:
495
495
  if target is not None:
496
496
  pulumi.set(__self__, "target", target)
497
497
 
498
- @property
498
+ @_builtins.property
499
499
  @pulumi.getter
500
- def path(self) -> str:
500
+ def path(self) -> _builtins.str:
501
501
  """
502
502
  The path on the API that will serve this route. If not prefixed with `/`,
503
503
  then a `/` will be added automatically to the beginning.
@@ -505,12 +505,12 @@ class RouteArgs:
505
505
  return pulumi.get(self, "path")
506
506
 
507
507
  @path.setter
508
- def path(self, value: str):
508
+ def path(self, value: _builtins.str):
509
509
  pulumi.set(self, "path", value)
510
510
 
511
- @property
511
+ @_builtins.property
512
512
  @pulumi.getter(name="apiKeyRequired")
513
- def api_key_required(self) -> Optional[bool]:
513
+ def api_key_required(self) -> Optional[_builtins.bool]:
514
514
  """
515
515
  If true, an API key will be required for this route. The source for the API Key can be set at
516
516
  the API level and by default, the source will be the HEADER.
@@ -518,10 +518,10 @@ class RouteArgs:
518
518
  return pulumi.get(self, "api_key_required")
519
519
 
520
520
  @api_key_required.setter
521
- def api_key_required(self, value: Optional[bool]):
521
+ def api_key_required(self, value: Optional[_builtins.bool]):
522
522
  pulumi.set(self, "api_key_required", value)
523
523
 
524
- @property
524
+ @_builtins.property
525
525
  @pulumi.getter
526
526
  def authorizers(self) -> Optional[Sequence['AuthorizerArgs']]:
527
527
  """
@@ -534,9 +534,9 @@ class RouteArgs:
534
534
  def authorizers(self, value: Optional[Sequence['AuthorizerArgs']]):
535
535
  pulumi.set(self, "authorizers", value)
536
536
 
537
- @property
537
+ @_builtins.property
538
538
  @pulumi.getter(name="contentType")
539
- def content_type(self) -> Optional[str]:
539
+ def content_type(self) -> Optional[_builtins.str]:
540
540
  """
541
541
  The `content-type` to serve the file as. Only valid when `localPath` points to a file. If
542
542
  `localPath` points to a directory, the content types for all files will be inferred.
@@ -544,10 +544,10 @@ class RouteArgs:
544
544
  return pulumi.get(self, "content_type")
545
545
 
546
546
  @content_type.setter
547
- def content_type(self, value: Optional[str]):
547
+ def content_type(self, value: Optional[_builtins.str]):
548
548
  pulumi.set(self, "content_type", value)
549
549
 
550
- @property
550
+ @_builtins.property
551
551
  @pulumi.getter
552
552
  def data(self) -> Optional[Any]:
553
553
  """
@@ -559,7 +559,7 @@ class RouteArgs:
559
559
  def data(self, value: Optional[Any]):
560
560
  pulumi.set(self, "data", value)
561
561
 
562
- @property
562
+ @_builtins.property
563
563
  @pulumi.getter(name="eventHandler")
564
564
  def event_handler(self) -> Optional[pulumi.Input['pulumi_aws.lambda_.Function']]:
565
565
  """
@@ -571,9 +571,9 @@ class RouteArgs:
571
571
  def event_handler(self, value: Optional[pulumi.Input['pulumi_aws.lambda_.Function']]):
572
572
  pulumi.set(self, "event_handler", value)
573
573
 
574
- @property
574
+ @_builtins.property
575
575
  @pulumi.getter(name="iamAuthEnabled")
576
- def iam_auth_enabled(self) -> Optional[bool]:
576
+ def iam_auth_enabled(self) -> Optional[_builtins.bool]:
577
577
  """
578
578
  By default, the route method auth type is set to `NONE`. If true, the auth type will be
579
579
  set to `AWS_IAM`.
@@ -581,12 +581,12 @@ class RouteArgs:
581
581
  return pulumi.get(self, "iam_auth_enabled")
582
582
 
583
583
  @iam_auth_enabled.setter
584
- def iam_auth_enabled(self, value: Optional[bool]):
584
+ def iam_auth_enabled(self, value: Optional[_builtins.bool]):
585
585
  pulumi.set(self, "iam_auth_enabled", value)
586
586
 
587
- @property
587
+ @_builtins.property
588
588
  @pulumi.getter
589
- def index(self) -> Optional[Union[str, bool]]:
589
+ def index(self) -> Optional[Union[_builtins.str, _builtins.bool]]:
590
590
  """
591
591
  By default a `localPath` hosting static content will also serve 'index.html' in response to a request on a directory.
592
592
  To disable this pass `false` or supply a new index document name.
@@ -594,12 +594,12 @@ class RouteArgs:
594
594
  return pulumi.get(self, "index")
595
595
 
596
596
  @index.setter
597
- def index(self, value: Optional[Union[str, bool]]):
597
+ def index(self, value: Optional[Union[_builtins.str, _builtins.bool]]):
598
598
  pulumi.set(self, "index", value)
599
599
 
600
- @property
600
+ @_builtins.property
601
601
  @pulumi.getter(name="localPath")
602
- def local_path(self) -> Optional[str]:
602
+ def local_path(self) -> Optional[_builtins.str]:
603
603
  """
604
604
  The local path on disk to create static S3 resources for. Files will be uploaded into S3
605
605
  objects, and directories will be recursively walked into.
@@ -607,10 +607,10 @@ class RouteArgs:
607
607
  return pulumi.get(self, "local_path")
608
608
 
609
609
  @local_path.setter
610
- def local_path(self, value: Optional[str]):
610
+ def local_path(self, value: Optional[_builtins.str]):
611
611
  pulumi.set(self, "local_path", value)
612
612
 
613
- @property
613
+ @_builtins.property
614
614
  @pulumi.getter
615
615
  def method(self) -> Optional['Method']:
616
616
  """
@@ -622,7 +622,7 @@ class RouteArgs:
622
622
  def method(self, value: Optional['Method']):
623
623
  pulumi.set(self, "method", value)
624
624
 
625
- @property
625
+ @_builtins.property
626
626
  @pulumi.getter(name="requestValidator")
627
627
  def request_validator(self) -> Optional['RequestValidator']:
628
628
  """
@@ -635,7 +635,7 @@ class RouteArgs:
635
635
  def request_validator(self, value: Optional['RequestValidator']):
636
636
  pulumi.set(self, "request_validator", value)
637
637
 
638
- @property
638
+ @_builtins.property
639
639
  @pulumi.getter(name="requiredParameters")
640
640
  def required_parameters(self) -> Optional[Sequence['RequiredParameterArgs']]:
641
641
  """
@@ -648,7 +648,7 @@ class RouteArgs:
648
648
  def required_parameters(self, value: Optional[Sequence['RequiredParameterArgs']]):
649
649
  pulumi.set(self, "required_parameters", value)
650
650
 
651
- @property
651
+ @_builtins.property
652
652
  @pulumi.getter
653
653
  def target(self) -> Optional[pulumi.Input['TargetArgs']]:
654
654
  """
@@ -663,18 +663,18 @@ class RouteArgs:
663
663
 
664
664
  if not MYPY:
665
665
  class SwaggerGatewayResponseArgsDict(TypedDict):
666
- response_parameters: NotRequired[pulumi.Input[Mapping[str, pulumi.Input[str]]]]
667
- response_templates: NotRequired[pulumi.Input[Mapping[str, pulumi.Input[str]]]]
668
- status_code: NotRequired[pulumi.Input[float]]
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]]
669
669
  elif False:
670
670
  SwaggerGatewayResponseArgsDict: TypeAlias = Mapping[str, Any]
671
671
 
672
672
  @pulumi.input_type
673
673
  class SwaggerGatewayResponseArgs:
674
674
  def __init__(__self__, *,
675
- response_parameters: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
676
- response_templates: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
677
- status_code: Optional[pulumi.Input[float]] = None):
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):
678
678
  if response_parameters is not None:
679
679
  pulumi.set(__self__, "response_parameters", response_parameters)
680
680
  if response_templates is not None:
@@ -682,31 +682,31 @@ class SwaggerGatewayResponseArgs:
682
682
  if status_code is not None:
683
683
  pulumi.set(__self__, "status_code", status_code)
684
684
 
685
- @property
685
+ @_builtins.property
686
686
  @pulumi.getter(name="responseParameters")
687
- def response_parameters(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
687
+ def response_parameters(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
688
688
  return pulumi.get(self, "response_parameters")
689
689
 
690
690
  @response_parameters.setter
691
- def response_parameters(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
691
+ def response_parameters(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]):
692
692
  pulumi.set(self, "response_parameters", value)
693
693
 
694
- @property
694
+ @_builtins.property
695
695
  @pulumi.getter(name="responseTemplates")
696
- def response_templates(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
696
+ def response_templates(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]:
697
697
  return pulumi.get(self, "response_templates")
698
698
 
699
699
  @response_templates.setter
700
- def response_templates(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
700
+ def response_templates(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[_builtins.str]]]]):
701
701
  pulumi.set(self, "response_templates", value)
702
702
 
703
- @property
703
+ @_builtins.property
704
704
  @pulumi.getter(name="statusCode")
705
- def status_code(self) -> Optional[pulumi.Input[float]]:
705
+ def status_code(self) -> Optional[pulumi.Input[_builtins.float]]:
706
706
  return pulumi.get(self, "status_code")
707
707
 
708
708
  @status_code.setter
709
- def status_code(self, value: Optional[pulumi.Input[float]]):
709
+ def status_code(self, value: Optional[pulumi.Input[_builtins.float]]):
710
710
  pulumi.set(self, "status_code", value)
711
711
 
712
712
 
@@ -735,7 +735,7 @@ if not MYPY:
735
735
  * `mock`: for integrating the API method request with API Gateway as a "loop-back" endpoint
736
736
  without invoking any backend.
737
737
  """
738
- connection_id: NotRequired[pulumi.Input[str]]
738
+ connection_id: NotRequired[pulumi.Input[_builtins.str]]
739
739
  """
740
740
  The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
741
741
  otherwise.
@@ -746,7 +746,7 @@ if not MYPY:
746
746
  for connections through the public routable internet or `VPC_LINK` for private connections
747
747
  between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.
748
748
  """
749
- http_method: NotRequired[pulumi.Input[str]]
749
+ http_method: NotRequired[pulumi.Input[_builtins.str]]
750
750
  """
751
751
  Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.
752
752
  """
@@ -773,7 +773,7 @@ if not MYPY:
773
773
 
774
774
  Defaults to `WHEN_NO_MATCH` if unspecified.
775
775
  """
776
- uri: NotRequired[pulumi.Input[str]]
776
+ uri: NotRequired[pulumi.Input[_builtins.str]]
777
777
  """
778
778
  Specifies Uniform Resource Identifier (URI) of the integration endpoint.
779
779
 
@@ -802,11 +802,11 @@ elif False:
802
802
  class TargetArgs:
803
803
  def __init__(__self__, *,
804
804
  type: pulumi.Input['IntegrationType'],
805
- connection_id: Optional[pulumi.Input[str]] = None,
805
+ connection_id: Optional[pulumi.Input[_builtins.str]] = None,
806
806
  connection_type: Optional[pulumi.Input['IntegrationConnectionType']] = None,
807
- http_method: Optional[pulumi.Input[str]] = None,
807
+ http_method: Optional[pulumi.Input[_builtins.str]] = None,
808
808
  passthrough_behaviour: Optional[pulumi.Input['IntegrationPassthroughBehavior']] = None,
809
- uri: Optional[pulumi.Input[str]] = None):
809
+ uri: Optional[pulumi.Input[_builtins.str]] = None):
810
810
  """
811
811
  :param pulumi.Input['IntegrationType'] type: Specifies an API method integration type. The valid value is one of the following:
812
812
 
@@ -828,12 +828,12 @@ class TargetArgs:
828
828
 
829
829
  * `mock`: for integrating the API method request with API Gateway as a "loop-back" endpoint
830
830
  without invoking any backend.
831
- :param pulumi.Input[str] connection_id: The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
831
+ :param pulumi.Input[_builtins.str] connection_id: The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
832
832
  otherwise.
833
833
  :param pulumi.Input['IntegrationConnectionType'] connection_type: The type of the network connection to the integration endpoint. The valid value is `INTERNET`
834
834
  for connections through the public routable internet or `VPC_LINK` for private connections
835
835
  between API Gateway and a network load balancer in a VPC. The default value is `INTERNET`.
836
- :param pulumi.Input[str] http_method: Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.
836
+ :param pulumi.Input[_builtins.str] http_method: Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.
837
837
  :param pulumi.Input['IntegrationPassthroughBehavior'] passthrough_behaviour: Specifies how the method request body of an unmapped content type will be passed through the
838
838
  integration request to the back end without transformation.
839
839
 
@@ -854,7 +854,7 @@ class TargetArgs:
854
854
  integration request.
855
855
 
856
856
  Defaults to `WHEN_NO_MATCH` if unspecified.
857
- :param pulumi.Input[str] uri: Specifies Uniform Resource Identifier (URI) of the integration endpoint.
857
+ :param pulumi.Input[_builtins.str] uri: Specifies Uniform Resource Identifier (URI) of the integration endpoint.
858
858
 
859
859
  For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL
860
860
  according to the RFC-3986 specification, for either standard integration, where
@@ -886,7 +886,7 @@ class TargetArgs:
886
886
  if uri is not None:
887
887
  pulumi.set(__self__, "uri", uri)
888
888
 
889
- @property
889
+ @_builtins.property
890
890
  @pulumi.getter
891
891
  def type(self) -> pulumi.Input['IntegrationType']:
892
892
  """
@@ -917,9 +917,9 @@ class TargetArgs:
917
917
  def type(self, value: pulumi.Input['IntegrationType']):
918
918
  pulumi.set(self, "type", value)
919
919
 
920
- @property
920
+ @_builtins.property
921
921
  @pulumi.getter(name="connectionId")
922
- def connection_id(self) -> Optional[pulumi.Input[str]]:
922
+ def connection_id(self) -> Optional[pulumi.Input[_builtins.str]]:
923
923
  """
924
924
  The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
925
925
  otherwise.
@@ -927,10 +927,10 @@ class TargetArgs:
927
927
  return pulumi.get(self, "connection_id")
928
928
 
929
929
  @connection_id.setter
930
- def connection_id(self, value: Optional[pulumi.Input[str]]):
930
+ def connection_id(self, value: Optional[pulumi.Input[_builtins.str]]):
931
931
  pulumi.set(self, "connection_id", value)
932
932
 
933
- @property
933
+ @_builtins.property
934
934
  @pulumi.getter(name="connectionType")
935
935
  def connection_type(self) -> Optional[pulumi.Input['IntegrationConnectionType']]:
936
936
  """
@@ -944,19 +944,19 @@ class TargetArgs:
944
944
  def connection_type(self, value: Optional[pulumi.Input['IntegrationConnectionType']]):
945
945
  pulumi.set(self, "connection_type", value)
946
946
 
947
- @property
947
+ @_builtins.property
948
948
  @pulumi.getter(name="httpMethod")
949
- def http_method(self) -> Optional[pulumi.Input[str]]:
949
+ def http_method(self) -> Optional[pulumi.Input[_builtins.str]]:
950
950
  """
951
951
  Specifies the integration's HTTP method type. Currently, the only supported type is 'ANY'.
952
952
  """
953
953
  return pulumi.get(self, "http_method")
954
954
 
955
955
  @http_method.setter
956
- def http_method(self, value: Optional[pulumi.Input[str]]):
956
+ def http_method(self, value: Optional[pulumi.Input[_builtins.str]]):
957
957
  pulumi.set(self, "http_method", value)
958
958
 
959
- @property
959
+ @_builtins.property
960
960
  @pulumi.getter(name="passthroughBehaviour")
961
961
  def passthrough_behaviour(self) -> Optional[pulumi.Input['IntegrationPassthroughBehavior']]:
962
962
  """
@@ -987,9 +987,9 @@ class TargetArgs:
987
987
  def passthrough_behaviour(self, value: Optional[pulumi.Input['IntegrationPassthroughBehavior']]):
988
988
  pulumi.set(self, "passthrough_behaviour", value)
989
989
 
990
- @property
990
+ @_builtins.property
991
991
  @pulumi.getter
992
- def uri(self) -> Optional[pulumi.Input[str]]:
992
+ def uri(self) -> Optional[pulumi.Input[_builtins.str]]:
993
993
  """
994
994
  Specifies Uniform Resource Identifier (URI) of the integration endpoint.
995
995
 
@@ -1014,7 +1014,7 @@ class TargetArgs:
1014
1014
  return pulumi.get(self, "uri")
1015
1015
 
1016
1016
  @uri.setter
1017
- def uri(self, value: Optional[pulumi.Input[str]]):
1017
+ def uri(self, value: Optional[pulumi.Input[_builtins.str]]):
1018
1018
  pulumi.set(self, "uri", value)
1019
1019
 
1020
1020