-
Notifications
You must be signed in to change notification settings - Fork 17
/
awssns.go
4792 lines (4244 loc) · 140 KB
/
awssns.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 awssns
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/awscloudwatch"
"github.com/aws/aws-cdk-go/awscdk/v2/awscodestarnotifications"
"github.com/aws/aws-cdk-go/awscdk/v2/awsiam"
"github.com/aws/aws-cdk-go/awscdk/v2/awskms"
"github.com/aws/aws-cdk-go/awscdk/v2/awssns/internal"
"github.com/aws/aws-cdk-go/awscdk/v2/awssqs"
"github.com/aws/constructs-go/constructs/v10"
)
// Between condition for a numeric attribute.
//
// Example:
// import lambda "github.com/aws/aws-cdk-go/awscdk"
// var fn function
//
//
// myTopic := sns.NewTopic(this, jsii.String("MyTopic"))
//
// // Lambda should receive only message matching the following conditions on attributes:
// // color: 'red' or 'orange' or begins with 'bl'
// // size: anything but 'small' or 'medium'
// // price: between 100 and 200 or greater than 300
// // store: attribute must be present
// myTopic.addSubscription(subscriptions.NewLambdaSubscription(fn, &lambdaSubscriptionProps{
// filterPolicy: map[string]subscriptionFilter{
// "color": sns.*subscriptionFilter.stringFilter(&StringConditions{
// "allowlist": []*string{
// jsii.String("red"),
// jsii.String("orange"),
// },
// "matchPrefixes": []*string{
// jsii.String("bl"),
// },
// }),
// "size": sns.*subscriptionFilter.stringFilter(&StringConditions{
// "denylist": []*string{
// jsii.String("small"),
// jsii.String("medium"),
// },
// }),
// "price": sns.*subscriptionFilter.numericFilter(&NumericConditions{
// "between": &BetweenCondition{
// "start": jsii.Number(100),
// "stop": jsii.Number(200),
// },
// "greaterThan": jsii.Number(300),
// }),
// "store": sns.*subscriptionFilter.existsFilter(),
// },
// }))
//
type BetweenCondition struct {
// The start value.
Start *float64 `field:"required" json:"start" yaml:"start"`
// The stop value.
Stop *float64 `field:"required" json:"stop" yaml:"stop"`
}
// A CloudFormation `AWS::SNS::Subscription`.
//
// The `AWS::SNS::Subscription` resource subscribes an endpoint to an Amazon SNS topic. For a subscription to be created, the owner of the endpoint must confirm the subscription.
//
// 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 deliveryPolicy interface{}
// var filterPolicy interface{}
// var redrivePolicy interface{}
//
// cfnSubscription := awscdk.Aws_sns.NewCfnSubscription(this, jsii.String("MyCfnSubscription"), &cfnSubscriptionProps{
// protocol: jsii.String("protocol"),
// topicArn: jsii.String("topicArn"),
//
// // the properties below are optional
// deliveryPolicy: deliveryPolicy,
// endpoint: jsii.String("endpoint"),
// filterPolicy: filterPolicy,
// rawMessageDelivery: jsii.Boolean(false),
// redrivePolicy: redrivePolicy,
// region: jsii.String("region"),
// subscriptionRoleArn: jsii.String("subscriptionRoleArn"),
// })
//
type CfnSubscription interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *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
// The delivery policy JSON assigned to the subscription.
//
// Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* and [Message delivery retries](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) in the *Amazon SNS Developer Guide* .
DeliveryPolicy() interface{}
SetDeliveryPolicy(val interface{})
// The subscription's endpoint.
//
// The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
Endpoint() *string
SetEndpoint(val *string)
// The filter policy JSON assigned to the subscription.
//
// Enables the subscriber to filter out unwanted messages. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* and [Message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon SNS Developer Guide* .
FilterPolicy() interface{}
SetFilterPolicy(val interface{})
// 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 tree node.
Node() constructs.Node
// The subscription's protocol.
//
// For more information, see the `Protocol` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
Protocol() *string
SetProtocol(val *string)
// When set to `true` , enables raw message delivery.
//
// Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* .
RawMessageDelivery() interface{}
SetRawMessageDelivery(val interface{})
// When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
//
// Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
//
// For more information about the redrive policy and dead-letter queues, see [Amazon SQS dead-letter queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the *Amazon SQS Developer Guide* .
RedrivePolicy() interface{}
SetRedrivePolicy(val interface{})
// 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
// For cross-region subscriptions, the region in which the topic resides.
//
// If no region is specified, AWS CloudFormation uses the region of the caller as the default.
//
// If you perform an update operation that only updates the `Region` property of a `AWS::SNS::Subscription` resource, that operation will fail unless you are either:
//
// - Updating the `Region` from `NULL` to the caller region.
// - Updating the `Region` from the caller region to `NULL` .
Region() *string
SetRegion(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions.
//
// Specify the ARN of the IAM role that has the following:
//
// - Permission to write to the Amazon Kinesis Data Firehose delivery stream
// - Amazon SNS listed as a trusted entity
//
// Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see [Fanout to Amazon Kinesis Data Firehose delivery streams](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the *Amazon SNS Developer Guide.*
SubscriptionRoleArn() *string
SetSubscriptionRoleArn(val *string)
// The ARN of the topic to subscribe to.
TopicArn() *string
SetTopicArn(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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 CfnSubscription
type jsiiProxy_CfnSubscription struct {
internal.Type__awscdkCfnResource
internal.Type__awscdkIInspectable
}
func (j *jsiiProxy_CfnSubscription) CfnOptions() awscdk.ICfnResourceOptions {
var returns awscdk.ICfnResourceOptions
_jsii_.Get(
j,
"cfnOptions",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) CfnProperties() *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Get(
j,
"cfnProperties",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) CfnResourceType() *string {
var returns *string
_jsii_.Get(
j,
"cfnResourceType",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) CreationStack() *[]*string {
var returns *[]*string
_jsii_.Get(
j,
"creationStack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) DeliveryPolicy() interface{} {
var returns interface{}
_jsii_.Get(
j,
"deliveryPolicy",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) Endpoint() *string {
var returns *string
_jsii_.Get(
j,
"endpoint",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) FilterPolicy() interface{} {
var returns interface{}
_jsii_.Get(
j,
"filterPolicy",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) LogicalId() *string {
var returns *string
_jsii_.Get(
j,
"logicalId",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) Node() constructs.Node {
var returns constructs.Node
_jsii_.Get(
j,
"node",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) Protocol() *string {
var returns *string
_jsii_.Get(
j,
"protocol",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) RawMessageDelivery() interface{} {
var returns interface{}
_jsii_.Get(
j,
"rawMessageDelivery",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) RedrivePolicy() interface{} {
var returns interface{}
_jsii_.Get(
j,
"redrivePolicy",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) Ref() *string {
var returns *string
_jsii_.Get(
j,
"ref",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) Region() *string {
var returns *string
_jsii_.Get(
j,
"region",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) Stack() awscdk.Stack {
var returns awscdk.Stack
_jsii_.Get(
j,
"stack",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) SubscriptionRoleArn() *string {
var returns *string
_jsii_.Get(
j,
"subscriptionRoleArn",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) TopicArn() *string {
var returns *string
_jsii_.Get(
j,
"topicArn",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) UpdatedProperites() *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Get(
j,
"updatedProperites",
&returns,
)
return returns
}
func (j *jsiiProxy_CfnSubscription) UpdatedProperties() *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Get(
j,
"updatedProperties",
&returns,
)
return returns
}
// Create a new `AWS::SNS::Subscription`.
func NewCfnSubscription(scope constructs.Construct, id *string, props *CfnSubscriptionProps) CfnSubscription {
_init_.Initialize()
j := jsiiProxy_CfnSubscription{}
_jsii_.Create(
"aws-cdk-lib.aws_sns.CfnSubscription",
[]interface{}{scope, id, props},
&j,
)
return &j
}
// Create a new `AWS::SNS::Subscription`.
func NewCfnSubscription_Override(c CfnSubscription, scope constructs.Construct, id *string, props *CfnSubscriptionProps) {
_init_.Initialize()
_jsii_.Create(
"aws-cdk-lib.aws_sns.CfnSubscription",
[]interface{}{scope, id, props},
c,
)
}
func (j *jsiiProxy_CfnSubscription) SetDeliveryPolicy(val interface{}) {
_jsii_.Set(
j,
"deliveryPolicy",
val,
)
}
func (j *jsiiProxy_CfnSubscription) SetEndpoint(val *string) {
_jsii_.Set(
j,
"endpoint",
val,
)
}
func (j *jsiiProxy_CfnSubscription) SetFilterPolicy(val interface{}) {
_jsii_.Set(
j,
"filterPolicy",
val,
)
}
func (j *jsiiProxy_CfnSubscription) SetProtocol(val *string) {
_jsii_.Set(
j,
"protocol",
val,
)
}
func (j *jsiiProxy_CfnSubscription) SetRawMessageDelivery(val interface{}) {
_jsii_.Set(
j,
"rawMessageDelivery",
val,
)
}
func (j *jsiiProxy_CfnSubscription) SetRedrivePolicy(val interface{}) {
_jsii_.Set(
j,
"redrivePolicy",
val,
)
}
func (j *jsiiProxy_CfnSubscription) SetRegion(val *string) {
_jsii_.Set(
j,
"region",
val,
)
}
func (j *jsiiProxy_CfnSubscription) SetSubscriptionRoleArn(val *string) {
_jsii_.Set(
j,
"subscriptionRoleArn",
val,
)
}
func (j *jsiiProxy_CfnSubscription) SetTopicArn(val *string) {
_jsii_.Set(
j,
"topicArn",
val,
)
}
// Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
//
// Uses duck-typing instead of `instanceof` to allow stack elements from different
// versions of this library to be included in the same stack.
//
// Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSubscription_IsCfnElement(x interface{}) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_sns.CfnSubscription",
"isCfnElement",
[]interface{}{x},
&returns,
)
return returns
}
// Check whether the given construct is a CfnResource.
func CfnSubscription_IsCfnResource(construct constructs.IConstruct) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_sns.CfnSubscription",
"isCfnResource",
[]interface{}{construct},
&returns,
)
return returns
}
// Checks if `x` is a construct.
//
// Use this method instead of `instanceof` to properly detect `Construct`
// instances, even when the construct library is symlinked.
//
// Explanation: in JavaScript, multiple copies of the `constructs` library on
// disk are seen as independent, completely different libraries. As a
// consequence, the class `Construct` in each copy of the `constructs` library
// is seen as a different class, and an instance of one class will not test as
// `instanceof` the other class. `npm install` will not create installations
// like this, but users may manually symlink construct libraries together or
// use a monorepo tool: in those cases, multiple copies of the `constructs`
// library can be accidentally installed, and `instanceof` will behave
// unpredictably. It is safest to avoid using `instanceof`, and using
// this type-testing method instead.
//
// Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSubscription_IsConstruct(x interface{}) *bool {
_init_.Initialize()
var returns *bool
_jsii_.StaticInvoke(
"aws-cdk-lib.aws_sns.CfnSubscription",
"isConstruct",
[]interface{}{x},
&returns,
)
return returns
}
func CfnSubscription_CFN_RESOURCE_TYPE_NAME() *string {
_init_.Initialize()
var returns *string
_jsii_.StaticGet(
"aws-cdk-lib.aws_sns.CfnSubscription",
"CFN_RESOURCE_TYPE_NAME",
&returns,
)
return returns
}
func (c *jsiiProxy_CfnSubscription) AddDeletionOverride(path *string) {
_jsii_.InvokeVoid(
c,
"addDeletionOverride",
[]interface{}{path},
)
}
func (c *jsiiProxy_CfnSubscription) AddDependsOn(target awscdk.CfnResource) {
_jsii_.InvokeVoid(
c,
"addDependsOn",
[]interface{}{target},
)
}
func (c *jsiiProxy_CfnSubscription) AddMetadata(key *string, value interface{}) {
_jsii_.InvokeVoid(
c,
"addMetadata",
[]interface{}{key, value},
)
}
func (c *jsiiProxy_CfnSubscription) AddOverride(path *string, value interface{}) {
_jsii_.InvokeVoid(
c,
"addOverride",
[]interface{}{path, value},
)
}
func (c *jsiiProxy_CfnSubscription) AddPropertyDeletionOverride(propertyPath *string) {
_jsii_.InvokeVoid(
c,
"addPropertyDeletionOverride",
[]interface{}{propertyPath},
)
}
func (c *jsiiProxy_CfnSubscription) AddPropertyOverride(propertyPath *string, value interface{}) {
_jsii_.InvokeVoid(
c,
"addPropertyOverride",
[]interface{}{propertyPath, value},
)
}
func (c *jsiiProxy_CfnSubscription) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) {
_jsii_.InvokeVoid(
c,
"applyRemovalPolicy",
[]interface{}{policy, options},
)
}
func (c *jsiiProxy_CfnSubscription) GetAtt(attributeName *string) awscdk.Reference {
var returns awscdk.Reference
_jsii_.Invoke(
c,
"getAtt",
[]interface{}{attributeName},
&returns,
)
return returns
}
func (c *jsiiProxy_CfnSubscription) GetMetadata(key *string) interface{} {
var returns interface{}
_jsii_.Invoke(
c,
"getMetadata",
[]interface{}{key},
&returns,
)
return returns
}
func (c *jsiiProxy_CfnSubscription) Inspect(inspector awscdk.TreeInspector) {
_jsii_.InvokeVoid(
c,
"inspect",
[]interface{}{inspector},
)
}
func (c *jsiiProxy_CfnSubscription) OverrideLogicalId(newLogicalId *string) {
_jsii_.InvokeVoid(
c,
"overrideLogicalId",
[]interface{}{newLogicalId},
)
}
func (c *jsiiProxy_CfnSubscription) RenderProperties(props *map[string]interface{}) *map[string]interface{} {
var returns *map[string]interface{}
_jsii_.Invoke(
c,
"renderProperties",
[]interface{}{props},
&returns,
)
return returns
}
func (c *jsiiProxy_CfnSubscription) ShouldSynthesize() *bool {
var returns *bool
_jsii_.Invoke(
c,
"shouldSynthesize",
nil, // no parameters
&returns,
)
return returns
}
func (c *jsiiProxy_CfnSubscription) ToString() *string {
var returns *string
_jsii_.Invoke(
c,
"toString",
nil, // no parameters
&returns,
)
return returns
}
func (c *jsiiProxy_CfnSubscription) ValidateProperties(_properties interface{}) {
_jsii_.InvokeVoid(
c,
"validateProperties",
[]interface{}{_properties},
)
}
// Properties for defining a `CfnSubscription`.
//
// 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 deliveryPolicy interface{}
// var filterPolicy interface{}
// var redrivePolicy interface{}
//
// cfnSubscriptionProps := &cfnSubscriptionProps{
// protocol: jsii.String("protocol"),
// topicArn: jsii.String("topicArn"),
//
// // the properties below are optional
// deliveryPolicy: deliveryPolicy,
// endpoint: jsii.String("endpoint"),
// filterPolicy: filterPolicy,
// rawMessageDelivery: jsii.Boolean(false),
// redrivePolicy: redrivePolicy,
// region: jsii.String("region"),
// subscriptionRoleArn: jsii.String("subscriptionRoleArn"),
// }
//
type CfnSubscriptionProps struct {
// The subscription's protocol.
//
// For more information, see the `Protocol` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
Protocol *string `field:"required" json:"protocol" yaml:"protocol"`
// The ARN of the topic to subscribe to.
TopicArn *string `field:"required" json:"topicArn" yaml:"topicArn"`
// The delivery policy JSON assigned to the subscription.
//
// Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* and [Message delivery retries](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) in the *Amazon SNS Developer Guide* .
DeliveryPolicy interface{} `field:"optional" json:"deliveryPolicy" yaml:"deliveryPolicy"`
// The subscription's endpoint.
//
// The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `[Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)` action in the *Amazon SNS API Reference* .
Endpoint *string `field:"optional" json:"endpoint" yaml:"endpoint"`
// The filter policy JSON assigned to the subscription.
//
// Enables the subscriber to filter out unwanted messages. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* and [Message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon SNS Developer Guide* .
FilterPolicy interface{} `field:"optional" json:"filterPolicy" yaml:"filterPolicy"`
// When set to `true` , enables raw message delivery.
//
// Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see `[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)` in the *Amazon SNS API Reference* .
RawMessageDelivery interface{} `field:"optional" json:"rawMessageDelivery" yaml:"rawMessageDelivery"`
// When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
//
// Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
//
// For more information about the redrive policy and dead-letter queues, see [Amazon SQS dead-letter queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the *Amazon SQS Developer Guide* .
RedrivePolicy interface{} `field:"optional" json:"redrivePolicy" yaml:"redrivePolicy"`
// For cross-region subscriptions, the region in which the topic resides.
//
// If no region is specified, AWS CloudFormation uses the region of the caller as the default.
//
// If you perform an update operation that only updates the `Region` property of a `AWS::SNS::Subscription` resource, that operation will fail unless you are either:
//
// - Updating the `Region` from `NULL` to the caller region.
// - Updating the `Region` from the caller region to `NULL` .
Region *string `field:"optional" json:"region" yaml:"region"`
// This property applies only to Amazon Kinesis Data Firehose delivery stream subscriptions.
//
// Specify the ARN of the IAM role that has the following:
//
// - Permission to write to the Amazon Kinesis Data Firehose delivery stream
// - Amazon SNS listed as a trusted entity
//
// Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see [Fanout to Amazon Kinesis Data Firehose delivery streams](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in the *Amazon SNS Developer Guide.*
SubscriptionRoleArn *string `field:"optional" json:"subscriptionRoleArn" yaml:"subscriptionRoleArn"`
}
// A CloudFormation `AWS::SNS::Topic`.
//
// The `AWS::SNS::Topic` resource creates a topic to which notifications can be published.
//
// > One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [Amazon SNS endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *AWS General Reference* .
//
// 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"
//
// cfnTopic := awscdk.Aws_sns.NewCfnTopic(this, jsii.String("MyCfnTopic"), &cfnTopicProps{
// contentBasedDeduplication: jsii.Boolean(false),
// displayName: jsii.String("displayName"),
// fifoTopic: jsii.Boolean(false),
// kmsMasterKeyId: jsii.String("kmsMasterKeyId"),
// subscription: []interface{}{
// &subscriptionProperty{
// endpoint: jsii.String("endpoint"),
// protocol: jsii.String("protocol"),
// },
// },
// tags: []cfnTag{
// &cfnTag{
// key: jsii.String("key"),
// value: jsii.String("value"),
// },
// },
// topicName: jsii.String("topicName"),
// })
//
type CfnTopic interface {
awscdk.CfnResource
awscdk.IInspectable
// Returns the name of an Amazon SNS topic.
AttrTopicName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Enables content-based deduplication for FIFO topics.
//
// - By default, `ContentBasedDeduplication` is set to `false` . If you create a FIFO topic and this attribute is `false` , you must specify a value for the `MessageDeduplicationId` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
// - When you set `ContentBasedDeduplication` to `true` , Amazon SNS uses a SHA-256 hash to generate the `MessageDeduplicationId` using the body of the message (but not the attributes of the message).
//
// (Optional) To override the generated value, you can specify a value for the the `MessageDeduplicationId` parameter for the `Publish` action.
ContentBasedDeduplication() interface{}
SetContentBasedDeduplication(val interface{})
// 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
// The display name to use for an Amazon SNS topic with SMS subscriptions.
DisplayName() *string
SetDisplayName(val *string)
// Set to true to create a FIFO topic.
FifoTopic() interface{}
SetFifoTopic(val interface{})
// The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.
//
// For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms) . For more examples, see `[KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)` in the *AWS Key Management Service API Reference* .
//
// This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html) .
KmsMasterKeyId() *string
SetKmsMasterKeyId(val *string)
// 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 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
// The Amazon SNS subscriptions (endpoints) for this topic.
Subscription() interface{}
SetSubscription(val interface{})
// The list of tags to add to a new topic.
//
// > To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.
Tags() awscdk.TagManager
// The name of the topic you want to create.
//
// Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with `.fifo` .
//
// If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
//
// > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
TopicName() *string
SetTopicName(val *string)