-
Notifications
You must be signed in to change notification settings - Fork 17
/
awsapigatewayv2_HttpRoute.go
469 lines (415 loc) · 11.6 KB
/
awsapigatewayv2_HttpRoute.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
package awsapigatewayv2
import (
_init_ "github.com/aws/aws-cdk-go/awscdk/jsii"
_jsii_ "github.com/aws/jsii-runtime-go/runtime"
"github.com/aws/aws-cdk-go/awscdk"
"github.com/aws/aws-cdk-go/awscdk/awsapigatewayv2/internal"
"github.com/aws/aws-cdk-go/awscdk/awsiam"
"github.com/aws/constructs-go/constructs/v3"
)
// Route class that creates the Route for API Gateway HTTP API.
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import "github.com/aws/aws-cdk-go/awscdk"
//
// var httpApi httpApi
// var httpRouteAuthorizer iHttpRouteAuthorizer
// var httpRouteIntegration httpRouteIntegration
// var httpRouteKey httpRouteKey
//
// httpRoute := awscdk.Aws_apigatewayv2.NewHttpRoute(this, jsii.String("MyHttpRoute"), &httpRouteProps{
// httpApi: httpApi,
// integration: httpRouteIntegration,
// routeKey: httpRouteKey,
//
// // the properties below are optional
// authorizationScopes: []*string{
// jsii.String("authorizationScopes"),
// },
// authorizer: httpRouteAuthorizer,
// })
//
// Experimental.
type HttpRoute interface {
awscdk.Resource
IHttpRoute
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
// Experimental.
Env() *awscdk.ResourceEnvironment
// The HTTP API associated with this route.
// Experimental.
HttpApi() IHttpApi
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Returns the path component of this HTTP route, `undefined` if the path is the catch-all route.
// Experimental.
Path() *string
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
// Experimental.
PhysicalName() *string
// Returns the arn of the route.
// Experimental.
RouteArn() *string
// Id of the Route.
// Experimental.
RouteId() *string
// The stack in which this resource is defined.
// Experimental.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Experimental.
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
// Experimental.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
// Experimental.
GetResourceNameAttribute(nameAttr *string) *string
// Grant access to invoke the route.
//
// This method requires that the authorizer of the route is undefined or is
// an `HttpIamAuthorizer`.
// Experimental.
GrantInvoke(grantee awsiam.IGrantable, options *GrantInvokeOptions) awsiam.Grant
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
}
// The jsii proxy struct for HttpRoute
type jsiiProxy_HttpRoute struct {
internal.Type__awscdkResource
jsiiProxy_IHttpRoute
}
func (j *jsiiProxy_HttpRoute) Env() *awscdk.ResourceEnvironment {
var returns *awscdk.ResourceEnvironment
_jsii_.Get(
j,
"env",
&returns,
)
return returns
}
func (j *jsiiProxy_HttpRoute) HttpApi() IHttpApi {
var returns IHttpApi
_jsii_.Get(
j,
"httpApi",
&returns,
)
return returns
}
func (j *jsiiProxy_HttpRoute) Node() awscdk.ConstructNode {
var returns awscdk.ConstructNode
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_HttpRoute) Path() *string {
var returns *string
_jsii_.Get(
j,
"path",
&returns,
)
return returns
}
func (j *jsiiProxy_HttpRoute) PhysicalName() *string {
var returns *string
_jsii_.Get(
j,
"physicalName",
&returns,
)
return returns
}
func (j *jsiiProxy_HttpRoute) RouteArn() *string {
var returns *string
_jsii_.Get(
j,
"routeArn",
&returns,
)
return returns
}
func (j *jsiiProxy_HttpRoute) RouteId() *string {
var returns *string
_jsii_.Get(
j,
"routeId",
&returns,
)
return returns
}
func (j *jsiiProxy_HttpRoute) Stack() awscdk.Stack {
var returns awscdk.Stack
_jsii_.Get(
j,
"stack",
&returns,
)
return returns
}
// Experimental.
func NewHttpRoute(scope constructs.Construct, id *string, props *HttpRouteProps) HttpRoute {
_init_.Initialize()
if err := validateNewHttpRouteParameters(scope, id, props); err != nil {
panic(err)
}
j := jsiiProxy_HttpRoute{}
_jsii_.Create(
"monocdk.aws_apigatewayv2.HttpRoute",
[]interface{}{scope, id, props},
&j,
)
return &j
}
// Experimental.
func NewHttpRoute_Override(h HttpRoute, scope constructs.Construct, id *string, props *HttpRouteProps) {
_init_.Initialize()
_jsii_.Create(
"monocdk.aws_apigatewayv2.HttpRoute",
[]interface{}{scope, id, props},
h,
)
}
// Return whether the given object is a Construct.
// Experimental.
func HttpRoute_IsConstruct(x interface{}) *bool {
_init_.Initialize()
if err := validateHttpRoute_IsConstructParameters(x); err != nil {
panic(err)
}
var returns *bool
_jsii_.StaticInvoke(
"monocdk.aws_apigatewayv2.HttpRoute",
"isConstruct",
[]interface{}{x},
&returns,
)
return returns
}
// Check whether the given construct is a Resource.
// Experimental.
func HttpRoute_IsResource(construct awscdk.IConstruct) *bool {
_init_.Initialize()
if err := validateHttpRoute_IsResourceParameters(construct); err != nil {
panic(err)
}
var returns *bool
_jsii_.StaticInvoke(
"monocdk.aws_apigatewayv2.HttpRoute",
"isResource",
[]interface{}{construct},
&returns,
)
return returns
}
func (h *jsiiProxy_HttpRoute) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) {
if err := h.validateApplyRemovalPolicyParameters(policy); err != nil {
panic(err)
}
_jsii_.InvokeVoid(
h,
"applyRemovalPolicy",
[]interface{}{policy},
)
}
func (h *jsiiProxy_HttpRoute) GeneratePhysicalName() *string {
var returns *string
_jsii_.Invoke(
h,
"generatePhysicalName",
nil, // no parameters
&returns,
)
return returns
}
func (h *jsiiProxy_HttpRoute) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string {
if err := h.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil {
panic(err)
}
var returns *string
_jsii_.Invoke(
h,
"getResourceArnAttribute",
[]interface{}{arnAttr, arnComponents},
&returns,
)
return returns
}
func (h *jsiiProxy_HttpRoute) GetResourceNameAttribute(nameAttr *string) *string {
if err := h.validateGetResourceNameAttributeParameters(nameAttr); err != nil {
panic(err)
}
var returns *string
_jsii_.Invoke(
h,
"getResourceNameAttribute",
[]interface{}{nameAttr},
&returns,
)
return returns
}
func (h *jsiiProxy_HttpRoute) GrantInvoke(grantee awsiam.IGrantable, options *GrantInvokeOptions) awsiam.Grant {
if err := h.validateGrantInvokeParameters(grantee, options); err != nil {
panic(err)
}
var returns awsiam.Grant
_jsii_.Invoke(
h,
"grantInvoke",
[]interface{}{grantee, options},
&returns,
)
return returns
}
func (h *jsiiProxy_HttpRoute) OnPrepare() {
_jsii_.InvokeVoid(
h,
"onPrepare",
nil, // no parameters
)
}
func (h *jsiiProxy_HttpRoute) OnSynthesize(session constructs.ISynthesisSession) {
if err := h.validateOnSynthesizeParameters(session); err != nil {
panic(err)
}
_jsii_.InvokeVoid(
h,
"onSynthesize",
[]interface{}{session},
)
}
func (h *jsiiProxy_HttpRoute) OnValidate() *[]*string {
var returns *[]*string
_jsii_.Invoke(
h,
"onValidate",
nil, // no parameters
&returns,
)
return returns
}
func (h *jsiiProxy_HttpRoute) Prepare() {
_jsii_.InvokeVoid(
h,
"prepare",
nil, // no parameters
)
}
func (h *jsiiProxy_HttpRoute) Synthesize(session awscdk.ISynthesisSession) {
if err := h.validateSynthesizeParameters(session); err != nil {
panic(err)
}
_jsii_.InvokeVoid(
h,
"synthesize",
[]interface{}{session},
)
}
func (h *jsiiProxy_HttpRoute) ToString() *string {
var returns *string
_jsii_.Invoke(
h,
"toString",
nil, // no parameters
&returns,
)
return returns
}
func (h *jsiiProxy_HttpRoute) Validate() *[]*string {
var returns *[]*string
_jsii_.Invoke(
h,
"validate",
nil, // no parameters
&returns,
)
return returns
}