/
awsevents.go
8825 lines (8013 loc) · 269 KB
/
awsevents.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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package awsevents
import (
_init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii"
_jsii_ "github.com/aws/jsii-runtime-go/runtime"
"github.com/aws/aws-cdk-go/awscdk/v2"
"github.com/aws/aws-cdk-go/awscdk/v2/awsevents/internal"
"github.com/aws/aws-cdk-go/awscdk/v2/awsiam"
"github.com/aws/constructs-go/constructs/v10"
)
// Define an EventBridge Api Destination.
//
// Example:
// connection := events.NewConnection(this, jsii.String("Connection"), &connectionProps{
// authorization: events.authorization.apiKey(jsii.String("x-api-key"), secretValue.secretsManager(jsii.String("ApiSecretName"))),
// description: jsii.String("Connection with API Key x-api-key"),
// })
//
// destination := events.NewApiDestination(this, jsii.String("Destination"), &apiDestinationProps{
// connection: connection,
// endpoint: jsii.String("https://example.com"),
// description: jsii.String("Calling example.com with API key x-api-key"),
// })
//
// rule := events.NewRule(this, jsii.String("Rule"), &ruleProps{
// schedule: events.schedule.rate(cdk.duration.minutes(jsii.Number(1))),
// targets: []iRuleTarget{
// targets.NewApiDestination(destination),
// },
// })
//
type ApiDestination interface {
awscdk.Resource
IApiDestination
// The ARN of the Api Destination created.
ApiDestinationArn() *string
// The Name of the Api Destination created.
ApiDestinationName() *string
// The Connection to associate with Api Destination.
Connection() IConnection
// 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.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// 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.
PhysicalName() *string
// The stack in which this resource is defined.
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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
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`.
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.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
// The jsii proxy struct for ApiDestination
type jsiiProxy_ApiDestination struct {
internal.Type__awscdkResource
jsiiProxy_IApiDestination
}
func (j *jsiiProxy_ApiDestination) ApiDestinationArn() *string {
var returns *string
_jsii_.Get(
j,
"apiDestinationArn",
&returns,
)
return returns
}
func (j *jsiiProxy_ApiDestination) ApiDestinationName() *string {
var returns *string
_jsii_.Get(
j,
"apiDestinationName",
&returns,
)
return returns
}
func (j *jsiiProxy_ApiDestination) Connection() IConnection {
var returns IConnection
_jsii_.Get(
j,
"connection",
&returns,
)
return returns
}
func (j *jsiiProxy_ApiDestination) Env() *awscdk.ResourceEnvironment {
var returns *awscdk.ResourceEnvironment
_jsii_.Get(
j,
"env",
&returns,
)
return returns
}
func (j *jsiiProxy_ApiDestination) Node() constructs.Node {
var returns constructs.Node
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_ApiDestination) PhysicalName() *string {
var returns *string
_jsii_.Get(
j,
"physicalName",
&returns,
)
return returns
}
func (j *jsiiProxy_ApiDestination) Stack() awscdk.Stack {
var returns awscdk.Stack
_jsii_.Get(
j,
"stack",
&returns,
)
return returns
}
func NewApiDestination(scope constructs.Construct, id *string, props *ApiDestinationProps) ApiDestination {
_init_.Initialize()
j := jsiiProxy_ApiDestination{}
_jsii_.Create(
"aws-cdk-lib.aws_events.ApiDestination",
[]interface{}{scope, id, props},
&j,
)
return &j
}
func NewApiDestination_Override(a ApiDestination, scope constructs.Construct, id *string, props *ApiDestinationProps) {
_init_.Initialize()
_jsii_.Create(
"aws-cdk-lib.aws_events.ApiDestination",
[]interface{}{scope, id, props},
a,
)
}
// Checks if `x` is a construct.
//
// Returns: true if `x` is an object created from a class which extends `Construct`.
// Deprecated: use `x instanceof Construct` instead.
func ApiDestination_IsConstruct(x interface{}) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_events.ApiDestination",
"isConstruct",
[]interface{}{x},
&returns,
)
return returns
}
// Check whether the given construct is a Resource.
func ApiDestination_IsResource(construct constructs.IConstruct) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_events.ApiDestination",
"isResource",
[]interface{}{construct},
&returns,
)
return returns
}
func (a *jsiiProxy_ApiDestination) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) {
_jsii_.InvokeVoid(
a,
"applyRemovalPolicy",
[]interface{}{policy},
)
}
func (a *jsiiProxy_ApiDestination) GeneratePhysicalName() *string {
var returns *string
_jsii_.Invoke(
a,
"generatePhysicalName",
nil, // no parameters
&returns,
)
return returns
}
func (a *jsiiProxy_ApiDestination) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string {
var returns *string
_jsii_.Invoke(
a,
"getResourceArnAttribute",
[]interface{}{arnAttr, arnComponents},
&returns,
)
return returns
}
func (a *jsiiProxy_ApiDestination) GetResourceNameAttribute(nameAttr *string) *string {
var returns *string
_jsii_.Invoke(
a,
"getResourceNameAttribute",
[]interface{}{nameAttr},
&returns,
)
return returns
}
func (a *jsiiProxy_ApiDestination) ToString() *string {
var returns *string
_jsii_.Invoke(
a,
"toString",
nil, // no parameters
&returns,
)
return returns
}
// The event API Destination properties.
//
// Example:
// connection := events.NewConnection(this, jsii.String("Connection"), &connectionProps{
// authorization: events.authorization.apiKey(jsii.String("x-api-key"), secretValue.secretsManager(jsii.String("ApiSecretName"))),
// description: jsii.String("Connection with API Key x-api-key"),
// })
//
// destination := events.NewApiDestination(this, jsii.String("Destination"), &apiDestinationProps{
// connection: connection,
// endpoint: jsii.String("https://example.com"),
// description: jsii.String("Calling example.com with API key x-api-key"),
// })
//
// rule := events.NewRule(this, jsii.String("Rule"), &ruleProps{
// schedule: events.schedule.rate(cdk.duration.minutes(jsii.Number(1))),
// targets: []iRuleTarget{
// targets.NewApiDestination(destination),
// },
// })
//
type ApiDestinationProps struct {
// The ARN of the connection to use for the API destination.
Connection IConnection `json:"connection" yaml:"connection"`
// The URL to the HTTP invocation endpoint for the API destination..
Endpoint *string `json:"endpoint" yaml:"endpoint"`
// The name for the API destination.
ApiDestinationName *string `json:"apiDestinationName" yaml:"apiDestinationName"`
// A description for the API destination.
Description *string `json:"description" yaml:"description"`
// The method to use for the request to the HTTP invocation endpoint.
HttpMethod HttpMethod `json:"httpMethod" yaml:"httpMethod"`
// The maximum number of requests per second to send to the HTTP invocation endpoint.
RateLimitPerSecond *float64 `json:"rateLimitPerSecond" yaml:"rateLimitPerSecond"`
}
// Define an EventBridge Archive.
//
// Example:
// import cdk "github.com/aws/aws-cdk-go/awscdk"import awscdk "github.com/aws/aws-cdk-go/awscdk"import events "github.com/aws/aws-cdk-go/awscdk/aws_events"
//
// var detail interface{}
// var eventBus eventBus
// archive := events.NewArchive(this, jsii.String("MyArchive"), &archiveProps{
// eventPattern: &eventPattern{
// account: []*string{
// jsii.String("account"),
// },
// detail: map[string]interface{}{
// "detailKey": detail,
// },
// detailType: []*string{
// jsii.String("detailType"),
// },
// id: []*string{
// jsii.String("id"),
// },
// region: []*string{
// jsii.String("region"),
// },
// resources: []*string{
// jsii.String("resources"),
// },
// source: []*string{
// jsii.String("source"),
// },
// time: []*string{
// jsii.String("time"),
// },
// version: []*string{
// jsii.String("version"),
// },
// },
// sourceEventBus: eventBus,
//
// // the properties below are optional
// archiveName: jsii.String("archiveName"),
// description: jsii.String("description"),
// retention: cdk.duration.minutes(jsii.Number(30)),
// })
//
type Archive interface {
awscdk.Resource
// The ARN of the archive created.
ArchiveArn() *string
// The archive name.
ArchiveName() *string
// 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.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// 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.
PhysicalName() *string
// The stack in which this resource is defined.
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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
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`.
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.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
// The jsii proxy struct for Archive
type jsiiProxy_Archive struct {
internal.Type__awscdkResource
}
func (j *jsiiProxy_Archive) ArchiveArn() *string {
var returns *string
_jsii_.Get(
j,
"archiveArn",
&returns,
)
return returns
}
func (j *jsiiProxy_Archive) ArchiveName() *string {
var returns *string
_jsii_.Get(
j,
"archiveName",
&returns,
)
return returns
}
func (j *jsiiProxy_Archive) Env() *awscdk.ResourceEnvironment {
var returns *awscdk.ResourceEnvironment
_jsii_.Get(
j,
"env",
&returns,
)
return returns
}
func (j *jsiiProxy_Archive) Node() constructs.Node {
var returns constructs.Node
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_Archive) PhysicalName() *string {
var returns *string
_jsii_.Get(
j,
"physicalName",
&returns,
)
return returns
}
func (j *jsiiProxy_Archive) Stack() awscdk.Stack {
var returns awscdk.Stack
_jsii_.Get(
j,
"stack",
&returns,
)
return returns
}
func NewArchive(scope constructs.Construct, id *string, props *ArchiveProps) Archive {
_init_.Initialize()
j := jsiiProxy_Archive{}
_jsii_.Create(
"aws-cdk-lib.aws_events.Archive",
[]interface{}{scope, id, props},
&j,
)
return &j
}
func NewArchive_Override(a Archive, scope constructs.Construct, id *string, props *ArchiveProps) {
_init_.Initialize()
_jsii_.Create(
"aws-cdk-lib.aws_events.Archive",
[]interface{}{scope, id, props},
a,
)
}
// Checks if `x` is a construct.
//
// Returns: true if `x` is an object created from a class which extends `Construct`.
// Deprecated: use `x instanceof Construct` instead.
func Archive_IsConstruct(x interface{}) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_events.Archive",
"isConstruct",
[]interface{}{x},
&returns,
)
return returns
}
// Check whether the given construct is a Resource.
func Archive_IsResource(construct constructs.IConstruct) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_events.Archive",
"isResource",
[]interface{}{construct},
&returns,
)
return returns
}
func (a *jsiiProxy_Archive) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) {
_jsii_.InvokeVoid(
a,
"applyRemovalPolicy",
[]interface{}{policy},
)
}
func (a *jsiiProxy_Archive) GeneratePhysicalName() *string {
var returns *string
_jsii_.Invoke(
a,
"generatePhysicalName",
nil, // no parameters
&returns,
)
return returns
}
func (a *jsiiProxy_Archive) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string {
var returns *string
_jsii_.Invoke(
a,
"getResourceArnAttribute",
[]interface{}{arnAttr, arnComponents},
&returns,
)
return returns
}
func (a *jsiiProxy_Archive) GetResourceNameAttribute(nameAttr *string) *string {
var returns *string
_jsii_.Invoke(
a,
"getResourceNameAttribute",
[]interface{}{nameAttr},
&returns,
)
return returns
}
func (a *jsiiProxy_Archive) ToString() *string {
var returns *string
_jsii_.Invoke(
a,
"toString",
nil, // no parameters
&returns,
)
return returns
}
// The event archive properties.
//
// Example:
// import cdk "github.com/aws/aws-cdk-go/awscdk"import awscdk "github.com/aws/aws-cdk-go/awscdk"import events "github.com/aws/aws-cdk-go/awscdk/aws_events"
//
// var detail interface{}
// var eventBus eventBus
// archiveProps := &archiveProps{
// eventPattern: &eventPattern{
// account: []*string{
// jsii.String("account"),
// },
// detail: map[string]interface{}{
// "detailKey": detail,
// },
// detailType: []*string{
// jsii.String("detailType"),
// },
// id: []*string{
// jsii.String("id"),
// },
// region: []*string{
// jsii.String("region"),
// },
// resources: []*string{
// jsii.String("resources"),
// },
// source: []*string{
// jsii.String("source"),
// },
// time: []*string{
// jsii.String("time"),
// },
// version: []*string{
// jsii.String("version"),
// },
// },
// sourceEventBus: eventBus,
//
// // the properties below are optional
// archiveName: jsii.String("archiveName"),
// description: jsii.String("description"),
// retention: cdk.duration.minutes(jsii.Number(30)),
// }
//
type ArchiveProps struct {
// An event pattern to use to filter events sent to the archive.
EventPattern *EventPattern `json:"eventPattern" yaml:"eventPattern"`
// The name of the archive.
ArchiveName *string `json:"archiveName" yaml:"archiveName"`
// A description for the archive.
Description *string `json:"description" yaml:"description"`
// The number of days to retain events for.
//
// Default value is 0. If set to 0, events are retained indefinitely.
Retention awscdk.Duration `json:"retention" yaml:"retention"`
// The event source associated with the archive.
SourceEventBus IEventBus `json:"sourceEventBus" yaml:"sourceEventBus"`
}
// Authorization type for an API Destination Connection.
//
// Example:
// connection := events.NewConnection(this, jsii.String("Connection"), &connectionProps{
// authorization: events.authorization.apiKey(jsii.String("x-api-key"), secretValue.secretsManager(jsii.String("ApiSecretName"))),
// description: jsii.String("Connection with API Key x-api-key"),
// })
//
// destination := events.NewApiDestination(this, jsii.String("Destination"), &apiDestinationProps{
// connection: connection,
// endpoint: jsii.String("https://example.com"),
// description: jsii.String("Calling example.com with API key x-api-key"),
// })
//
// rule := events.NewRule(this, jsii.String("Rule"), &ruleProps{
// schedule: events.schedule.rate(cdk.duration.minutes(jsii.Number(1))),
// targets: []iRuleTarget{
// targets.NewApiDestination(destination),
// },
// })
//
type Authorization interface {
}
// The jsii proxy struct for Authorization
type jsiiProxy_Authorization struct {
_ byte // padding
}
func NewAuthorization_Override(a Authorization) {
_init_.Initialize()
_jsii_.Create(
"aws-cdk-lib.aws_events.Authorization",
nil, // no parameters
a,
)
}
// Use API key authorization.
//
// API key authorization has two components: an API key name and an API key value.
// What these are depends on the target of your connection.
func Authorization_ApiKey(apiKeyName *string, apiKeyValue awscdk.SecretValue) Authorization {
_init_.Initialize()
var returns Authorization
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_events.Authorization",
"apiKey",
[]interface{}{apiKeyName, apiKeyValue},
&returns,
)
return returns
}
// Use username and password authorization.
func Authorization_Basic(username *string, password awscdk.SecretValue) Authorization {
_init_.Initialize()
var returns Authorization
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_events.Authorization",
"basic",
[]interface{}{username, password},
&returns,
)
return returns
}
// Use OAuth authorization.
func Authorization_Oauth(props *OAuthAuthorizationProps) Authorization {
_init_.Initialize()
var returns Authorization
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_events.Authorization",
"oauth",
[]interface{}{props},
&returns,
)
return returns
}
// The event archive base properties.
//
// Example:
// bus := events.NewEventBus(this, jsii.String("bus"), &eventBusProps{
// eventBusName: jsii.String("MyCustomEventBus"),
// })
//
// bus.archive(jsii.String("MyArchive"), &baseArchiveProps{
// archiveName: jsii.String("MyCustomEventBusArchive"),
// description: jsii.String("MyCustomerEventBus Archive"),
// eventPattern: &eventPattern{
// account: []*string{
// *stack.of(this).account,
// },
// },
// retention: duration.days(jsii.Number(365)),
// })
//
type BaseArchiveProps struct {
// An event pattern to use to filter events sent to the archive.
EventPattern *EventPattern `json:"eventPattern" yaml:"eventPattern"`
// The name of the archive.
ArchiveName *string `json:"archiveName" yaml:"archiveName"`
// A description for the archive.
Description *string `json:"description" yaml:"description"`
// The number of days to retain events for.
//
// Default value is 0. If set to 0, events are retained indefinitely.
Retention awscdk.Duration `json:"retention" yaml:"retention"`
}
// A CloudFormation `AWS::Events::ApiDestination`.
//
// Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
//
// When using ApiDesinations with OAuth authentication we recommend these best practices:
//
// - Create a secret in Secrets Manager with your OAuth credentials.
// - Reference that secret in your CloudFormation template for `AWS::Events::Connection` using CloudFormation dynamic reference syntax. For more information, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) .
//
// When the Connection resource is created the secret will be passed to EventBridge and stored in the customer account using “Service Linked Secrets,” effectively creating two secrets. This will minimize the cost because the original secret is only accessed when a CloudFormation template is created or updated, not every time an event is sent to the ApiDestination. The secret stored in the customer account by EventBridge is the one used for each event sent to the ApiDestination and AWS is responsible for the fees.
//
// > The secret stored in the customer account by EventBridge can’t be updated directly, only when a CloudFormation template is updated.
//
// For examples of CloudFormation templates that use secrets, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#aws-resource-events-connection--examples) .
//
// Example:
// import awscdk "github.com/aws/aws-cdk-go/awscdk"import events "github.com/aws/aws-cdk-go/awscdk/aws_events"
// cfnApiDestination := events.NewCfnApiDestination(this, jsii.String("MyCfnApiDestination"), &cfnApiDestinationProps{
// connectionArn: jsii.String("connectionArn"),
// httpMethod: jsii.String("httpMethod"),
// invocationEndpoint: jsii.String("invocationEndpoint"),
//
// // the properties below are optional
// description: jsii.String("description"),
// invocationRateLimitPerSecond: jsii.Number(123),
// name: jsii.String("name"),
// })
//
type CfnApiDestination interface {
awscdk.CfnResource
awscdk.IInspectable
// The ARN of the API destination that was created by the request.
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The ARN of the connection to use for the API destination.
//
// The destination endpoint must support the authorization type specified for the connection.
ConnectionArn() *string
SetConnectionArn(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// A description for the API destination to create.
Description() *string
SetDescription(val *string)
// The method to use for the request to the HTTP invocation endpoint.
HttpMethod() *string
SetHttpMethod(val *string)
// The URL to the HTTP invocation endpoint for the API destination.
InvocationEndpoint() *string
SetInvocationEndpoint(val *string)
// The maximum number of requests per second to send to the HTTP invocation endpoint.
InvocationRateLimitPerSecond() *float64
SetInvocationRateLimitPerSecond(val *float64)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name for the API destination to create.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// ```typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// ```
// would add the overrides
// ```json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// ```
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
// The jsii proxy struct for CfnApiDestination
type jsiiProxy_CfnApiDestination struct {
internal.Type__awscdkCfnResource
internal.Type__awscdkIInspectable
}
func (j *jsiiProxy_CfnApiDestination) AttrArn() *string {
var returns *string
_jsii_.Get(
j,
"attrArn",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnApiDestination) CfnOptions() awscdk.ICfnResourceOptions {
var returns awscdk.ICfnResourceOptions